WsfXIO_SensorInfo Class Reference
Provides information about a sensor. More...
#include <WsfXIO_ObjectInfo.hpp>
Inheritance diagram for WsfXIO_SensorInfo:
Collaboration diagram for WsfXIO_SensorInfo:
Public Member Functions | |
| WsfXIO_SensorInfo (ObjectType aType=cPART_INFO_ID) | |
| ~WsfXIO_SensorInfo () override | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| void | UpdateFromStateChange (WsfXIO_PartStateChangePkt &aPkt) override |
| void | UpdateFromPartState (WsfXIO_PlatformPartStatePkt &aPkt) override |
| WsfXIO_SensorModeInfo * | GetCurrentMode () |
| Public Member Functions inherited from WsfXIO_ModedPartInfo | |
| WsfXIO_ModedPartInfo (ObjectType aType) | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| void | SelectMode (bool aSelect, WsfStringId aModeId) |
| bool | IsModeSelected (WsfStringId aModeName) |
| Public Member Functions inherited from WsfXIO_ArticulatedPartInfo | |
| WsfXIO_ArticulatedPartInfo (ObjectType aType=cPART_INFO_ID) | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| Public Member Functions inherited from WsfXIO_PlatformPartInfo | |
| WsfXIO_PlatformPartInfo (ObjectType aType=cPART_INFO_ID) | |
| virtual | ~WsfXIO_PlatformPartInfo () |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| void | InitStateChange (WsfXIO_PartStateChangeRequestPkt &aPkt) |
| int | GetPartType () const |
| Type of platform part. | |
| size_t | GetPlatformIndex () const |
| Index of the platform. | |
| WsfStringId | GetName () const |
| NameID of the platform part. | |
| WsfStringId | GetInstantiationType () const |
| TypeID of the platform part. | |
| WsfStringId | GetBasicType () const |
| Most basic type of the platform part. ex: 'WSF_RADAR_SENSOR' or 'WSF_TASK_PROCESSOR'. | |
| bool | IsTurnedOn () const |
| 'true' if the platform part is turned on | |
| void | TurnOn (bool aTurnOn=true) |
| Notify the platform host to turn this platform part on. | |
| void | TurnOff () |
| Notify the platform host to turn this platform part off. | |
| void | SetDebugEnabled (bool aEnabled) |
| Change debug state. | |
| bool | IsOperational () const |
| 'true' if the platform part is operational | |
| bool | IsExternallyControlled () const |
| 'true' if the platform part is externally controlled | |
| void | SetPlatformPtr (WsfXIO_PlatformInfo *aPlatformPtr) |
| Set owning platform pointer. Use with caution. | |
| WsfXIO_PlatformInfo * | GetPlatform () const |
| Get owning platform pointer. | |
| void | SetTurnedOnFlag (const bool aTurnedOn) |
| Public Member Functions inherited from WsfXIO_ObjectInfo | |
| WsfXIO_ObjectInfo (ObjectType aObjectType) | |
| bool | IsPlatform () const |
| bool | IsTrackManager () const |
| bool | IsPlatformPart () const |
| bool | IsArticulatedPart () const |
| bool | IsSensor () const |
| bool | IsComm () const |
| bool | IsProcessor () const |
| bool | IsMover () const |
| ObjectType | GetObjectType () const |
| template<typename T> | |
| void | Serialize (T &aBuff) |
Public Attributes | |
| int | mSensorClass |
| std::vector< WsfXIO_EM_XmtrInfo * > | mTransmitters |
| std::vector< WsfXIO_EM_RcvrInfo * > | mReceivers |
| std::vector< WsfXIO_SensorModeInfo > | mModes |
| Public Attributes inherited from WsfXIO_ModedPartInfo | |
| std::vector< WsfStringId > | mModeNames |
| std::vector< WsfStringId > | mSelectedModeNames |
| WsfStringId | mCurrentModeName |
| Public Attributes inherited from WsfXIO_ArticulatedPartInfo | |
| double | mYaw |
| Orientation of the articulated part. | |
| double | mPitch |
| double | mRoll |
| double | mTilt |
| Public Attributes inherited from WsfXIO_PlatformPartInfo | |
| int | mPartType |
| size_t | mPlatformIndex |
| WsfStringId | mName |
| WsfStringId | mType |
| WsfStringId | mBasicType |
| bool | mIsTurnedOn |
| bool | mIsOperational |
| bool | mIsExternallyControlled |
| bool | mDebugEnabled |
Static Public Attributes | |
| static const ObjectType | cPART_INFO_ID = cSENSOR_PART |
| Static Public Attributes inherited from WsfXIO_ArticulatedPartInfo | |
| static const ObjectType | cPART_INFO_ID = cARTICULATED_PART |
| Static Public Attributes inherited from WsfXIO_PlatformPartInfo | |
| static const ObjectType | cPART_INFO_ID = cPLATFORM_PART |
Additional Inherited Members | |
| Public Types inherited from WsfXIO_ObjectInfo | |
| enum | { cPLATFORM_PART = 0x40000000 , cARTICULATED_PART = cPLATFORM_PART | 0x20000000 , cCOMPONENT_ROLE_MASK = 0x007fffff , cPART_TYPE_MASK = 0x607fffff , cDERIVED_TYPE_MASK = 0x1f800000 , cDERIVED_TYPE_BEGIN = 0x00800000 , cNO_OBJECT = 0 , cPLATFORM = cWSF_COMPONENT_PLATFORM , cTRACK_MANAGER = cWSF_COMPONENT_TRACK_MANAGER , cMOVER_PART = cPLATFORM_PART | cWSF_COMPONENT_MOVER , cCOMM_PART = cARTICULATED_PART | cWSF_COMPONENT_COMM , cPROCESSOR_PART = cPLATFORM_PART | cWSF_COMPONENT_PROCESSOR , cSENSOR_PART = cARTICULATED_PART | cWSF_COMPONENT_SENSOR } |
| using | ObjectType = int32_t |
| Protected Attributes inherited from WsfXIO_PlatformPartInfo | |
| WsfXIO_PlatformInfo * | mPlatformPtr |
Detailed Description
Provides information about a sensor.
Constructor & Destructor Documentation
◆ WsfXIO_SensorInfo()
|
inline |
References cPART_INFO_ID, and WsfXIO_ModedPartInfo::WsfXIO_ModedPartInfo().
◆ ~WsfXIO_SensorInfo()
|
override |
References mReceivers, and mTransmitters.
Member Function Documentation
◆ GetCurrentMode()
| WsfXIO_SensorModeInfo * WsfXIO_SensorInfo::GetCurrentMode | ( | ) |
References WsfXIO_ModedPartInfo::mCurrentModeName, and mModes.
◆ Serialize()
template<typename T>
|
inline |
References mModes, mReceivers, mSensorClass, mTransmitters, and WsfXIO_ModedPartInfo::Serialize().
◆ UpdateFromPartState()
|
overridevirtual |
Reimplemented from WsfXIO_ModedPartInfo.
References WsfXIO_PlatformPartStatePkt::mReceivers, mReceivers, WsfXIO_PlatformPartStatePkt::mTransmitters, mTransmitters, std::swap(), and WsfXIO_ModedPartInfo::UpdateFromPartState().
◆ UpdateFromStateChange()
|
overridevirtual |
Reimplemented from WsfXIO_ModedPartInfo.
References WsfXIO_ModedPartInfo::UpdateFromStateChange().
Member Data Documentation
◆ cPART_INFO_ID
|
static |
Referenced by WsfXIO_SensorInfo().
◆ mModes
| std::vector<WsfXIO_SensorModeInfo> WsfXIO_SensorInfo::mModes |
Referenced by GetCurrentMode(), WsfXIO_ObjectInfoLoad::Load_Sensor(), and Serialize().
◆ mReceivers
| std::vector<WsfXIO_EM_RcvrInfo*> WsfXIO_SensorInfo::mReceivers |
Referenced by WsfXIO_ObjectInfoLoad::Load_Sensor(), Serialize(), UpdateFromPartState(), and ~WsfXIO_SensorInfo().
◆ mSensorClass
| int WsfXIO_SensorInfo::mSensorClass |
Referenced by WsfXIO_ObjectInfoLoad::Load_Sensor(), and Serialize().
◆ mTransmitters
| std::vector<WsfXIO_EM_XmtrInfo*> WsfXIO_SensorInfo::mTransmitters |
Referenced by WsfXIO_ObjectInfoLoad::Load_Sensor(), Serialize(), UpdateFromPartState(), and ~WsfXIO_SensorInfo().
The documentation for this class was generated from the following files: