WSF
Public Member Functions | Static Public Member Functions | List of all members
WsfExchange::Transactor Class Reference

#include <WsfExchange.hpp>

Inheritance diagram for WsfExchange::Transactor:
Inheritance graph
[legend]
Collaboration diagram for WsfExchange::Transactor:
Collaboration graph
[legend]

Public Member Functions

 Transactor ()
 ~Transactor () override
bool Initialize (double aSimTime, WsfExchangeProcessor *aProcessorPtr)
WsfSimulation * GetSimulation () const
bool IsReady () const
bool IsInProgress () const
bool ContinueToOffer () const
bool AlwaysHonorRate () const
bool IsEnabled () const
bool IsOfferor () const
bool IsRequester () const
bool IsHookedToFuel () const
bool IsHookedToPayload () const
bool IsExclusiveHook () const
WsfStringId ContainerNameId () const
Container * ContainerPtr ()
const Container * ContainerPtr () const
double TimeOutClockInterval () const
std::string OwningPlatformName () const
std::string OppositePlatformName () const
std::string RequestorPlatformName () const
std::string ResponderPlatformName () const
std::string MyFullName () const
bool RequestFrom (double aSimTime, const WsfPlatform *aSupplierPtr, const Tender &aTender)
void Cancel (double aSimTime)
bool DebugEnabled () const
bool IsService () const
void DebugDump (double aSimTime, const Query &aQuery, ut::log::MessageStream &aMessageStream) const
void SetIsOfferor (bool aValue)
void SetContinueToOffer (bool aValue)
void SetIsHookedToPayload (bool aValue)
void SetIsHookedToFuel (bool aValue)
void SetTimeOutClockInterval (double aValue)
void SetProximityLimit (double aValue)
double ProximityLimit () const
Query & GetQuery ()
Query * GetQueryPtr ()
const Query & GetQuery () const
bool ProcessInput (UtInput &aInput)
bool ExchangeQueried (double aSimTime, const Query &aQuery)
void TakeQueuedAction (double aSimTime, unsigned int aRequestId, bool aIsTimeOut)
bool ReserveAll (double aSimTime)
bool ReserveTender (double aSimTime, const Tender &aTender)
bool ReserveFor (double aSimTime, const Tender &aTender, WsfPlatform *aReceiverPtr)
void ResetUserAmounts ()
bool IsInConflictWith (const Transactor &aRhs) const
bool SetDesiredTender (const Tender &aTender)
bool SetOfferedTender (const Tender &aTender)
void Disable ()
const char * GetScriptClassName () const
Public Member Functions inherited from WsfNamed
 WsfNamed ()
 WsfNamed (WsfStringId aName)
 WsfNamed (const WsfNamed &)=default
WsfNamed & operator= (const WsfNamed &)=default
virtual ~WsfNamed ()=default
const std::string & GetName () const
WsfStringId GetNameId () const
void SetName (WsfStringId aName)

Static Public Member Functions

static bool IsState (WsfStringId aState)
static bool IsEvent (WsfStringId aEventId)
static bool LoadInstance (UtInput &aInput, Transactor *&aInstancePtr)
static unsigned int NextSerialRequestId ()
static void ResetNextSerialRequestId ()

Detailed Description

Transactor of goods or services. Identifies the potential platforms involved in the exchange. A unique RequestId is held to distinguish this among a number of Transactions that may be going on simultaneously. Note that this Transactor does not "own" the produce or service, as it is stored in the Container. But as a broker, he is allowed to commit and hold a particular quantity for the transaction being considered at the moment.

Constructor & Destructor Documentation

◆ Transactor()

WsfExchange::Transactor::Transactor ( )

Referenced by GetScriptClassName(), IsInConflictWith(), LoadInstance(), and ResetUserAmounts().

◆ ~Transactor()

WsfExchange::Transactor::~Transactor ( )
override

Member Function Documentation

◆ AlwaysHonorRate()

