Class parameterizing UCI message types. More...

#include <WsfUCI_Messages.hpp>

Inheritance diagram for wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >:

[legend]

Collaboration diagram for wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >:

[legend]

Public Member Functions
	UCI_MessageType (WsfPlatform *aPlatformPtr)
	UCI_MessageType (UCI_Interface &aInterface)
	UCI_MessageType (UCI_Interface &aInterface, const Type &aType)
	UCI_MessageType (const UCI_MessageType &aSrc)
	~UCI_MessageType () override
WsfMessage *	Clone () const override
Type &	Get () const
	Get the underlying UCI type.
const uci::type::HeaderType *	GetHeader () const override
void	Send (const uci::type::DateTimeTypeValue &aSimTime) const override
	Send this message using the writer. This method calls PopulateHeader before sending.
Public Member Functions inherited from wsf::UCI_MessageBaseType
	UCI_MessageBaseType (WsfSimulation &aSimulation, UCI_Interface &aInterface)
	UCI_MessageBaseType (const UCI_MessageBaseType &aSrc)=default
	~UCI_MessageBaseType () override=default
UCI_Interface &	GetInterface () const
	Get the underlying UCI type.
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
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

Static Public Member Functions
static uci::base::accessorType::AccessorType	GetUCI_TypeId ()
Static Public Member Functions inherited from WsfMessage
static WsfStringId	GetTypeId ()

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
	WsfMessage (const WsfMessage &aSrc)=default

Detailed Description

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>
class wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >

Class parameterizing UCI message types.

Constructor & Destructor Documentation

◆ UCI_MessageType() [1/4]

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, typename uci::base::accessorType::AccessorType TypeName>

wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType ( WsfPlatform * aPlatformPtr )

inlineexplicit

References wsf::UCI_MessageBaseType::GetInterface(), wsf::UCI_Interface::GetMessageService(), WsfMessage::GetSimulation(), wsf::UCI_Interface::GetTypeFactory(), and wsf::UCI_MessageBaseType::UCI_MessageBaseType().

Referenced by Clone(), and UCI_MessageType().

◆ UCI_MessageType() [2/4]

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>

wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType ( UCI_Interface & aInterface )

inlineexplicit

References wsf::UCI_MessageBaseType::GetInterface(), wsf::UCI_Interface::GetMessageService(), WsfMessage::GetSimulation(), wsf::UCI_Interface::GetTypeFactory(), and wsf::UCI_MessageBaseType::UCI_MessageBaseType().

◆ UCI_MessageType() [3/4]

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>

wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType	(	wsf::UCI_Interface &	aInterface,
		const Type &	aType )

inline

References wsf::UCI_MessageBaseType::GetInterface(), wsf::UCI_Interface::GetMessageService(), WsfMessage::GetSimulation(), wsf::UCI_Interface::GetTypeFactory(), and wsf::UCI_MessageBaseType::UCI_MessageBaseType().

◆ UCI_MessageType() [4/4]

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, typename uci::base::accessorType::AccessorType TypeName>

wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType ( const UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName > & aSrc )

inline

References wsf::UCI_MessageBaseType::UCI_MessageBaseType(), and UCI_MessageType().

◆ ~UCI_MessageType()

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, typename uci::base::accessorType::AccessorType TypeName>

wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::~UCI_MessageType ( )

inlineoverride

Member Function Documentation

◆ Clone()

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>

WsfMessage * wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::Clone ( ) const

inlineoverridevirtual

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 UCI_MessageType(), and WsfMessage::WsfMessage().

◆ Get()

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>

Type & wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::Get ( ) const

inline

Get the underlying UCI type.

Referenced by Send().

◆ GetHeader()

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>

const uci::type::HeaderType * wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::GetHeader ( ) const

inlineoverridevirtual

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

Note: The "this->" in the following line was added to work around a gcc/linux compiler issue.

Implements wsf::UCI_MessageBaseType.

◆ GetUCI_TypeId()

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, uci::base::accessorType::AccessorType TypeName>

uci::base::accessorType::AccessorType wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::GetUCI_TypeId ( )

inlinestatic

◆ Send()

template<typename Type, typename Factory, typename Reader, typename Writer, typename Listener, typename uci::base::accessorType::AccessorType TypeName>

void wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::Send ( const uci::type::DateTimeTypeValue & aSimTime ) const

inlineoverridevirtual

Send this message using the writer. This method calls PopulateHeader before sending.

Implements wsf::UCI_MessageBaseType.

References Get(), and wsf::UCI_MessageBaseType::GetInterface().

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

WsfUCI_Messages.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UCI_MessageType() [1/4]

◆ UCI_MessageType() [2/4]

◆ UCI_MessageType() [3/4]

◆ UCI_MessageType() [4/4]

◆ ~UCI_MessageType()

Member Function Documentation

◆ Clone()

◆ Get()

◆ GetHeader()

◆ GetUCI_TypeId()

◆ Send()