wsf::UCI_MessageBaseType Class Reference

#include <WsfUCI_MessageBaseType.hpp>

Inheritance diagram for wsf::UCI_MessageBaseType:

Collaboration diagram for wsf::UCI_MessageBaseType:

Public Member Functions
	UCI_MessageBaseType (WsfSimulation &aSimulation, UCI_Interface &aInterface)
	UCI_MessageBaseType (const UCI_MessageBaseType &aSrc)=default
	~UCI_MessageBaseType () override=default
virtual const uci::type::HeaderType *	GetHeader () const =0
	Return this message as a uci::type::MessageType (common base class).
UCI_Interface &	GetInterface () const
	Get the underlying UCI type.
virtual void	Send (const uci::type::DateTimeTypeValue &aSimTime) const =0
	Send this message using the writer.
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
virtual WsfMessage *	Clone () const
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
virtual WsfStringId	GetComponentNameId () const
virtual WsfStringId	GetComponentTypeId () const
virtual WsfStringId	GetComponentModeId () const
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

Additional Inherited Members
Static Public Member Functions inherited from WsfMessage
static WsfStringId	GetTypeId ()
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
	WsfMessage (const WsfMessage &aSrc)=default

Constructor & Destructor Documentation

UCI_MessageBaseType() [1/2]

wsf::UCI_MessageBaseType::UCI_MessageBaseType ( WsfSimulation & aSimulation, UCI_Interface & aInterface )

inline

References WsfMessage::WsfMessage().

Referenced by UCI_MessageBaseType(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), and wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType().

UCI_MessageBaseType() [2/2]

wsf::UCI_MessageBaseType::UCI_MessageBaseType ( const UCI_MessageBaseType & aSrc )

default

References UCI_MessageBaseType().

~UCI_MessageBaseType()

wsf::UCI_MessageBaseType::~UCI_MessageBaseType ( )

overridedefault

Member Function Documentation

GetHeader()

virtual const uci::type::HeaderType * wsf::UCI_MessageBaseType::GetHeader ( ) const

pure virtual

Return this message as a uci::type::MessageType (common base class).

Implemented in wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >.

GetInterface()

UCI_Interface & wsf::UCI_MessageBaseType::GetInterface ( ) const

inline

Get the underlying UCI type.

Referenced by wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::Send(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), and wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType().

Send()

virtual void wsf::UCI_MessageBaseType::Send ( const uci::type::DateTimeTypeValue & aSimTime ) const

pure virtual

Send this message using the writer.

Implemented in wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >.

---

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

• WsfUCI_MessageBaseType.hpp