WSF: wsf::UCI_Interface Class Reference

WSF

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

#include <WsfUCI_Interface.hpp>

Public Member Functions
	UCI_Interface ()=default
	UCI_Interface (const UCI_Interface &aSrc)=delete
const UCI_Interface &	operator= (const UCI_Interface &aRhs)=delete
virtual	~UCI_Interface ()=default
bool	ProcessInput (UtInput &aInput)
bool	Initialize (WsfSimulation &aSimulation)
bool	IsConfigured () const
	Return whether this interface has been configured in ProcessInput.
UCI_Component *	GetUCI_Component (const std::string &aCapabilityId)
WsfSimulation &	GetSimulation ()
void	Shutdown ()
void	SetServiceDescriptor (const std::string &aServiceDescriptor)
void	RegisterComponent (UCI_Component &aComponent)
void	DeregisterComponent (UCI_Component &aComponent)
void	RegisterCapabilities (UCI_Component &aComponent)
void	DeregisterCapabilities (UCI_Component &aComponent)
uci::base::AbstractServiceBusConnection *	GetConnection () const
	Return the abstract service bus connection object.
void	ReceiveMessage (const uci::type::MessageType *aMessagePtr) const
void	PopulateHeader (const uci::type::DateTimeTypeValue &aSimTime, uci::type::HeaderType &aHeader)
template<typename T>
void	CreateMessageService ()
	Create and store a message service. This must be called for all relevant message types.
template<typename T>
void	GetMessageService (uci::base::accessorType::AccessorType aType, const T *&aServicePtr)
template<typename T>
void	GetTypeFactory (uci::base::accessorType::AccessorType aType, const T *&aFactoryPtr)

Detailed Description

The OMS / UCI Interface Object to the UCI middleware.

Constructor & Destructor Documentation

◆ UCI_Interface() [1/2]

wsf::UCI_Interface::UCI_Interface ( )

default

Referenced by operator=(), and UCI_Interface().

◆ UCI_Interface() [2/2]

wsf::UCI_Interface::UCI_Interface ( const UCI_Interface & aSrc )

delete

References UCI_Interface().

◆ ~UCI_Interface()

virtual wsf::UCI_Interface::~UCI_Interface ( )

virtualdefault

References Initialize(), and ProcessInput().

Member Function Documentation

◆ CreateMessageService()

template<typename T>

void wsf::UCI_Interface::CreateMessageService ( )

inline

Create and store a message service. This must be called for all relevant message types.

Referenced by Initialize().

◆ DeregisterCapabilities()

void wsf::UCI_Interface::DeregisterCapabilities ( UCI_Component & aComponent )

References wsf::UCI_Component::GetCapabilityUUIDs().

Referenced by wsf::UCI_Component::DeregisterCapabilitiesWithInterface().

◆ DeregisterComponent()

void wsf::UCI_Interface::DeregisterComponent ( UCI_Component & aComponent )

References WsfObject::GetName().

Referenced by wsf::UCI_Component::DeregisterWithInterface().

◆ GetConnection()

uci::base::AbstractServiceBusConnection * wsf::UCI_Interface::GetConnection ( ) const

inline

Return the abstract service bus connection object.

Referenced by wsf::UCI_AMTI_Component::Initialize2(), wsf::UCI_ESM_Component::Initialize2(), wsf::UCI_IRST_Component::Initialize2(), and wsf::UCI_SensorComponent::InitializeModeData().

◆ GetMessageService()

template<typename T>

void wsf::UCI_Interface::GetMessageService	(	uci::base::accessorType::AccessorType	aType,
		const T *&	aServicePtr )

inline

Referenced by wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), and wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType().

◆ GetSimulation()

WsfSimulation & wsf::UCI_Interface::GetSimulation ( )

inline

◆ GetTypeFactory()

template<typename T>

void wsf::UCI_Interface::GetTypeFactory	(	uci::base::accessorType::AccessorType	aType,
		const T *&	aFactoryPtr )

inline

Referenced by wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType(), and wsf::UCI_MessageType< Type, Factory, Reader, Writer, Listener, TypeName >::UCI_MessageType().

◆ GetUCI_Component()

UCI_Component * wsf::UCI_Interface::GetUCI_Component ( const std::string & aCapabilityId )

◆ Initialize()

bool wsf::UCI_Interface::Initialize ( WsfSimulation & aSimulation )

Initialize the abstract bus interface

Parameters

aSimulation The simulation object

References CreateMessageService().

Referenced by ~UCI_Interface().

◆ IsConfigured()

bool wsf::UCI_Interface::IsConfigured ( ) const

inline

Return whether this interface has been configured in ProcessInput.

◆ operator=()

const UCI_Interface & wsf::UCI_Interface::operator= ( const UCI_Interface & aRhs )

delete

References UCI_Interface().

◆ PopulateHeader()

void wsf::UCI_Interface::PopulateHeader	(	const uci::type::DateTimeTypeValue &	aSimTime,
		uci::type::HeaderType &	aHeader )

◆ ProcessInput()

bool wsf::UCI_Interface::ProcessInput ( UtInput & aInput )

Referenced by ~UCI_Interface().

◆ ReceiveMessage()

void wsf::UCI_Interface::ReceiveMessage ( const uci::type::MessageType * aMessagePtr ) const

Referenced by wsf::UCI_GenericListener_ReceiveMessage().

◆ RegisterCapabilities()

void wsf::UCI_Interface::RegisterCapabilities ( UCI_Component & aComponent )

References wsf::UCI_Component::GetCapabilityUUIDs().

Referenced by wsf::UCI_Component::RegisterCapabilitiesWithInterface().

◆ RegisterComponent()

void wsf::UCI_Interface::RegisterComponent ( UCI_Component & aComponent )

References WsfObject::GetName().

Referenced by wsf::UCI_Component::RegisterWithInterface().

◆ SetServiceDescriptor()

void wsf::UCI_Interface::SetServiceDescriptor ( const std::string & aServiceDescriptor )

inline

◆ Shutdown()

void wsf::UCI_Interface::Shutdown ( )

Shutdown the interface. If there is an active abstract bus connection, all services and factories will also be shutdown.

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

Copyrights Multiple, All Rights Reserved