WsfExchange Namespace Reference

Classes
class	Tender
class	Result
class	Query
	Callback Query class. More...
class	Container
class	Transactor

Enumerations
enum	CapabilityType {   cSUPPLY_PAYLOAD = 0 , cSUPPLY_FUEL = 1 , cVEHICLE_RECOVERY = 2 , cVEHICLE_REPAIR = 3 ,   cSUPPLY_ADS_B = 4 , cNO_CAPABILITY = 5 }

Functions
void	InitializeStatics ()
void	ModifyCapabilities (WsfPlatform *aPlatformPtr, unsigned int aOldCapability, unsigned int aNewCapability)
void	SetCapabilityFlag (WsfPlatform *aPlatformPtr, CapabilityType aCapability, bool aValue)
void	SetCapabilityFlag (unsigned int &aCurrentCapability, CapabilityType aCapability, bool aValue)
bool	IsCapable (unsigned int aCapabilityWord, CapabilityType aCapability)
unsigned int	CapabilityToBitNumber (CapabilityType aCapability)
CapabilityType	BitNumberToCapability (unsigned int aBitNumber)
CapabilityType	NameIdToCapability (WsfStringId aCapabilityNameId)
bool	IsCapable (const WsfPlatform *aPlatformPtr, CapabilityType aCapability)
WsfStringId	CapabilityToNameId (CapabilityType aCapability)

Variables
static WsfStringId	sSTATE_READY
static WsfStringId	sSTATE_REQUESTING
static WsfStringId	sSTATE_ACCEPTING
static WsfStringId	sSTATE_OFFERING
static WsfStringId	sSTATE_SUPPLYING
static WsfStringId	sEVENT_REQUESTED
static WsfStringId	sEVENT_OFFERED
static WsfStringId	sEVENT_ACCEPTED
static WsfStringId	sEVENT_SUPPLIED
static WsfStringId	sEVENT_RECEIVED
static WsfStringId	sEVENT_CANCELLED
static WsfStringId	sEVENT_OFFEROR_COMPLETED
static WsfStringId	sEVENT_REQUESTOR_RESPONDED

Detailed Description

A namespace for platform-to-platform suppling or receiving of a commodity or service. Four contained classes: Tender, Container, Query, and Transactor. Requires a WsfExchangeProcessor to stimulate the callback events for platform-to-platform Exchanges. Terminology recommendation: Avoid using the term 'receiver', as in this context it may be ambiguous as to whether it is the receiver of a commodity, or the receiver of an event notif- ication. Recommend using "Originator" for the sender of a message or event, "Requester" for player desiring commodities or services, and "Responder" for the provider of the commodity or service.

Enumeration Type Documentation

CapabilityType

enum WsfExchange::CapabilityType

Enumerator
cSUPPLY_PAYLOAD
cSUPPLY_FUEL
cVEHICLE_RECOVERY
cVEHICLE_REPAIR
cSUPPLY_ADS_B
cNO_CAPABILITY

Function Documentation

BitNumberToCapability()

CapabilityType WsfExchange::BitNumberToCapability

(

unsigned int

aBitNumber

)

References cNO_CAPABILITY, cSUPPLY_ADS_B, cSUPPLY_FUEL, cSUPPLY_PAYLOAD, cVEHICLE_RECOVERY, and cVEHICLE_REPAIR.

Referenced by ModifyCapabilities().

CapabilityToBitNumber()

unsigned int WsfExchange::CapabilityToBitNumber

(

CapabilityType

aCapability

)

References cNO_CAPABILITY, cSUPPLY_ADS_B, cSUPPLY_FUEL, cSUPPLY_PAYLOAD, cVEHICLE_RECOVERY, and cVEHICLE_REPAIR.

Referenced by IsCapable(), and SetCapabilityFlag().

CapabilityToNameId()

WsfStringId WsfExchange::CapabilityToNameId

(

CapabilityType

aCapability

)

References cNO_CAPABILITY, cSUPPLY_ADS_B, cSUPPLY_FUEL, cSUPPLY_PAYLOAD, cVEHICLE_RECOVERY, and cVEHICLE_REPAIR.

Referenced by ModifyCapabilities().

InitializeStatics()

void WsfExchange::InitializeStatics

(

)

References sEVENT_ACCEPTED, sEVENT_CANCELLED, sEVENT_OFFERED, sEVENT_OFFEROR_COMPLETED, sEVENT_RECEIVED, sEVENT_REQUESTED, sEVENT_REQUESTOR_RESPONDED, sEVENT_SUPPLIED, sSTATE_ACCEPTING, sSTATE_OFFERING, sSTATE_READY, sSTATE_REQUESTING, and sSTATE_SUPPLYING.

Referenced by WsfExchangeProcessor::WsfExchangeProcessor().

IsCapable() [1/2]

bool WsfExchange::IsCapable	(	const WsfPlatform *	aPlatformPtr,
		CapabilityType	aCapability )

This is a convenience method to make the Capabilities record in the platform more user-friendly, as the DIS-driven implementation requires bit-mapping the capability bits. This function abstracts away those unpleasant details.

References WsfPlatform::GetCapabilities(), and IsCapable().

IsCapable() [2/2]

bool WsfExchange::IsCapable	(	unsigned int	aCapabilityWord,
		CapabilityType	aCapability )

References CapabilityToBitNumber(), and WsfUtil::GenerateBitMask().

Referenced by IsCapable(), and ModifyCapabilities().

ModifyCapabilities()

void WsfExchange::ModifyCapabilities	(	WsfPlatform *	aPlatformPtr,
		unsigned int	aOldCapability,
		unsigned int	aNewCapability )

References BitNumberToCapability(), CapabilityToNameId(), cNO_CAPABILITY, WsfSimulation::GetSimTime(), WsfPlatform::GetSimulation(), IsCapable(), WsfObserver::PlatformCapabilityChanged(), and simTime.

Referenced by WsfPlatform::SetCapabilities().

NameIdToCapability()

CapabilityType WsfExchange::NameIdToCapability

(

WsfStringId

aCapabilityNameId

)

References cNO_CAPABILITY, cSUPPLY_ADS_B, cSUPPLY_FUEL, cSUPPLY_PAYLOAD, cVEHICLE_RECOVERY, and cVEHICLE_REPAIR.

Referenced by WsfExchangeProcessor::PlatformCapabilityChanged(), and UT_DEFINE_SCRIPT_METHOD().

SetCapabilityFlag() [1/2]

void WsfExchange::SetCapabilityFlag	(	unsigned int &	aCurrentCapability,
		CapabilityType	aCapability,
		bool	aValue )

References CapabilityToBitNumber(), and WsfUtil::GenerateBitMask().

SetCapabilityFlag() [2/2]

void WsfExchange::SetCapabilityFlag	(	WsfPlatform *	aPlatformPtr,
		CapabilityType	aCapability,
		bool	aValue )

References WsfPlatform::GetCapabilities(), WsfPlatform::SetCapabilities(), and SetCapabilityFlag().

Referenced by SetCapabilityFlag(), and UT_DEFINE_SCRIPT_METHOD().

Variable Documentation

sEVENT_ACCEPTED

WsfStringId WsfExchange::sEVENT_ACCEPTED

static

Referenced by WsfDisExchange::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), and WsfExchange::Query::StateMachine().

sEVENT_CANCELLED

WsfStringId WsfExchange::sEVENT_CANCELLED

static

Referenced by WsfDisExchange::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), WsfDisRepairResponse::Process(), WsfDisResupplyCancel::Process(), and WsfExchange::Query::StateMachine().

sEVENT_OFFERED

WsfStringId WsfExchange::sEVENT_OFFERED

static

Referenced by WsfDisExchange::ExchangeQueried(), WsfExchange::Query::FormOffer(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), WsfDisResupplyOffer::Process(), and WsfExchange::Query::StateMachine().

sEVENT_OFFEROR_COMPLETED

WsfStringId WsfExchange::sEVENT_OFFEROR_COMPLETED

static

Referenced by WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), WsfDisRepairComplete::Process(), and WsfExchange::Query::StateMachine().

sEVENT_RECEIVED

WsfStringId WsfExchange::sEVENT_RECEIVED

static

Referenced by InitializeStatics(), WsfExchange::Transactor::IsEvent(), WsfDisResupplyReceived::Process(), and WsfExchange::Query::StateMachine().

sEVENT_REQUESTED

WsfStringId WsfExchange::sEVENT_REQUESTED

static

Referenced by WsfDisExchange::ExchangeQueried(), WsfExchange::Query::FormRequest(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), and WsfExchange::Query::StateMachine().

sEVENT_REQUESTOR_RESPONDED

WsfStringId WsfExchange::sEVENT_REQUESTOR_RESPONDED

static

Referenced by WsfDisExchange::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), WsfDisRepairResponse::Process(), and WsfExchange::Query::StateMachine().

sEVENT_SUPPLIED

WsfStringId WsfExchange::sEVENT_SUPPLIED

static

Referenced by WsfDisExchange::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsEvent(), and WsfExchange::Query::StateMachine().

sSTATE_ACCEPTING

WsfStringId WsfExchange::sSTATE_ACCEPTING

static

Referenced by WsfExchange::Transactor::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsState(), and WsfExchange::Query::StateMachine().

sSTATE_OFFERING

WsfStringId WsfExchange::sSTATE_OFFERING

static

Referenced by WsfExchange::Transactor::ExchangeQueried(), WsfExchange::Query::FormOffer(), InitializeStatics(), WsfExchange::Transactor::IsState(), and WsfExchange::Query::StateMachine().

sSTATE_READY

WsfStringId WsfExchange::sSTATE_READY

static

Referenced by WsfExchange::Query::ContinuingReset(), WsfExchange::Transactor::ExchangeQueried(), WsfExchange::Query::FinalReset(), InitializeStatics(), WsfExchange::Transactor::IsReady(), WsfExchange::Transactor::IsState(), WsfExchange::Query::Query(), WsfExchange::Transactor::RequestFrom(), WsfExchange::Transactor::ReserveTender(), WsfExchange::Transactor::SetDesiredTender(), WsfExchange::Transactor::SetOfferedTender(), and WsfExchange::Query::StateMachine().

sSTATE_REQUESTING

WsfStringId WsfExchange::sSTATE_REQUESTING

static

Referenced by WsfExchange::Query::FormRequest(), InitializeStatics(), WsfExchange::Transactor::IsState(), WsfExchange::Transactor::RequestFrom(), and WsfExchange::Query::StateMachine().

sSTATE_SUPPLYING

WsfStringId WsfExchange::sSTATE_SUPPLYING

static

Referenced by WsfExchange::Transactor::ExchangeQueried(), InitializeStatics(), WsfExchange::Transactor::IsState(), and WsfExchange::Query::StateMachine().