Callback Query class. More...

#include <WsfExchange.hpp>

Public Member Functions
	Query (WsfSimulation *aSimulationPtr=nullptr)
bool	IsOfferor () const
bool	IsService () const
bool	IsDone () const
size_t	OwningIndex () const
unsigned int	RequestId () const
size_t	RequestingIndex () const
size_t	RespondingIndex () const
WsfSimulation *	GetSimulation () const
double	OfferedQuantity () const
double	OfferedRate () const
double	DesiredQuantity () const
double	DesiredRate () const
double	NegotiatedQuantity () const
double	NegotiatedRate () const
double	NegotiatedInterval () const
std::string	GetResultString () const
Result::Value	GetResultValue () const
size_t	IntendedRecipientIndex () const
size_t	OppositeIndex () const
WsfStringId	ItemId () const
WsfStringId	StateId () const
WsfStringId	EventId () const
void	SetOwningIndex (size_t aValue)
void	SetRespondingIndex (size_t aValue)
void	SetResult (Result::Value aValue)
void	SetOfferedQuantity (double aValue)
void	SetDesiredQuantity (double aValue)
void	SetOfferedRate (double aValue)
void	SetDesiredRate (double aValue)
void	SetRequestId (unsigned int aValue)
void	SetNegotiatedQuantity (double aValue)
void	SetNegotiatedRate (double aValue)
void	ConstrainTo (double aQuantity)
void	FinalReset ()
void	ContinuingReset (double aNewOfferQuantity)
	This is used for an Offeror who will continue offering,.
bool	Initialize (WsfPlatform *aOwningPlatform, bool aIsOfferor, WsfStringId aCommodityId, bool aIsService)
bool	FormRequest (size_t aOwningIndex, size_t aRequestingIndex, size_t aRespondingIndex, double aDesiredQuantity, double aDesiredRate, unsigned int aRequestId, WsfStringId aItemId, bool aIsOfferor, bool aIsService)
bool	FormOffer (size_t aOwningIndex, size_t aRequestingIndex, size_t aRespondingIndex, double aDesiredQuantity, double aDesiredRate, double aOfferedQuantity, double aOfferedRate, unsigned int aRequestId, WsfStringId aItemId, bool aIsOfferor, bool aIsService)
void	SetState (WsfStringId aValue)
void	SetEvent (WsfStringId aValue)
Tender	GetTender () const
void	DebugDump (ut::log::MessageStream &aStream) const
WsfStringId	StateMachine (WsfStringId aEventId) const
const char *	GetScriptClassName () const

Detailed Description

Callback Query class.

Constructor & Destructor Documentation

◆ Query()

WsfExchange::Query::Query ( WsfSimulation * aSimulationPtr = nullptr )

References WsfExchange::sSTATE_READY.

Member Function Documentation

◆ ConstrainTo()

void WsfExchange::Query::ConstrainTo ( double aQuantity )

Referenced by WsfDisResupplyReceived::Process().

◆ ContinuingReset()

void WsfExchange::Query::ContinuingReset ( double aNewOfferQuantity )

This is used for an Offeror who will continue offering,.

References WsfExchange::Result::cPENDING, and WsfExchange::sSTATE_READY.

◆ DebugDump()

void WsfExchange::Query::DebugDump ( ut::log::MessageStream & aStream ) const

Referenced by WsfExchange::Transactor::DebugDump(), and WsfDisResupplyOffer::Process().

◆ DesiredQuantity()

double WsfExchange::Query::DesiredQuantity ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried(), and WsfExchange::Transactor::ExchangeQueried().

◆ DesiredRate()

double WsfExchange::Query::DesiredRate ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried().

◆ EventId()

WsfStringId WsfExchange::Query::EventId ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), and WsfDisResupplyCancel::Process().

◆ FinalReset()

void WsfExchange::Query::FinalReset ( )

This will set the Query to an IsDone() State (TimedOut), and null all quantities.

References WsfExchange::Result::cTIMED_OUT, and WsfExchange::sSTATE_READY.

