WSF
Public Member Functions | Static Public Member Functions | List of all members
WsfBMAssignmentMessage Class Reference

#include <WsfBMAssignmentMessage.hpp>

Inheritance diagram for WsfBMAssignmentMessage:
Inheritance graph
[legend]
Collaboration diagram for WsfBMAssignmentMessage:
Collaboration graph
[legend]

Public Member Functions

 WsfBMAssignmentMessage (WsfSimulation *simPtr)
 WsfBMAssignmentMessage (WsfPlatform *plat)
 WsfBMAssignmentMessage (WsfPlatform *plat, const std::shared_ptr< il::baseMessage > &message)
WSF_IADS_C2_LIB_EXPORT WsfBMAssignmentMessage (const WsfBMAssignmentMessage &aSrc)
virtual WSF_IADS_C2_LIB_EXPORT ~WsfBMAssignmentMessage ()
WsfBMAssignmentMessage * Clone () const override
const char * GetScriptClassName () const override
virtual const char * GetBaseClassName ()
void SetAssignmentTime (const double sim_time_s)
double GetAssignmentTime () const
void SetAssignedWeapon (const WsfPlatform *plat, const WsfWeapon *weapon)
const WsfPlatform * GetAssignedPlatform (WsfSimulation *sim_ptr) const
const WsfWeapon * GetAssignedWeapon (WsfSimulation *sim_ptr) const
void SetAssignmentReferenceTrackID (const WsfTrackId &track_id)
const WsfTrackId GetAssignmentReferenceTrackID () const
void SetAssignmentLocalTrackID (const WsfTrackId &track_id)
const WsfTrackId GetAssignmentLocalTrackID () const
void SetInitiatingPlatform (const WsfPlatform *plat)
const WsfPlatform * GetInitiatingPlatform (WsfSimulation *sim_ptr) const
void SetAssigningPlatform (const WsfPlatform *plat)
const WsfPlatform * GetAssigningPlatform (WsfSimulation *sim_ptr) const
void SetSelfDefenseFlag (const bool is_self_defense)
bool GetSelfDefenseFlag () const
void SetMaxFiringTime (const double sim_time_s)
double GetMaxFiringTime () const
void SetAssignmentReason (const il::assignmentMessage::AssignmentReason reason)
il::assignmentMessage::AssignmentReason GetAssignmentReason () const
std::string GetAssignmentReasonString () const
void SetShotDoctrine (const il::eShotDoctrine shot_doctrine)
il::eShotDoctrine GetShotDoctrine () const
std::string GetshotDoctrineString () const
void Print () const
std::shared_ptr< const il::assignmentMessage > 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

◆ WsfBMAssignmentMessage() [1/4]

WsfBMAssignmentMessage::WsfBMAssignmentMessage ( WsfSimulation * simPtr)

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

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

◆ WsfBMAssignmentMessage() [2/4]

WsfBMAssignmentMessage::WsfBMAssignmentMessage ( WsfPlatform * plat)

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

◆ WsfBMAssignmentMessage() [3/4]

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

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

◆ WsfBMAssignmentMessage() [4/4]

WsfBMAssignmentMessage::WsfBMAssignmentMessage ( const WsfBMAssignmentMessage & aSrc)

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

◆ ~WsfBMAssignmentMessage()

WsfBMAssignmentMessage::~WsfBMAssignmentMessage ( )
virtual

Member Function Documentation

◆ Clone()

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

◆ GetAssignedPlatform()

const WsfPlatform * WsfBMAssignmentMessage::GetAssignedPlatform ( WsfSimulation * sim_ptr) const

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

Referenced by WsfDefaultAssetManagerImpl::on_message().

◆ GetAssignedWeapon()

const WsfWeapon * WsfBMAssignmentMessage::GetAssignedWeapon ( WsfSimulation * sim_ptr) const

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

◆ GetAssigningPlatform()

const WsfPlatform * WsfBMAssignmentMessage::GetAssigningPlatform ( WsfSimulation * sim_ptr) const

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

Referenced by WsfBMUtils::IsAssignedBy().

◆ GetAssignmentLocalTrackID()

const WsfTrackId WsfBMAssignmentMessage::GetAssignmentLocalTrackID ( ) const

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

◆ GetAssignmentReason()

il::assignmentMessage::AssignmentReason WsfBMAssignmentMessage::GetAssignmentReason ( ) const

References GetRawMessagePtr().

