#include <WsfAuxDataEnabled.hpp>
Public Member Functions | |
| 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 | |
Static Public Attributes | |
| static UtCallbackListN< void(const WsfAuxDataEnabled *)> | AuxDataAccessed |
| static UtCallbackListN< void(const WsfAuxDataEnabled *)> | AuxDataDestroyed |
Auxiliary attribute management. | |
| WsfAttributeContainer & | GetAuxData () |
| const WsfAttributeContainer & | GetAuxData () const noexcept |
| const WsfAttributeContainer & | GetAuxDataConst () const noexcept |
Detailed Description
A common base class for 'aux data'-enabled objects throughout the framework, including platforms, platform parts, routes, waypoints, tasks, tracks, and zones. This auxiliary data is not used directly by the core framework, but provides users (through corresponding script interface methods) and model developers a way to attach generic properties to an object. This class provides common input processing, attribute management, and XIO (de)-serialization functionality.
Constructor & Destructor Documentation
◆ WsfAuxDataEnabled() [1/3]
|
default |
Referenced by MergeAuxData(), wsf::comm::Message::Message(), operator=(), operator=(), UpdateAuxData(), WsfAuxDataEnabled(), WsfAuxDataEnabled(), WsfEM_XmtrRcvr::WsfEM_XmtrRcvr(), WsfPlatform::WsfPlatform(), WsfPlatformPart::WsfPlatformPart(), WsfRoute::WsfRoute(), WsfTaskData::WsfTaskData(), WsfTrack::WsfTrack(), and WsfZone::WsfZone().
◆ WsfAuxDataEnabled() [2/3]
|
default |
References WsfAuxDataEnabled().
◆ WsfAuxDataEnabled() [3/3]
|
default |
References WsfAuxDataEnabled().
◆ ~WsfAuxDataEnabled()
|
virtualnoexcept |
References AuxDataDestroyed.
Member Function Documentation
◆ DeleteAuxData()
| void WsfAuxDataEnabled::DeleteAuxData | ( | ) |
Delete the aux data container from the object.
References AuxDataAccessed.
Referenced by operator=().
◆ GetAuxData() [1/2]
| WsfAttributeContainer & WsfAuxDataEnabled::GetAuxData | ( | ) |
Returns the aux data container. The non-const versions will emit AuxDataAccessed().
- Returns
- A reference to a WsfAttributeContainer object.
- See also
- WsfAttributeContainer
References AuxDataAccessed.
Referenced by WsfBMUtils::AuxDataExists(), WsfBMUtils::AuxDataExists(), WsfBMUtils::AuxDataExists(), WsfBMUtils::AuxDataExists(), WsfBMUtils::ConvertTrack(), MTT_ActiveTrack::CopyAuxDataTo(), WsfLaunchComputer::CopyResultsToTrack(), WsfMTT_Correlation::CorrelateImpl(), WsfCuedLaserWeapon::Fire(), wsf::comm::router::ProtocolMulticast::ForwardMessage(), WsfExtEmission::GetSensor(), WsfOrbitalManeuver::GetTargetPropagatorPerception(), WsfMilExtInterface::GetWeapon(), WsfL16::SurveillancePart::HandleSend(), WsfL16::SurveillancePart::HaveReportingResponsibility(), WsfIntersectProcessor::Initialize(), WsfRIPRProcessor::Initialize(), WsfDisWeaponEvents::InitiateWeaponTransfer(), operator=(), WsfWeaponServer::ProcessCommand(), ProcessInput(), wsf::comm::router::ProtocolMulticast::Send(), WsfJTIDS_Terminal::SendSetup(), WsfL16::SurveillancePart::SendSpaceTrack(), WsfL16::ComputerProcessor::SetTrackNumber(), UpdateAuxData(), WsfTrackManager::UpdateAuxData(), WsfMTT_Fusion::UpdateLocalTrackFromNonLocalTrack(), WsfImageProcessor::UpdateTrack(), WsfOTH_RadarSensor::OTH_Mode::UpdateTrack(), WsfTRIMSIM_SensorComponent::UpdateTrack(), WsfSA_Processor::UpdateTrackData(), and WsfSA_EntityPerception::WsfSA_EntityPerception().
◆ GetAuxData() [2/2]
|
noexcept |
◆ GetAuxDataConst()
|
noexcept |
Referenced by wsf::cyber::AttackParameters::AddParameter(), WsfBeamDirector::WsfBeamDirectorMode::AttemptToDetect(), WsfRIPRProcessor::CommanderPlatform(), WsfRIPRProcessor::CommanderProcessor(), MTT_PerceivedCluster::CopyFrom(), WsfMTT_Correlation::CorrelateImpl(), WsfLaserWeapon::Fire(), WsfLaunchComputer::GetDataValue(), wsf::cyber::AttackParameterObject::GetParameter(), WsfOrbitalManeuver::GetTargetPropagatorPerception(), WsfMilExtInterface::GetWeapon(), WsfL16::SurveillancePart::HaveReportingResponsibility(), WsfXIO_ObjectInfoLoad::Load_Platform(), MergeAuxData(), operator=(), WsfL16::SurveillancePart::OwningPlatformWantsTrackRefNumber(), wsf::event::utils::PrintTrackData(), wsf::event::utilsCSV::PrintTrackData(), WsfRIPRProcessor::ProcessMessage(), WsfRIPRProcessor::ReceiveMessage(), wsf::comm::SlotGroupLayerJTIDS::Send(), WsfL16::SurveillancePart::SendAirTrack(), WsfL16::SurveillancePart::SendLandTrack(), WsfL16::SurveillancePart::SendSpaceTrack(), WsfL16::SurveillancePart::SendSurfaceTrack(), WsfRIPRProcessor::SubordinatePlatforms(), WsfRIPRProcessor::SubordinateProcessors(), WsfRIPRProcessor::SubsTargeting(), WsfRIPRProcessor::SubsWeaponsActive(), WsfTrackManager::UpdateAuxData(), WsfHighEnergyLaser::UpdateEngagementGeometry(), WsfTrack::UpdateFromMeasurement(), WsfMTT_Fusion::UpdateLocalTrackFromNonLocalTrack(), WsfImageProcessor::UpdateTrack(), and WsfDisWeaponEvents::WeaponTerminated().
◆ HasAuxData()
| bool WsfAuxDataEnabled::HasAuxData | ( | ) | const |
Returns true if this object has aux data.
Referenced by WsfTrackManager::AddRawTrackReport(), WsfTrackManager::AddTrack(), WsfBMUtils::AuxDataExists(), WsfBMUtils::AuxDataExists(), WsfBMUtils::AuxDataExists(), WsfBMUtils::AuxDataExists(), WsfLaunchComputer::GetDataValue(), WsfXIO_ObjectInfoLoad::Load_Platform(), MergeAuxData(), operator=(), wsf::event::utils::PrintTrackData(), wsf::event::utilsCSV::PrintTrackData(), UpdateAuxData(), WsfTrackManager::UpdateAuxData(), WsfTrack::UpdateFromMeasurement(), WsfSA_Processor::UpdateTrackData(), and WsfSA_EntityPerception::WsfSA_EntityPerception().
◆ MergeAuxData()
| void WsfAuxDataEnabled::MergeAuxData | ( | const WsfAuxDataEnabled & | aSrc | ) |
Merge the object's aux data with aux data from an existing object.
References AuxDataAccessed, GetAuxDataConst(), HasAuxData(), SetAuxData(), and WsfAuxDataEnabled().
Referenced by operator=().
◆ operator=() [1/2]
| WsfAuxDataEnabled & WsfAuxDataEnabled::operator= | ( | const WsfAuxDataEnabled & | aRhs | ) |
References AuxDataAccessed, and WsfAuxDataEnabled().
Referenced by wsf::comm::Message::operator=(), WsfRoute::operator=(), WsfTaskData::operator=(), and WsfTrack::operator=().
◆ operator=() [2/2]
|
default |
◆ ProcessInput()
| bool WsfAuxDataEnabled::ProcessInput | ( | UtInput & | aInput | ) |
References GetAuxData().
Referenced by operator=(), WsfEM_XmtrRcvr::ProcessInput(), WsfGroup::ProcessInput(), WsfPlatform::ProcessInput(), WsfPlatformPart::ProcessInput(), WsfRoute::ProcessInput(), WsfSensor::ProcessInput(), WsfTrack::ProcessInput(), WsfWaypoint::ProcessInput(), WsfWeapon::ProcessInput(), and WsfZone::ProcessInput().
◆ Serialize()
|
inline |
(De)serialization for XIO
References AuxDataAccessed, and Serialize().
Referenced by Serialize(), WsfMessage::Serialize(), and WsfWaypoint::SerializeP().
◆ SetAuxData()
| void WsfAuxDataEnabled::SetAuxData | ( | const WsfAttributeContainer & | aAuxData | ) |
References AuxDataAccessed.
Referenced by MergeAuxData(), WsfScriptPlatformClass::OnNewScriptRef(), WsfScriptTaskClass::OnNewScriptRef(), operator=(), and WsfTrack::UpdateFromMeasurement().
◆ UpdateAuxData()
| void WsfAuxDataEnabled::UpdateAuxData | ( | const WsfAuxDataEnabled & | aSrc | ) |
Update the object's aux data with aux data from an existing object.
References AuxDataAccessed, GetAuxData(), HasAuxData(), and WsfAuxDataEnabled().
Referenced by operator=().
Member Data Documentation
◆ AuxDataAccessed
|
static |
Called whenever aux data is accessed via WsfAuxDataEnabled. This means that the data may-or-may-not be changed. The parameter is a pointer to the WsfAuxDataEnabled that was accessed.
- Note
- At the time the callback is called, the data has not necessarily been accessed yet.
- Not called on construction.
Referenced by wsf::xio::AuxData::AuxData(), DeleteAuxData(), GetAuxData(), MergeAuxData(), operator=(), Serialize(), SetAuxData(), and UpdateAuxData().
◆ AuxDataDestroyed
|
static |
Called whenever a WsfAuxDataEnabled is destroyed. The parameter is a pointer to the WsfAuxDataEnabled being destroyed.
- Note
- It is UNSAFE to dynamic_cast the pointer.
Referenced by wsf::xio::AuxData::AuxData(), and ~WsfAuxDataEnabled().
The documentation for this class was generated from the following files: