A specialization of WsfMessage that represents a still image to be transmitted over a communications network. More...

#include <WsfImageMessage.hpp>

Inheritance diagram for WsfImageMessage:

[legend]

Collaboration diagram for WsfImageMessage:

[legend]

Public Member Functions
	WsfImageMessage (WsfPlatform *aPlatformPtr, const WsfImage &aImage)
	~WsfImageMessage () override
WsfMessage *	Clone () const override
const char *	GetScriptClassName () const override
WsfStringId	GetComponentNameId () const override
WsfStringId	GetComponentTypeId () const override
WsfStringId	GetComponentModeId () const override
WsfImage *	GetImage () const
Public Member Functions inherited from WsfMessage
	WsfMessage (WsfStringId aType)
	Constructor for XIO (de)serialization.
	WsfMessage (WsfStringId aType, const wsf::comm::Address &aSrcAddr, WsfSimulation &aSimulation)
	WsfMessage (WsfPlatform *aPlatformPtr)
	WsfMessage (WsfStringId aType, WsfPlatform *aPlatformPtr)
	WsfMessage (WsfStringId aType, WsfStringId aSubType, WsfPlatform *aPlatformPtr)
	WsfMessage (WsfSimulation &aSimulation)
WsfMessage &	operator= (const WsfMessage &aRhs)=default
	~WsfMessage () override
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
	Get the simulation that owns the message.
void	SetSimulation (WsfSimulation *aSimulationPtr)
WsfStringId	GetOriginator () const
void	SetOriginator (WsfPlatform *aPlatformPtr)
	Set the originator of this message.
size_t	GetOriginatorIndex () const
int	GetSizeBits () const
void	SetSizeBits (int aSizeBits)
int	GetSizeBytes () const
void	SetSizeBytes (int aSizeBytes)
unsigned int	GetSerialNumber () const
void	SetSerialNumber (unsigned int aSerialNumber)
double	GetDataTag () const
void	SetDataTag (double aDataTag)
WsfStringId	GetStaticType () const
WsfStringId	GetType () const
void	SetType (WsfStringId aType)
WsfStringId	GetSubType () const
void	SetSubType (WsfStringId aSubType)
int	GetPriority () const
void	SetPriority (int aPriority)
const wsf::comm::Address &	GetSrcAddr () const
void	SetSrcAddr (const wsf::comm::Address &aSrcAddr)
const wsf::comm::Address &	GetDstAddr () const
void	SetDstAddr (const wsf::comm::Address &aDstAddr)
const wsf::comm::Address &	GetNextHopAddr () const
void	SetNextHopAddr (const wsf::comm::Address &aNextHopAddr)
virtual bool	CanBeReplacedBy (const WsfMessage &aMessage) const
WsfStringId	GetGroup () const
void	SetGroup (WsfStringId aGroup) const
void	PrintDataTagPrecise (std::ostream &aStream, std::streamsize aPrecision) const
template<typename T>
void	Serialize (T &aBuff)
	(De)serializer for XIO
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
static WsfStringId	GetTypeId ()
	Return the message type used by messages of this class.
static const char *	GetMessageType ()
Static Public Member Functions inherited from WsfMessage
static WsfStringId	GetTypeId ()

Protected Member Functions
	WsfImageMessage (const WsfImageMessage &aSrc)
WsfImageMessage &	operator= (const WsfImageMessage &)=delete
	WsfMessage (const WsfMessage &aSrc)=default

Additional Inherited Members
Static Public Attributes inherited from WsfMessage
static constexpr size_t	cBITS_IN_BYTE = 8U
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed

Detailed Description

A specialization of WsfMessage that represents a still image to be transmitted over a communications network.

Constructor & Destructor Documentation

◆ WsfImageMessage() [1/2]

WsfImageMessage::WsfImageMessage	(	WsfPlatform *	aPlatformPtr,
		const WsfImage &	aImage )

References Clone(), GetTypeId(), WsfMessage::SetDataTag(), WsfMessage::SetSizeBits(), and WsfMessage::WsfMessage().

Referenced by Clone(), operator=(), and WsfImageMessage().

◆ ~WsfImageMessage()

WsfImageMessage::~WsfImageMessage ( )

override

◆ WsfImageMessage() [2/2]

WsfImageMessage::WsfImageMessage ( const WsfImageMessage & aSrc )

protected

References Clone(), WsfImageMessage(), and WsfMessage::WsfMessage().

Member Function Documentation

◆ Clone()

WsfMessage * WsfImageMessage::Clone ( ) const

overridevirtual

Clone this object by creating an identical copy and returning a pointer to it.

Returns: A pointer to the cloned object.

Reimplemented from WsfMessage.

References WsfImageMessage(), and WsfMessage::WsfMessage().

Referenced by WsfImageMessage(), and WsfImageMessage().

◆ CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfImageMessage::CreateScriptClass	(	const std::string &	aClassName,
		UtScriptTypes *	aScriptTypesPtr )

static

Create the 'class' object for the script system. This is invoked once by WsfScriptManager to create the 'class' object that defines the interface to instances of this class from the script system.

Referenced by WsfScriptManager::RegisterTypes().

◆ GetComponentModeId()

WsfStringId WsfImageMessage::GetComponentModeId ( ) const

overridevirtual

Returns: The string ID of the mode of the sensor that generated the image contained in the message

Reimplemented from WsfMessage.

◆ GetComponentNameId()

WsfStringId WsfImageMessage::GetComponentNameId ( ) const

overridevirtual

Returns: The string ID of the name of the sensor that generated the image contained in the message

Reimplemented from WsfMessage.

◆ GetComponentTypeId()

WsfStringId WsfImageMessage::GetComponentTypeId ( ) const

overridevirtual

Returns: The string ID of the type of the sensor that generated the image contained in the message

Reimplemented from WsfMessage.

◆ GetImage()

WsfImage * WsfImageMessage::GetImage ( ) const

inline

Referenced by WsfImageProcessor::ProcessMessage().

◆ GetMessageType()

const char * WsfImageMessage::GetMessageType ( )

static

Referenced by WsfImageProcessor::ProcessMessage().

◆ GetScriptClassName()

const char * WsfImageMessage::GetScriptClassName ( ) const

override

◆ GetTypeId()

WsfStringId WsfImageMessage::GetTypeId ( )

static

Return the message type used by messages of this class.

Referenced by WsfImageProcessor::ReceiveMessage(), and WsfImageMessage().

◆ operator=()

WsfImageMessage & WsfImageMessage::operator= ( const WsfImageMessage & )

protecteddelete

References WsfImageMessage().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfImageMessage() [1/2]

◆ ~WsfImageMessage()

◆ WsfImageMessage() [2/2]

Member Function Documentation

◆ Clone()

◆ CreateScriptClass()

◆ GetComponentModeId()

◆ GetComponentNameId()

◆ GetComponentTypeId()

◆ GetImage()

◆ GetMessageType()

◆ GetScriptClassName()

◆ GetTypeId()

◆ operator=()