#include <WsfExchangeProcessor.hpp>

Inheritance diagram for WsfExchangeProcessor:

[legend]

Collaboration diagram for WsfExchangeProcessor:

[legend]

Classes
struct	CommodityCapability
struct	Supplier

Public Member Functions
	WsfExchangeProcessor (WsfScenario &aScenario)
	WsfExchangeProcessor (const WsfExchangeProcessor &aSrc)
WsfExchangeProcessor &	operator= (const WsfExchangeProcessor &)=delete
	~WsfExchangeProcessor () override
WsfProcessor *	Clone () const override
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
bool	IgnoreAllProximityChecks () const
bool	ForceTransactionsInstantaneous () const
void	PlatformDeleted (WsfPlatform *aPlatformPtr) override
WsfExchange::Container *	FindContainer (WsfStringId aContainerNameId)
bool	AddContainer (const WsfExchange::Container &aContainer)
bool	AddTransactor (const WsfExchange::Transactor &aTransactor)
WsfExchange::Transactor *	FindTransactor (WsfStringId aTransactorNameId)
bool	GetTransactorPtr (WsfStringId aItemNameId, WsfStringId aContainerId, bool aIsOfferor, WsfExchange::Transactor *&aTransPtr)
WsfExchange::CapabilityType	GetCapabilityOf (WsfStringId aCommodityNameId)
bool	AddCapability (WsfStringId aCommodityTypeId)
void	PlatformCapabilityChanged (double aSimTime, WsfPlatform *aPlatformPtr, WsfStringId aCapabilityId, bool aIsCapable)
void	ExchangeQueried (double aSimTime, const WsfExchange::Query &aQuery)
void	ExchangeNegotiated (double aSimTime, const WsfExchange::Query &aQuery)
void	ExchangeRequestFailed (double aSimTime, const WsfExchange::Transactor &aTransactor, const WsfExchange::Query &aQuery)
void	ExchangeCompleted (double aSimTime, const WsfExchange::Transactor &aTransactor, const WsfExchange::Query &aQuery)
const char *	GetScriptClassName () const override
std::vector< size_t >	PayloadProviders ()
std::vector< size_t >	FuelProviders ()
std::vector< size_t >	VehicleRecoverers ()
std::vector< size_t >	VehicleRepairers ()
WsfPlatform *	ClosestPossibleProvider (WsfStringId aCommodityOrServiceId, double aProximityLimit=std::numeric_limits< double >::max())
Public Member Functions inherited from WsfScriptProcessor
	WsfScriptProcessor (const WsfScenario &aScenario)
	WsfScriptProcessor (const WsfScenario &aScenario, WsfStringId aPartClass, const std::string &aPartVarName)
	~WsfScriptProcessor () override
WsfProcessor *	Clone () const override
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override
bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
void	SendMessage (double aSimTime, const WsfMessage &aMessage) override
virtual void	ExecuteOnMessageCreate (double aSimTime, WsfMessage &aMessage)
virtual bool	ExecuteScript (double aSimTime, const std::string &aScriptName)
virtual bool	ExecuteScript (double aSimTime, WsfStringId aScriptName, UtScriptData &aScriptRetVal, const UtScriptDataList &aScriptArgs=UtScriptDataList())
void	ExecuteScriptAtTime (double aTime, WsfStringId aScriptName, const UtScriptDataList &aScriptArgs)
virtual void	SuppressMessage (bool aSuppressMessage)
WsfScriptMessageHandler *	GetMessageHandler ()
WsfScriptContext &	GetScriptContext ()
UtScriptContext *	GetScriptAccessibleContext () const override
void	SetPlatform (WsfPlatform *aPlatformPtr) override
const WsfBehaviorTree *	BehaviorTree () const
WsfAdvancedBehaviorTree *	AdvancedBehaviorTree () const
virtual const WsfScriptStateMachine *	GetStateMachine () const
wsf::ExternalLinks &	GetExternalLinks ()
std::string	State ()
std::string	StateAll ()
void	SetState (std::string &stateName)
void	SetStateAll (std::string &stateNameAll)
Public Member Functions inherited from WsfProcessor
	WsfProcessor (const WsfScenario &aScenario)
	~WsfProcessor () override=default
ComponentList &	GetComponents ()
const ComponentList &	GetComponents () const
virtual void	ProcessCallback (double aSimTime, const WsfCallback &aCallback)
WsfComponent *	CloneComponent () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
int	GetComponentInitializationOrder () const override
const char *	GetScriptClassName () const override
bool	PreInitialize (double aSimTime) override
void	PreInput () override
void	TurnOff (double aSimTime) override
void	TurnOn (double aSimTime) override
void	SetNonOperational (double aSimTime) override
void	SetOperational (double aSimTime) override
void	PartBroken (double aSimTime) override
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () 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
WsfPlatform *	GetPlatform () const
virtual void	PlatformAdded (double aSimTime, 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	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	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
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
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

Static Public Member Functions
static UtScriptClass *	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)