Referenced by WsfDisResupplyCancel::Process().

◆ FormOffer()

bool WsfExchange::Query::FormOffer	(	size_t	aOwningIndex,
		size_t	aRequestingIndex,
		size_t	aRespondingIndex,
		double	aDesiredQuantity,
		double	aDesiredRate,
		double	aOfferedQuantity,
		double	aOfferedRate,
		unsigned int	aRequestId,
		WsfStringId	aItemId,
		bool	aIsOfferor,
		bool	aIsService )

References WsfExchange::sEVENT_OFFERED, and WsfExchange::sSTATE_OFFERING.

◆ FormRequest()

bool WsfExchange::Query::FormRequest	(	size_t	aOwningIndex,
		size_t	aRequestingIndex,
		size_t	aRespondingIndex,
		double	aDesiredQuantity,
		double	aDesiredRate,
		unsigned int	aRequestId,
		WsfStringId	aItemId,
		bool	aIsOfferor,
		bool	aIsService )

References WsfExchange::sEVENT_REQUESTED, and WsfExchange::sSTATE_REQUESTING.

◆ GetResultString()

std::string WsfExchange::Query::GetResultString ( ) const

inline

◆ GetResultValue()

Result::Value WsfExchange::Query::GetResultValue ( ) const

inline

◆ GetScriptClassName()

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

◆ GetSimulation()

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

inline

◆ GetTender()

Tender WsfExchange::Query::GetTender ( ) const

◆ Initialize()

bool WsfExchange::Query::Initialize	(	WsfPlatform *	aOwningPlatform,
		bool	aIsOfferor,
		WsfStringId	aCommodityId,
		bool	aIsService )

References WsfPlatform::GetIndex(), and WsfPlatform::GetSimulation().

◆ IntendedRecipientIndex()

size_t WsfExchange::Query::IntendedRecipientIndex ( ) const

◆ IsDone()

bool WsfExchange::Query::IsDone ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), and WsfDisResupplyCancel::Process().

◆ IsOfferor()

bool WsfExchange::Query::IsOfferor ( ) const

inline

Referenced by WsfExchange::Transactor::ExchangeQueried().

◆ IsService()

bool WsfExchange::Query::IsService ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried(), and WsfExchange::Transactor::ExchangeQueried().

◆ ItemId()

WsfStringId WsfExchange::Query::ItemId ( ) const

inline

Referenced by WsfExchangeProcessor::ExchangeCompleted(), WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), WsfExchangeProcessor::ExchangeRequestFailed(), and WsfDisResupplyOffer::Process().

◆ NegotiatedInterval()

double WsfExchange::Query::NegotiatedInterval ( ) const

◆ NegotiatedQuantity()

double WsfExchange::Query::NegotiatedQuantity ( ) const

inline

Referenced by WsfExchangeProcessor::ExchangeCompleted(), WsfExchange::Transactor::ExchangeQueried(), and WsfExchangeProcessor::ExchangeRequestFailed().

◆ NegotiatedRate()

double WsfExchange::Query::NegotiatedRate ( ) const

inline

◆ OfferedQuantity()

double WsfExchange::Query::OfferedQuantity ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried(), and WsfExchange::Transactor::ExchangeQueried().

◆ OfferedRate()

double WsfExchange::Query::OfferedRate ( ) const

inline

◆ OppositeIndex()

size_t WsfExchange::Query::OppositeIndex ( ) const

◆ OwningIndex()

size_t WsfExchange::Query::OwningIndex ( ) const

inline

Referenced by WsfDisExchange::ExchangeQueried(), and WsfExchange::Transactor::ExchangeQueried().

◆ RequestId()

unsigned int WsfExchange::Query::RequestId ( ) const

inline

Referenced by WsfExchangeProcessor::ExchangeCompleted(), WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), and WsfExchangeProcessor::ExchangeRequestFailed().

◆ RequestingIndex()

size_t WsfExchange::Query::RequestingIndex ( ) const

inline

Referenced by WsfExchangeProcessor::ExchangeCompleted(), WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), and WsfExchangeProcessor::ExchangeRequestFailed().

◆ RespondingIndex()

size_t WsfExchange::Query::RespondingIndex ( ) const

inline

Referenced by WsfExchangeProcessor::ExchangeCompleted(), WsfDisExchange::ExchangeQueried(), WsfExchange::Transactor::ExchangeQueried(), and WsfExchangeProcessor::ExchangeRequestFailed().

◆ SetDesiredQuantity()

void WsfExchange::Query::SetDesiredQuantity ( double aValue )

Referenced by WsfExchange::Transactor::SetDesiredTender().

◆ SetDesiredRate()

void WsfExchange::Query::SetDesiredRate ( double aValue )

◆ SetEvent()

void WsfExchange::Query::SetEvent ( WsfStringId aValue )

inline

Referenced by WsfDisRepairComplete::Process(), WsfDisResupplyOffer::Process(), and WsfDisResupplyReceived::Process().

◆ SetNegotiatedQuantity()

void WsfExchange::Query::SetNegotiatedQuantity ( double aValue )

Referenced by WsfDisResupplyOffer::Process(), and WsfExchange::Transactor::SetOfferedTender().

◆ SetNegotiatedRate()

void WsfExchange::Query::SetNegotiatedRate ( double aValue )

Referenced by WsfExchange::Transactor::SetOfferedTender().

◆ SetOfferedQuantity()

void WsfExchange::Query::SetOfferedQuantity ( double aValue )

Referenced by WsfDisResupplyOffer::Process(), and WsfExchange::Transactor::SetOfferedTender().

◆ SetOfferedRate()

void WsfExchange::Query::SetOfferedRate ( double aValue )

Referenced by WsfExchange::Transactor::SetOfferedTender().

◆ SetOwningIndex()

void WsfExchange::Query::SetOwningIndex ( size_t aValue )

◆ SetRequestId()

void WsfExchange::Query::SetRequestId ( unsigned int aValue )

◆ SetRespondingIndex()

void WsfExchange::Query::SetRespondingIndex ( size_t aValue )

◆ SetResult()

void WsfExchange::Query::SetResult ( Result::Value aValue )

Referenced by WsfDisExchange::ExchangeQueried(), and WsfDisResupplyCancel::Process().

◆ SetState()

void WsfExchange::Query::SetState ( WsfStringId aValue )

inline

◆ StateId()

WsfStringId WsfExchange::Query::StateId ( ) const

inline

◆ StateMachine()

WsfStringId WsfExchange::Query::StateMachine ( WsfStringId aEventId ) const

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Query()

Member Function Documentation

◆ ConstrainTo()

◆ ContinuingReset()

◆ DebugDump()

◆ DesiredQuantity()

◆ DesiredRate()

◆ EventId()

◆ FinalReset()

◆ FormOffer()

◆ FormRequest()

◆ GetResultString()

◆ GetResultValue()

◆ GetScriptClassName()

◆ GetSimulation()

◆ GetTender()

◆ Initialize()

◆ IntendedRecipientIndex()

◆ IsDone()

◆ IsOfferor()

◆ IsService()

◆ ItemId()

◆ NegotiatedInterval()

◆ NegotiatedQuantity()

◆ NegotiatedRate()

◆ OfferedQuantity()

◆ OfferedRate()

◆ OppositeIndex()

◆ OwningIndex()

◆ RequestId()

◆ RequestingIndex()

◆ RespondingIndex()

◆ SetDesiredQuantity()

◆ SetDesiredRate()

◆ SetEvent()

◆ SetNegotiatedQuantity()

◆ SetNegotiatedRate()

◆ SetOfferedQuantity()

◆ SetOfferedRate()

◆ SetOwningIndex()

◆ SetRequestId()

◆ SetRespondingIndex()

◆ SetResult()

◆ SetState()

◆ StateId()

◆ StateMachine()