WsfBMCueMessage Class Reference

#include <WsfBMCueMessage.hpp>

Inheritance diagram for WsfBMCueMessage:

Collaboration diagram for WsfBMCueMessage:

Public Member Functions
	WsfBMCueMessage (WsfSimulation *simPtr)
	WsfBMCueMessage (WsfPlatform *plat)
	WsfBMCueMessage (WsfPlatform *plat, const std::shared_ptr< il::baseMessage > &message)
WSF_IADS_C2_LIB_EXPORT	WsfBMCueMessage (const WsfBMCueMessage &aSrc)
virtual WSF_IADS_C2_LIB_EXPORT	~WsfBMCueMessage ()
WsfBMCueMessage *	Clone () const override
const char *	GetScriptClassName () const override
virtual const char *	GetBaseClassName ()
void	SetCueTime (const double sim_time_s)
double	GetCueTime () const
void	SetReferenceTrackID (const WsfTrackId &track_id)
const WsfTrackId	GetReferenceTrackID () const
void	SetLocalTrackID (const WsfTrackId &track_id)
const WsfTrackId	GetLocalTrackID () const
void	SetInitiatingPlatform (const WsfPlatform *plat)
const WsfPlatform *	GetInitiatingPlatform (WsfSimulation *sim_ptr) const
void	SetCuedSensor (const WsfPlatform *plat, const WsfSensor *sensor)
const WsfPlatform *	GetCuedPlatform (WsfSimulation *sim_ptr) const
const WsfSensor *	GetCuedSensor (WsfSimulation *sim_ptr) const
void	SetCueReason (const il::cueMessage::CueReason reason)
il::cueMessage::CueReason	GetCueReason () const
std::string	GetCueReasonString () const
void	Print () const
std::shared_ptr< const il::cueMessage >	GetRawMessagePtr () 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
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
Public Member Functions inherited from WsfBMManagedTypeWrapper< il::baseMessage >
	WsfBMManagedTypeWrapper (const std::string &script_class_name)
virtual void	SetTable (std::shared_ptr< il::baseMessage > &data_to_wrap)
Public Member Functions inherited from WsfBMTypeWrapper< il::baseMessage, std::shared_ptr< il::baseMessage > >
	WsfBMTypeWrapper (const std::string &script_class_name)
virtual tType	GetRawPtr () const
virtual bool	IsValidRef () const
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
virtual bool	ProcessInput (UtInput &aInput)
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Static Public Member Functions
static WsfStringId	GetTypeId ()
Static Public Member Functions inherited from WsfMessage
static WsfStringId	GetTypeId ()

Additional Inherited Members
Public Types inherited from WsfBMTypeWrapper< il::baseMessage, std::shared_ptr< il::baseMessage > >
typedef std::shared_ptr< il::baseMessage >	tType
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
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
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from WsfBMTypeWrapper< il::baseMessage, std::shared_ptr< il::baseMessage > >
std::string	m_script_class_name
std::shared_ptr< il::baseMessage >	m_wrapped_ptr

Constructor & Destructor Documentation

WsfBMCueMessage() [1/4]

WsfBMCueMessage::WsfBMCueMessage

(

WsfSimulation *

simPtr

)

References GetTypeId(), WsfBMCueMessage(), WsfBMManagedTypeWrapper< il::baseMessage >::WsfBMManagedTypeWrapper(), and WsfMessage::WsfMessage().

Referenced by Clone(), WsfBMCueMessage(), WsfBMCueMessage(), WsfBMCueMessage(), and WsfBMCueMessage().

WsfBMCueMessage() [2/4]

WsfBMCueMessage::WsfBMCueMessage

(

WsfPlatform *

plat

)

References GetTypeId(), WsfBMCueMessage(), WsfBMManagedTypeWrapper< il::baseMessage >::WsfBMManagedTypeWrapper(), and WsfMessage::WsfMessage().

WsfBMCueMessage() [3/4]

WsfBMCueMessage::WsfBMCueMessage	(	WsfPlatform *	plat,
		const std::shared_ptr< il::baseMessage > &	message )

References GetTypeId(), WsfBMCueMessage(), WsfBMManagedTypeWrapper< il::baseMessage >::WsfBMManagedTypeWrapper(), and WsfMessage::WsfMessage().

WsfBMCueMessage() [4/4]

WsfBMCueMessage::WsfBMCueMessage

(

const WsfBMCueMessage &

aSrc

)

References GetRawMessagePtr(), GetTypeId(), WsfBMCueMessage(), WsfBMManagedTypeWrapper< il::baseMessage >::WsfBMManagedTypeWrapper(), and WsfMessage::WsfMessage().

~WsfBMCueMessage()

WsfBMCueMessage::~WsfBMCueMessage ( )

virtual

Member Function Documentation

Clone()

WsfBMCueMessage * WsfBMCueMessage::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 WsfBMCueMessage().

GetBaseClassName()

const char * WsfBMCueMessage::GetBaseClassName ( )

virtual

References WsfScriptBMCueMessageClass::BASE_CLASS_NAME.

GetCuedPlatform()

const WsfPlatform * WsfBMCueMessage::GetCuedPlatform

(

WsfSimulation *

sim_ptr

)

const

References WsfBMUtils::GetPlatformFromUnitIDRecord(), and GetRawMessagePtr().

Referenced by GetCuedSensor().

GetCuedSensor()

const WsfSensor * WsfBMCueMessage::GetCuedSensor

(

WsfSimulation *

sim_ptr

)

const

References GetCuedPlatform(), GetRawMessagePtr(), and WsfBMUtils::GetSensor().

GetCueReason()

il::cueMessage::CueReason WsfBMCueMessage::GetCueReason

(

)

const

References GetRawMessagePtr().

Referenced by GetCueReasonString().

GetCueReasonString()

std::string WsfBMCueMessage::GetCueReasonString

(

)

const

References GetCueReason().

GetCueTime()

double WsfBMCueMessage::GetCueTime

(

)

const

References GetRawMessagePtr().

GetInitiatingPlatform()

const WsfPlatform * WsfBMCueMessage::GetInitiatingPlatform

(

WsfSimulation *

sim_ptr

)

const

References WsfBMUtils::GetPlatformFromUnitIDRecord(), and GetRawMessagePtr().

GetLocalTrackID()

const WsfTrackId WsfBMCueMessage::GetLocalTrackID

(

)

const

References WsfBMUtils::ConvertTrackId(), and GetRawMessagePtr().

GetRawMessagePtr()

std::shared_ptr< const il::cueMessage > WsfBMCueMessage::GetRawMessagePtr ( ) const

inline

References WsfBMTypeWrapper< il::baseMessage, std::shared_ptr< il::baseMessage > >::m_wrapped_ptr.

Referenced by GetCuedPlatform(), GetCuedSensor(), GetCueReason(), GetCueTime(), GetInitiatingPlatform(), GetLocalTrackID(), GetReferenceTrackID(), Print(), and WsfBMCueMessage().

GetReferenceTrackID()

const WsfTrackId WsfBMCueMessage::GetReferenceTrackID

(

)

const

References WsfBMUtils::ConvertTrackId(), and GetRawMessagePtr().

GetScriptClassName()

const char * WsfBMCueMessage::GetScriptClassName ( ) const

overridevirtual

Reimplemented from WsfBMTypeWrapper< il::baseMessage, std::shared_ptr< il::baseMessage > >.

References WsfScriptBMCueMessageClass::SCRIPT_CLASS_NAME.

GetTypeId()

WsfStringId WsfBMCueMessage::GetTypeId ( )

static

Referenced by WsfDefaultAssetManagerImpl::on_message(), WsfBMCueMessage(), WsfBMCueMessage(), WsfBMCueMessage(), and WsfBMCueMessage().

Print()

void WsfBMCueMessage::Print

(

)

const

References GetRawMessagePtr().

SetCuedSensor()

void WsfBMCueMessage::SetCuedSensor	(	const WsfPlatform *	plat,
		const WsfSensor *	sensor )

References WsfBMUtils::GetSensorID(), and WsfBMUtils::GetUnitIDRecordFromPlatform().

SetCueReason()

void WsfBMCueMessage::SetCueReason

(

const il::cueMessage::CueReason

reason

)

SetCueTime()

void WsfBMCueMessage::SetCueTime

(

const double

sim_time_s

)

Referenced by UT_DEFINE_SCRIPT_METHOD().

SetInitiatingPlatform()

void WsfBMCueMessage::SetInitiatingPlatform

(

const WsfPlatform *

plat

)

References WsfBMUtils::GetUnitIDRecordFromPlatform().

SetLocalTrackID()

void WsfBMCueMessage::SetLocalTrackID

(

const WsfTrackId &

track_id

)

References WsfBMUtils::ConvertTrackId().

SetReferenceTrackID()

void WsfBMCueMessage::SetReferenceTrackID

(

const WsfTrackId &

track_id

)

References WsfBMUtils::ConvertTrackId().

---

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

• WsfBMCueMessage.hpp
• WsfBMCueMessage.cpp