Protected Member Functions
bool	AddCapability (WsfStringId aCommodityTypeId, WsfExchange::CapabilityType aCapabilityType)
void	RemoveSupplier (size_t aPlatformIndex)
void	SetSupplierAbility (size_t aPlatformIndex, WsfExchange::CapabilityType aCapabilityType, bool aIsCapable)
Protected Member Functions inherited from WsfScriptProcessor
	WsfScriptProcessor (const WsfScriptProcessor &aSrc)
	WsfProcessor (const WsfProcessor &aSrc)
	Copy constructor (for Clone()).
WsfProcessor &	operator= (const WsfProcessor &aRhs)=delete
	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)

Additional Inherited Members
using	ComponentList = WsfComponentListT<WsfProcessorComponent>
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 Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
Protected Attributes inherited from WsfScriptProcessor
WsfScriptContext *	mContextPtr
	Pointer to the script context.
WsfScriptMessageHandler *	mMessageHandlerPtr
	Pointer to the 'on_message' handler.
UtScript *	mOnMessageCreateScriptPtr
	Pointer to the 'on_message_create' script.
UtScriptClass *	mMessageClassPtr
wsf::ExternalLinks	mExternalLinks
	The external recipients.
WsfBehaviorTree *	mBehaviorTreePtr
ut::CloneablePtr< WsfAdvancedBehaviorTree >	mAdvancedBehaviorTreePtr
std::unique_ptr< WsfScriptStateMachine >	mStateMachinePtr
int	mStateIndex
bool	mSuppressMessage

Detailed Description

The WsfExchangeProcessor controls the exchange of goods or services from one simulated platform to another, potentially externally via DIS if necessary. It allows for the owning platform to simultaneously request or supply more than one commodity or service, through the including of multiple Transactors onto the processor. For each Transactor that is an Offeror of commodities or services, a capability bit is exported, to permit interested platforms to know to whom they might address a request, and where to go for rendezvous with same. (This is not fully robust, as while a platform claims to supply fuel, it may supply a different kind of fuel than is desired, so will not respond when asked.) So an Update() of the processor is going to populate the platform's outbound capability bits, publishing what it may provide, and then will also update an internal list of what platforms might potentially be able to supply the commodities or services desired by the platform. A transfer always begins with a Request, and the addressee will (only if able) respond with an Offer. See Wiki Docs for details (WsfExchange, WsfWExchangeProcessor).

Constructor & Destructor Documentation

◆ WsfExchangeProcessor() [1/2]

WsfExchangeProcessor::WsfExchangeProcessor ( WsfScenario & aScenario )

References WsfExchange::InitializeStatics(), WsfScriptProcessor::mContextPtr, WsfProcessor::SetUpdateInterval(), and WsfScriptProcessor::WsfScriptProcessor().

Referenced by Clone(), operator=(), and WsfExchangeProcessor().

◆ WsfExchangeProcessor() [2/2]

WsfExchangeProcessor::WsfExchangeProcessor ( const WsfExchangeProcessor & aSrc )

References WsfScriptProcessor::mContextPtr, WsfExchangeProcessor(), and WsfScriptProcessor::WsfScriptProcessor().

◆ ~WsfExchangeProcessor()

WsfExchangeProcessor::~WsfExchangeProcessor ( )

override

Member Function Documentation

◆ AddCapability() [1/2]

bool WsfExchangeProcessor::AddCapability ( WsfStringId aCommodityTypeId )

References ExchangeQueried(), and PlatformCapabilityChanged().

Referenced by ProcessInput().

◆ AddCapability() [2/2]

bool WsfExchangeProcessor::AddCapability	(	WsfStringId	aCommodityTypeId,
		WsfExchange::CapabilityType	aCapabilityType )

protected

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

◆ AddContainer()

bool WsfExchangeProcessor::AddContainer ( const WsfExchange::Container & aContainer )

References FindContainer(), and WsfNamed::GetNameId().

Referenced by ProcessInput().

◆ AddTransactor()

bool WsfExchangeProcessor::AddTransactor ( const WsfExchange::Transactor & aTransactor )

Referenced by ProcessInput().

◆ Clone()

WsfProcessor * WsfExchangeProcessor::Clone ( ) const

overridevirtual

Create a clone of this object.

Returns: A pointer to the new copy.

Implements WsfProcessor.

References WsfExchangeProcessor(), and WsfProcessor::WsfProcessor().

◆ ClosestPossibleProvider()

WsfPlatform * WsfExchangeProcessor::ClosestPossibleProvider	(	WsfStringId	aCommodityOrServiceId,
		double	aProximityLimit = std::numeric_limits<double>::max() )

References WsfExchange::cNO_CAPABILITY, GetCapabilityOf(), WsfPlatformPart::GetPlatform(), WsfSimulation::GetPlatformByIndex(), WsfPlatformPart::GetSimulation(), and RemoveSupplier().

Referenced by ExchangeNegotiated().

◆ CreateScriptClass()

UtScriptClass * WsfExchangeProcessor::CreateScriptClass	(	const std::string &	aClassName,
		UtScriptTypes *	aScriptTypesPtr )

static

Referenced by ExchangeNegotiated().

◆ ExchangeCompleted()

void WsfExchangeProcessor::ExchangeCompleted	(	double	aSimTime,
		const WsfExchange::Transactor &	aTransactor,
		const WsfExchange::Query &	aQuery )

References WsfPlatformPart::DebugEnabled(), WsfPlatform::GetIndex(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfExchange::Query::ItemId(), WsfScriptProcessor::mContextPtr, WsfExchange::Query::NegotiatedQuantity(), WsfExchange::Query::RequestId(), WsfExchange::Query::RequestingIndex(), and WsfExchange::Query::RespondingIndex().

Referenced by ExchangeNegotiated(), and Initialize().

◆ ExchangeNegotiated()

void WsfExchangeProcessor::ExchangeNegotiated	(	double	aSimTime,
		const WsfExchange::Query &	aQuery )

References ClosestPossibleProvider(), CreateScriptClass(), ExchangeCompleted(), ExchangeRequestFailed(), FuelProviders(), PayloadProviders(), VehicleRecoverers(), and VehicleRepairers().

◆ ExchangeQueried()

void WsfExchangeProcessor::ExchangeQueried	(	double	aSimTime,
		const WsfExchange::Query &	aQuery )

References ExchangeQueried().

Referenced by AddCapability(), ExchangeQueried(), and Initialize().

◆ ExchangeRequestFailed()

void WsfExchangeProcessor::ExchangeRequestFailed	(	double	aSimTime,
		const WsfExchange::Transactor &	aTransactor,
		const WsfExchange::Query &	aQuery )

References WsfPlatformPart::DebugEnabled(), WsfPlatform::GetIndex(), WsfNamed::GetName(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfExchange::Query::ItemId(), WsfScriptProcessor::mContextPtr, WsfExchange::Query::NegotiatedQuantity(), WsfExchange::Query::RequestId(), WsfExchange::Query::RequestingIndex(), and WsfExchange::Query::RespondingIndex().

Referenced by ExchangeNegotiated(), and Initialize().

◆ FindContainer()

WsfExchange::Container * WsfExchangeProcessor::FindContainer ( WsfStringId aContainerNameId )

References WsfObject::GetNameId().

Referenced by AddContainer(), WsfExchange::Transactor::Initialize(), and ProcessInput().

◆ FindTransactor()

WsfExchange::Transactor * WsfExchangeProcessor::FindTransactor ( WsfStringId aTransactorNameId )

References WsfObject::GetNameId().

Referenced by ProcessInput().

◆ ForceTransactionsInstantaneous()

bool WsfExchangeProcessor::ForceTransactionsInstantaneous ( ) const

inline

◆ FuelProviders()

std::vector< size_t > WsfExchangeProcessor::FuelProviders ( )

References WsfExchange::cSUPPLY_FUEL.

Referenced by ExchangeNegotiated().

◆ GetCapabilityOf()

WsfExchange::CapabilityType WsfExchangeProcessor::GetCapabilityOf ( WsfStringId aCommodityNameId )

References WsfExchange::cNO_CAPABILITY.

Referenced by ClosestPossibleProvider().

◆ GetScriptClassName()

const char * WsfExchangeProcessor::GetScriptClassName ( ) const

override

◆ GetTransactorPtr()

bool WsfExchangeProcessor::GetTransactorPtr	(	WsfStringId	aItemNameId,
		WsfStringId	aContainerId,
		bool	aIsOfferor,
		WsfExchange::Transactor *&	aTransPtr )

◆ IgnoreAllProximityChecks()

bool WsfExchangeProcessor::IgnoreAllProximityChecks ( ) const

inline

◆ Initialize()

bool WsfExchangeProcessor::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 ExchangeCompleted(), WsfObserver::ExchangeCompleted(), ExchangeQueried(), WsfObserver::ExchangeQueried(), ExchangeRequestFailed(), WsfObserver::ExchangeRequestFailed(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), Initialize(), WsfScriptProcessor::Initialize(), WsfScriptProcessor::mContextPtr, PlatformCapabilityChanged(), WsfObserver::PlatformCapabilityChanged(), and success.

Referenced by Initialize().

◆ operator=()

WsfExchangeProcessor & WsfExchangeProcessor::operator= ( const WsfExchangeProcessor & )

delete

References WsfExchangeProcessor(), and WsfProcessor::WsfProcessor().

◆ PayloadProviders()

std::vector< size_t > WsfExchangeProcessor::PayloadProviders ( )

References WsfExchange::cSUPPLY_PAYLOAD.

Referenced by ExchangeNegotiated().

◆ PlatformCapabilityChanged()

void WsfExchangeProcessor::PlatformCapabilityChanged	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr,
		WsfStringId	aCapabilityId,
		bool	aIsCapable )

References WsfPlatform::GetIndex(), WsfPlatformPart::GetPlatform(), and WsfExchange::NameIdToCapability().

Referenced by AddCapability(), and Initialize().

◆ PlatformDeleted()

void WsfExchangeProcessor::PlatformDeleted ( WsfPlatform * aPlatformPtr )

overridevirtual

Some other platform has been deleted from the simulation.

This is invoked (via WsfPlatform::PlatformDeleted) whenever another platform has been deleted from the simulation.

Parameters

aPlatformPtr Pointer to the platform being deleted.

Reimplemented from WsfPlatformPart.

References WsfPlatform::GetIndex(), WsfPlatformPart::GetPlatform(), and RemoveSupplier().

◆ ProcessInput()

bool WsfExchangeProcessor::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

aInput a 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 WsfObject.

References AddCapability(), AddContainer(), AddTransactor(), WsfExchange::cSUPPLY_ADS_B, WsfExchange::cSUPPLY_FUEL, WsfExchange::cSUPPLY_PAYLOAD, WsfExchange::cVEHICLE_RECOVERY, WsfExchange::cVEHICLE_REPAIR, FindContainer(), FindTransactor(), WsfNamed::GetName(), WsfExchange::Container::LoadInstance(), WsfExchange::Transactor::LoadInstance(), WsfExchange::Container::ProcessInput(), WsfExchange::Transactor::ProcessInput(), and WsfScriptProcessor::ProcessInput().

◆ RemoveSupplier()

void WsfExchangeProcessor::RemoveSupplier ( size_t aPlatformIndex )

protected

Referenced by ClosestPossibleProvider(), and PlatformDeleted().

◆ SetSupplierAbility()

void WsfExchangeProcessor::SetSupplierAbility	(	size_t	aPlatformIndex,
		WsfExchange::CapabilityType	aCapabilityType,
		bool	aIsCapable )

protected

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSimulation::GetPlatformByIndex(), and WsfPlatformPart::GetSimulation().

◆ VehicleRecoverers()

std::vector< size_t > WsfExchangeProcessor::VehicleRecoverers ( )

References WsfExchange::cVEHICLE_RECOVERY.

Referenced by ExchangeNegotiated().

◆ VehicleRepairers()

std::vector< size_t > WsfExchangeProcessor::VehicleRepairers ( )

References WsfExchange::cVEHICLE_REPAIR.

Referenced by ExchangeNegotiated().

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfExchangeProcessor() [1/2]

◆ WsfExchangeProcessor() [2/2]

◆ ~WsfExchangeProcessor()

Member Function Documentation

◆ AddCapability() [1/2]

◆ AddCapability() [2/2]

◆ AddContainer()

◆ AddTransactor()

◆ Clone()

◆ ClosestPossibleProvider()

◆ CreateScriptClass()

◆ ExchangeCompleted()

◆ ExchangeNegotiated()

◆ ExchangeQueried()

◆ ExchangeRequestFailed()

◆ FindContainer()

◆ FindTransactor()

◆ ForceTransactionsInstantaneous()

◆ FuelProviders()

◆ GetCapabilityOf()

◆ GetScriptClassName()

◆ GetTransactorPtr()

◆ IgnoreAllProximityChecks()

◆ Initialize()

◆ operator=()

◆ PayloadProviders()

◆ PlatformCapabilityChanged()

◆ PlatformDeleted()

◆ ProcessInput()

◆ RemoveSupplier()

◆ SetSupplierAbility()

◆ VehicleRecoverers()

◆ VehicleRepairers()