◆ GetAssignmentReasonString()

std::string WsfBMAssignmentMessage::GetAssignmentReasonString ( ) const

References GetRawMessagePtr().

◆ GetAssignmentReferenceTrackID()

const WsfTrackId WsfBMAssignmentMessage::GetAssignmentReferenceTrackID ( ) const

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

◆ GetAssignmentTime()

double WsfBMAssignmentMessage::GetAssignmentTime ( ) const

References GetRawMessagePtr().

◆ GetBaseClassName()

const char * WsfBMAssignmentMessage::GetBaseClassName ( )
virtual

References WsfScriptBMAssignmentMessageClass::BASE_CLASS_NAME.

◆ GetInitiatingPlatform()

const WsfPlatform * WsfBMAssignmentMessage::GetInitiatingPlatform ( WsfSimulation * sim_ptr) const

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

◆ GetMaxFiringTime()

double WsfBMAssignmentMessage::GetMaxFiringTime ( ) const

References GetRawMessagePtr().

◆ GetRawMessagePtr()

std::shared_ptr< const il::assignmentMessage > WsfBMAssignmentMessage::GetRawMessagePtr ( ) const
inline

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

Referenced by GetAssignedPlatform(), GetAssignedWeapon(), GetAssigningPlatform(), GetAssignmentLocalTrackID(), GetAssignmentReason(), GetAssignmentReasonString(), GetAssignmentReferenceTrackID(), GetAssignmentTime(), GetInitiatingPlatform(), GetMaxFiringTime(), GetSelfDefenseFlag(), GetShotDoctrine(), GetshotDoctrineString(), Print(), UT_DEFINE_SCRIPT_METHOD(), and WsfBMAssignmentMessage().

◆ GetScriptClassName()

const char * WsfBMAssignmentMessage::GetScriptClassName ( ) const
overridevirtual

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

References WsfScriptBMAssignmentMessageClass::SCRIPT_CLASS_NAME.

◆ GetSelfDefenseFlag()

bool WsfBMAssignmentMessage::GetSelfDefenseFlag ( ) const

References GetRawMessagePtr().

◆ GetShotDoctrine()

il::eShotDoctrine WsfBMAssignmentMessage::GetShotDoctrine ( ) const

References GetRawMessagePtr().

◆ GetshotDoctrineString()

std::string WsfBMAssignmentMessage::GetshotDoctrineString ( ) const

References GetRawMessagePtr().

◆ GetTypeId()

WsfStringId WsfBMAssignmentMessage::GetTypeId ( )
static

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

◆ Print()

void WsfBMAssignmentMessage::Print ( ) const

References GetRawMessagePtr().

◆ SetAssignedWeapon()

void WsfBMAssignmentMessage::SetAssignedWeapon ( const WsfPlatform * plat,
const WsfWeapon * weapon )

References WsfBMUtils::GetAssignedIDRecord().

◆ SetAssigningPlatform()

void WsfBMAssignmentMessage::SetAssigningPlatform ( const WsfPlatform * plat)

References WsfBMUtils::GetUnitIDRecordFromPlatform().

◆ SetAssignmentLocalTrackID()

void WsfBMAssignmentMessage::SetAssignmentLocalTrackID ( const WsfTrackId & track_id)

References WsfBMUtils::ConvertTrackId().

◆ SetAssignmentReason()

void WsfBMAssignmentMessage::SetAssignmentReason ( const il::assignmentMessage::AssignmentReason reason)

◆ SetAssignmentReferenceTrackID()

void WsfBMAssignmentMessage::SetAssignmentReferenceTrackID ( const WsfTrackId & track_id)

References WsfBMUtils::ConvertTrackId().

◆ SetAssignmentTime()

void WsfBMAssignmentMessage::SetAssignmentTime ( const double sim_time_s)

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ SetInitiatingPlatform()

void WsfBMAssignmentMessage::SetInitiatingPlatform ( const WsfPlatform * plat)

References WsfBMUtils::GetUnitIDRecordFromPlatform().

◆ SetMaxFiringTime()

void WsfBMAssignmentMessage::SetMaxFiringTime ( const double sim_time_s)

◆ SetSelfDefenseFlag()

void WsfBMAssignmentMessage::SetSelfDefenseFlag ( const bool is_self_defense)

◆ SetShotDoctrine()

void WsfBMAssignmentMessage::SetShotDoctrine ( const il::eShotDoctrine shot_doctrine)
The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved