WSF
WsfL16::SystemStatusPart Class Reference

#include <SystemStatusPart.hpp>

Inheritance diagram for WsfL16::SystemStatusPart:
Collaboration diagram for WsfL16::SystemStatusPart:

Classes

struct  Config

Public Member Functions

 SystemStatusPart (WsfScenario &aScenario)
 SystemStatusPart (const SystemStatusPart &aSrc)
 ~SystemStatusPart () override
ComputerPartClone () const override
bool Initialize (double aSimTime, ComputerProcessor &aComputer) override
void HandleReceive (double aSimTime, const Messages::InitialBase &aMessage) override
 Handle an incoming message.
void HandleSend (double aSimTime) override
 This method is called when the a slot is open.
bool ProcessInput (UtInput &aInput) override
Public Member Functions inherited from WsfL16::ComputerPart
 ComputerPart (WsfScenario &aScenario, const std::string &aClassName="WsfProcessor")
 ComputerPart (const ComputerPart &aSrc)
 ~ComputerPart () override
void SendJMessage (double aSimTime, Messages::InitialBase *aMessage)
virtual bool IsNetworkEnabled ()
void SetDebug (bool aDebugOn)
bool Debug ()
void SetPlatform (WsfPlatform *aPlatformPtr)
WsfCommandChainGetCommandChain () const
ComputerProcessorGetComputer ()
WsfPlatformGetPlatform ()
WsfSimulationGetSimulation ()
const SlotParametersGetSlotParameters () const
int DebugMore ()
void SetSendInterval (double aValue)
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
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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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)

Protected Types

enum  Category {
  cAIR , cSURFACE , cSUBSURFACE , cLAND ,
  cUNSET
}
Protected Types inherited from WsfL16::ComputerPart
typedef std::map< int, ScriptDataScriptMap

Protected Member Functions

bool CheckWeapon (WsfStringId aWeaponId)
int WeaponQuantity (WsfStringId aWeaponId)
void SendPPLI (double aSimTime)
void SendSystemStatus (double aSimTime)
void SendAirSystemStatus (double aSimTime)
void SendLandPointSystemStatus (double aSimTime)
void SendSurfaceSystemStatus (double aSimTime)
Protected Member Functions inherited from WsfL16::ComputerPart
double ProcessSendInterval (UtInput &aInput) const
double GetSendInterval ()
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).

Protected Attributes

Config mConfig
int mCategory
InputEnumeration mCategoryInput
Protected Attributes inherited from WsfL16::ComputerPart
IntervalUpdater mSendInterval
int mDebugMore
UtCallbackHolder mCallbacks
SlotParameters mSlotParameters
WsfScriptContextmContextPtr
ScriptMap mSendScripts

Additional Inherited Members

Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.

Member Enumeration Documentation

◆ Category

Enumerator
cAIR 
cSURFACE 
cSUBSURFACE 
cLAND 
cUNSET 

Constructor & Destructor Documentation

◆ SystemStatusPart() [1/2]

WsfL16::SystemStatusPart::SystemStatusPart ( WsfScenario & aScenario)

◆ SystemStatusPart() [2/2]

WsfL16::SystemStatusPart::SystemStatusPart ( const SystemStatusPart & aSrc)

◆ ~SystemStatusPart()

WsfL16::SystemStatusPart::~SystemStatusPart ( )
override

Member Function Documentation

◆ CheckWeapon()

bool WsfL16::SystemStatusPart::CheckWeapon ( WsfStringId aWeaponId)
protected

◆ Clone()

ComputerPart * WsfL16::SystemStatusPart::Clone ( ) const
overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfL16::ComputerPart.

References WsfL16::ComputerPart::ComputerPart(), and SystemStatusPart().

◆ HandleReceive()

void WsfL16::SystemStatusPart::HandleReceive ( double aSimTime,
const Messages::InitialBase & aMessage )
overridevirtual

Handle an incoming message.

Implements WsfL16::ComputerPart.

◆ HandleSend()

void WsfL16::SystemStatusPart::HandleSend ( double )
overridevirtual

This method is called when the a slot is open.

Reimplemented from WsfL16::ComputerPart.

References SendSystemStatus().

◆ Initialize()

◆ ProcessInput()

bool WsfL16::SystemStatusPart::ProcessInput ( UtInput & aInput)
overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters
aInputa reference to a UtInput object.
Returns
'true' if the command was one recognized by the class or 'false' if not.
Exceptions
UtInput::ExceptionBase(or an object derived from it) if the command was recognized but contains some sort of error.
Note
If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfL16::ComputerPart.

References mConfig, and WsfL16::ComputerPart::ProcessInput().

◆ SendAirSystemStatus()

◆ SendLandPointSystemStatus()

◆ SendPPLI()

void WsfL16::SystemStatusPart::SendPPLI ( double aSimTime)
protected

◆ SendSurfaceSystemStatus()

void WsfL16::SystemStatusPart::SendSurfaceSystemStatus ( double aSimTime)
protected

◆ SendSystemStatus()

void WsfL16::SystemStatusPart::SendSystemStatus ( double aSimTime)
protected

◆ WeaponQuantity()

int WsfL16::SystemStatusPart::WeaponQuantity ( WsfStringId aWeaponId)
protected

Member Data Documentation

◆ mCategory

int WsfL16::SystemStatusPart::mCategory
protected

◆ mCategoryInput

InputEnumeration WsfL16::SystemStatusPart::mCategoryInput
protected

◆ mConfig

Config WsfL16::SystemStatusPart::mConfig
protected

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved