The OMS / UCI Interface Object to the UCI middleware. More...

#include <WsfUCI_Computer.hpp>

Inheritance diagram for wsf::UCI_Computer:

[legend]

Collaboration diagram for wsf::UCI_Computer:

[legend]

Public Member Functions
	UCI_Computer (WsfScenario &aScenario)
	UCI_Computer (const UCI_Computer &aSrc)
virtual	~UCI_Computer ()=default
bool	PreInitialize (double aSimTime) override
bool	Initialize (double aSimTime) override
WsfObject *	Clone () const
const int *	GetComponentRoles () const override
WsfComponent *	CloneComponent () const override
void *	QueryInterface (int aRole) override
bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
void	ReceiveUCI_Message (const uci::type::MessageType *aMessagePtr) override
	UCI_Component (const WsfScenario &aScenario, int aPartType)
	UCI_Component (const UCI_Component &aSrc)
virtual	~UCI_Component ()
UCI_Interface *	GetInterface ()
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
virtual std::set< std::string >	GetCapabilityUUIDs () const
WsfStringId	GetComponentName () const override
virtual bool	InjectConditionally (double aSimTime, WsfPlatform &aPlatform)
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
bool	IsActive ()
	Is this interface active (i.e., it has a valid corresponding UCI interface; otherwise it does nothing).
bool	RegisterWithInterface (double aSimTime)
void	DeregisterWithInterface ()
void	RegisterCapabilitiesWithInterface ()
void	DeregisterCapabilitiesWithInterface ()
WsfSimulation &	GetSimulation () const
	Convenience Methods.
bool	CanHandleMessage () const
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
virtual void	Update (double aSimTime)
WsfPlatform *	GetPlatform () const
virtual void	SetPlatform (WsfPlatform *aPlatformPtr)
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	TurnOff (double aSimTime)
virtual void	TurnOn (double aSimTime)
virtual void	SetOperational (double aSimTime)
virtual void	SetNonOperational (double aSimTime)
virtual void	PartBroken (double aSimTime)
virtual void	Restore (double aSimTime)
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
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 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)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual void	PreInput ()
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
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

Additional Inherited Members
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
static const int	cWSF_COMPONENT_UCI = 1234568
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)
std::string	mSubsystemUUID
std::string	mSubsystemLabel

Detailed Description

The OMS / UCI Interface Object to the UCI middleware.

Constructor & Destructor Documentation

◆ UCI_Computer() [1/2]

wsf::UCI_Computer::UCI_Computer ( WsfScenario & aScenario )

References cWSF_COMPONENT_UCI_COMPUTER, and wsf::UCI_Component::UCI_Component().

Referenced by Clone(), CloneComponent(), and UCI_Computer().

◆ UCI_Computer() [2/2]

wsf::UCI_Computer::UCI_Computer ( const UCI_Computer & aSrc )

References wsf::UCI_Component::UCI_Component(), and UCI_Computer().

◆ ~UCI_Computer()

virtual wsf::UCI_Computer::~UCI_Computer ( )

virtualdefault

References Initialize(), and PreInitialize().

Member Function Documentation

◆ Clone()

WsfObject * wsf::UCI_Computer::Clone ( ) const

inlinevirtual

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

Implements WsfObject.

References UCI_Computer(), and WsfObject::WsfObject().

◆ CloneComponent()

WsfComponent * wsf::UCI_Computer::CloneComponent ( ) const

overridevirtual

Clones a component. May return null if component does not support clone.

Implements WsfComponent.

References UCI_Computer().

◆ GetComponentRoles()

const int * wsf::UCI_Computer::GetComponentRoles ( ) const

overridevirtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Reimplemented from wsf::UCI_Component.

References cWSF_COMPONENT_NULL, cWSF_COMPONENT_PLATFORM_PART, wsf::UCI_Component::cWSF_COMPONENT_UCI, and cWSF_COMPONENT_UCI_COMPUTER.

◆ Initialize()

bool wsf::UCI_Computer::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization. This is called by WsfPlatform::Initialize() during phase 1 initialization of the platform. The component should complete validation of input data that could not be done by ProcessInput, as well as any other functions to prepare for simulation use (subject to the next paragraph).

The order in which components are initialized is defined by GetComponentInitializationOrder. In general a component implementation of this method should not be dependent on the state of another component, i.e.: it should not assume that the other components Initialize() method has been called. If such a dependency exists one should use Initialize2() if possible, or specify a value GetComponentInitializationOrder to force things to initialize in a particular order.

Parameters

aSimTime The current simulation time.

Returns: true if successful or false if unsuccessful (bad input data, etc.)

Note: This method should NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

References wsf::UCI_InterfaceExtension::Get(), wsf::UCI_Component::GetSimulation(), and WsfComponent::Initialize().

Referenced by ~UCI_Computer().

◆ PreInitialize()

bool wsf::UCI_Computer::PreInitialize ( double aSimTime )

overridevirtual

Perform pre-initializion function. This is called by WsfPlatform::Initialize prior to actually initializing the components on a platform (i.e.: calling Initialize and Initialize2 for each component). The primary reason for this method is to allow components to add other components that will then be subsequently initialized. The component may examine the component list and add components, but it must not assume ANYTHING about the actual state of the component.

Parameters

aSimTime The current simulation time.

Returns: true if successful or false if unsuccessful (bad input data, etc.)

Reimplemented from WsfComponent.

References WsfComponent::PreInitialize(), and wsf::UCI_Component::RegisterWithInterface().

Referenced by ~UCI_Computer().

◆ ProcessMessage()

bool wsf::UCI_Computer::ProcessMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

overridevirtual

Process a received message.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.

Returns: 'true' if the message was processed or 'false' if not.

Note: A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfPlatformPart.

References wsf::UCI_Component::CanHandleMessage(), WsfPlatformPart::DebugEnabled(), WsfComponentT< WsfPlatform >::GetComponentParent(), WsfObject::GetName(), wsf::UCI_Component::GetSimulation(), UCI_Util::GetTimeStamp(), and WsfMessage::GetType().

◆ QueryInterface()

void * wsf::UCI_Computer::QueryInterface ( int aRole )

overridevirtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole The role whose interface is to be returned.

Returns: A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Reimplemented from wsf::UCI_Component.

References cWSF_COMPONENT_PLATFORM_PART, wsf::UCI_Component::cWSF_COMPONENT_UCI, cWSF_COMPONENT_UCI_COMPUTER, wsf::UCI_Component::UCI_Component(), and WsfPlatformPart::WsfPlatformPart().

◆ ReceiveUCI_Message()

void wsf::UCI_Computer::ReceiveUCI_Message ( const uci::type::MessageType * aMessagePtr )

overridevirtual

Receive a raw UCI message. By default do nothing.

Reimplemented from wsf::UCI_Component.

References wsf::UCI_Component::CanHandleMessage(), WsfPlatformPart::DebugEnabled(), WsfPlatformPart::GetInternalLinks(), WsfObject::GetName(), wsf::UCI_Component::GetSimulation(), and WsfPlatformPart::SendMessage().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UCI_Computer() [1/2]

◆ UCI_Computer() [2/2]

◆ ~UCI_Computer()

Member Function Documentation

◆ Clone()

◆ CloneComponent()

◆ GetComponentRoles()

◆ Initialize()

◆ PreInitialize()

◆ ProcessMessage()

◆ QueryInterface()

◆ ReceiveUCI_Message()