bool WsfExchange::Transactor::AlwaysHonorRate ( ) const
inline

◆ Cancel()

void WsfExchange::Transactor::Cancel ( double aSimTime)

Referenced by TakeQueuedAction().

◆ ContainerNameId()

WsfStringId WsfExchange::Transactor::ContainerNameId ( ) const
inline

◆ ContainerPtr() [1/2]

Container * WsfExchange::Transactor::ContainerPtr ( )
inline

Referenced by RequestFrom().

◆ ContainerPtr() [2/2]

const Container * WsfExchange::Transactor::ContainerPtr ( ) const
inline

◆ ContinueToOffer()

bool WsfExchange::Transactor::ContinueToOffer ( ) const
inline

◆ DebugDump()

void WsfExchange::Transactor::DebugDump ( double aSimTime,
const Query & aQuery,
ut::log::MessageStream & aMessageStream ) const

References WsfExchange::Query::DebugDump(), and MyFullName().

Referenced by ExchangeQueried().

◆ DebugEnabled()

bool WsfExchange::Transactor::DebugEnabled ( ) const

Referenced by ExchangeQueried(), RequestFrom(), and TakeQueuedAction().

◆ Disable()

void WsfExchange::Transactor::Disable ( )

References simTime.

Referenced by ResetUserAmounts().

◆ ExchangeQueried()

bool WsfExchange::Transactor::ExchangeQueried ( double aSimTime,
const Query & aQuery )

hmmm, may need to remove this later?

References DebugDump(), DebugEnabled(), WsfExchange::Query::DesiredQuantity(), WsfExchange::Query::EventId(), WsfNamed::GetName(), WsfExchange::Query::IsDone(), WsfExchange::Query::IsOfferor(), WsfExchange::Query::IsService(), WsfExchange::Query::ItemId(), WsfExchange::Query::NegotiatedQuantity(), WsfExchange::Query::OfferedQuantity(), WsfExchange::Query::OwningIndex(), OwningPlatformName(), WsfExchange::Query::RequestId(), WsfExchange::Query::RequestingIndex(), WsfExchange::Query::RespondingIndex(), WsfExchange::sEVENT_OFFEROR_COMPLETED, WsfExchange::sSTATE_ACCEPTING, WsfExchange::sSTATE_OFFERING, WsfExchange::sSTATE_READY, and WsfExchange::sSTATE_SUPPLYING.

◆ GetQuery() [1/2]

Query & WsfExchange::Transactor::GetQuery ( )
inline

Referenced by OppositePlatformName(), OwningPlatformName(), RequestorPlatformName(), ResponderPlatformName(), SetDesiredTender(), and SetOfferedTender().

◆ GetQuery() [2/2]

const Query & WsfExchange::Transactor::GetQuery ( ) const
inline

◆ GetQueryPtr()

Query * WsfExchange::Transactor::GetQueryPtr ( )
inline

◆ GetScriptClassName()

const char * WsfExchange::Transactor::GetScriptClassName ( ) const

References RequestFrom(), and Transactor().

◆ GetSimulation()

WsfSimulation * WsfExchange::Transactor::GetSimulation ( ) const

◆ Initialize()

bool WsfExchange::Transactor::Initialize ( double aSimTime,
WsfExchangeProcessor * aProcessorPtr )

References WsfExchangeProcessor::FindContainer(), WsfComponentList::GetComponent(), WsfFuel::GetMaximumQuantity(), WsfPlatformPart::GetPlatform(), IsService(), MyFullName(), WsfFuel::SetInitialQuantity(), WsfFuel::SetMaximumQuantity(), WsfFuel::SetQuantityRemaining(), and success.

◆ IsEnabled()

bool WsfExchange::Transactor::IsEnabled ( ) const
inline

◆ IsEvent()

bool WsfExchange::Transactor::IsEvent ( WsfStringId aEventId)
static

References WsfExchange::sEVENT_ACCEPTED, WsfExchange::sEVENT_CANCELLED, WsfExchange::sEVENT_OFFERED, WsfExchange::sEVENT_OFFEROR_COMPLETED, WsfExchange::sEVENT_RECEIVED, WsfExchange::sEVENT_REQUESTED, WsfExchange::sEVENT_REQUESTOR_RESPONDED, and WsfExchange::sEVENT_SUPPLIED.

◆ IsExclusiveHook()

bool WsfExchange::Transactor::IsExclusiveHook ( ) const
inline

◆ IsHookedToFuel()

bool WsfExchange::Transactor::IsHookedToFuel ( ) const
inline

◆ IsHookedToPayload()

bool WsfExchange::Transactor::IsHookedToPayload ( ) const
inline

◆ IsInConflictWith()

bool WsfExchange::Transactor::IsInConflictWith ( const Transactor & aRhs) const

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

Referenced by ResetUserAmounts().

◆ IsInProgress()

bool WsfExchange::Transactor::IsInProgress ( ) const
inline

◆ IsOfferor()

bool WsfExchange::Transactor::IsOfferor ( ) const
inline

Referenced by RequestFrom(), and ReserveTender().

◆ IsReady()

bool WsfExchange::Transactor::IsReady ( ) const
inline

References WsfExchange::sSTATE_READY.

◆ IsRequester()

bool WsfExchange::Transactor::IsRequester ( ) const
inline

◆ IsService()

bool WsfExchange::Transactor::IsService ( ) const
inline

Referenced by Initialize(), and RequestFrom().

◆ IsState()

bool WsfExchange::Transactor::IsState ( WsfStringId aState)
static

References WsfExchange::sSTATE_ACCEPTING, WsfExchange::sSTATE_OFFERING, WsfExchange::sSTATE_READY, WsfExchange::sSTATE_REQUESTING, and WsfExchange::sSTATE_SUPPLYING.

◆ LoadInstance()

bool WsfExchange::Transactor::LoadInstance ( UtInput & aInput,
Transactor *& aInstancePtr )
static

References ProcessInput(), WsfNamed::SetName(), and Transactor().

Referenced by WsfExchangeProcessor::ProcessInput().

◆ MyFullName()

std::string WsfExchange::Transactor::MyFullName ( ) const

References WsfNamed::GetName(), and WsfObject::GetName().

Referenced by DebugDump(), and Initialize().

◆ NextSerialRequestId()

unsigned int WsfExchange::Transactor::NextSerialRequestId ( )
static

Referenced by WsfDisServiceRequest::Process(), and RequestFrom().

◆ OppositePlatformName()

std::string WsfExchange::Transactor::OppositePlatformName ( ) const

References WsfObject::GetName(), WsfSimulation::GetPlatformByIndex(), GetQuery(), and WsfPlatform::GetSimulation().

◆ OwningPlatformName()

std::string WsfExchange::Transactor::OwningPlatformName ( ) const

References WsfObject::GetName(), WsfSimulation::GetPlatformByIndex(), GetQuery(), and WsfPlatform::GetSimulation().

Referenced by ExchangeQueried(), RequestFrom(), and TakeQueuedAction().

◆ ProcessInput()

bool WsfExchange::Transactor::ProcessInput ( UtInput & aInput)

Referenced by LoadInstance(), and WsfExchangeProcessor::ProcessInput().

◆ ProximityLimit()

double WsfExchange::Transactor::ProximityLimit ( ) const
inline

◆ RequestFrom()

bool WsfExchange::Transactor::RequestFrom ( double aSimTime,
const WsfPlatform * aSupplierPtr,
const Tender & aTender )

References ContainerPtr(), WsfExchange::Result::cPENDING, WsfExchange::Result::cTIMED_OUT, DebugEnabled(), WsfObserver::ExchangeQueried(), WsfPlatform::GetIndex(), WsfObject::GetName(), WsfNamed::GetNameId(), IsOfferor(), IsService(), NextSerialRequestId(), OwningPlatformName(), WsfExchange::Tender::Quantity(), WsfExchange::Tender::Rate(), WsfExchange::sSTATE_READY, and WsfExchange::sSTATE_REQUESTING.

Referenced by GetScriptClassName().

◆ RequestorPlatformName()

std::string WsfExchange::Transactor::RequestorPlatformName ( ) const

References WsfObject::GetName(), WsfSimulation::GetPlatformByIndex(), GetQuery(), and WsfPlatform::GetSimulation().

◆ ReserveAll()

bool WsfExchange::Transactor::ReserveAll ( double aSimTime)

References ReserveTender().

◆ ReserveFor()

bool WsfExchange::Transactor::ReserveFor ( double aSimTime,
const Tender & aTender,
WsfPlatform * aReceiverPtr )

◆ ReserveTender()

bool WsfExchange::Transactor::ReserveTender ( double aSimTime,
const Tender & aTender )

References WsfExchange::Result::cPENDING, WsfExchange::Result::cTIMED_OUT, WsfNamed::GetNameId(), IsOfferor(), WsfExchange::Tender::Quantity(), SetOfferedTender(), and WsfExchange::sSTATE_READY.

Referenced by ReserveAll().

◆ ResetNextSerialRequestId()

void WsfExchange::Transactor::ResetNextSerialRequestId ( )
static

Referenced by WsfDisInterface::~WsfDisInterface().

◆ ResetUserAmounts()

void WsfExchange::Transactor::ResetUserAmounts ( )

References Disable(), IsInConflictWith(), SetDesiredTender(), SetOfferedTender(), and Transactor().

◆ ResponderPlatformName()

std::string WsfExchange::Transactor::ResponderPlatformName ( ) const

References WsfObject::GetName(), WsfSimulation::GetPlatformByIndex(), GetQuery(), and WsfPlatform::GetSimulation().

◆ SetContinueToOffer()

void WsfExchange::Transactor::SetContinueToOffer ( bool aValue)
inline

◆ SetDesiredTender()

bool WsfExchange::Transactor::SetDesiredTender ( const Tender & aTender)

References GetQuery(), WsfExchange::Tender::Quantity(), WsfExchange::Query::SetDesiredQuantity(), and WsfExchange::sSTATE_READY.

Referenced by ResetUserAmounts().

◆ SetIsHookedToFuel()

void WsfExchange::Transactor::SetIsHookedToFuel ( bool aValue)
inline

◆ SetIsHookedToPayload()

void WsfExchange::Transactor::SetIsHookedToPayload ( bool aValue)
inline

◆ SetIsOfferor()

void WsfExchange::Transactor::SetIsOfferor ( bool aValue)
inline

◆ SetOfferedTender()

bool WsfExchange::Transactor::SetOfferedTender ( const Tender & aTender)

References GetQuery(), WsfExchange::Tender::Quantity(), WsfExchange::Tender::Rate(), WsfExchange::Query::SetNegotiatedQuantity(), WsfExchange::Query::SetNegotiatedRate(), WsfExchange::Query::SetOfferedQuantity(), WsfExchange::Query::SetOfferedRate(), and WsfExchange::sSTATE_READY.

Referenced by ReserveTender(), and ResetUserAmounts().

◆ SetProximityLimit()

void WsfExchange::Transactor::SetProximityLimit ( double aValue)
inline

◆ SetTimeOutClockInterval()

void WsfExchange::Transactor::SetTimeOutClockInterval ( double aValue)
inline

◆ TakeQueuedAction()

void WsfExchange::Transactor::TakeQueuedAction ( double aSimTime,
unsigned int aRequestId,
bool aIsTimeOut )

References Cancel(), WsfExchange::Result::cIN_PROGRESS, DebugEnabled(), WsfNamed::GetName(), and OwningPlatformName().

◆ TimeOutClockInterval()

double WsfExchange::Transactor::TimeOutClockInterval ( ) const
inline
The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved