WsfExchange::Container Class Reference

#include <WsfExchange.hpp>

Inheritance diagram for WsfExchange::Container:

Collaboration diagram for WsfExchange::Container:

Public Member Functions
	Container ()
	Container (WsfStringId aNameId)
bool	ProcessInput (UtInput &aInput)
bool	Initialize ()
bool	IsFull () const
bool	IsEmpty () const
double	CurrentQuantity () const
double	MaximumQuantity () const
double	QuantityNeeded () const
bool	IsCompatibleWith (const Tender &aTender) const
Tender	TenderNeeded () const
Tender	TenderRemaining () const
const Tender &	MaximumTender () const
Tender &	MaximumTender ()
bool	IsService () const
bool	SetQuantity (double aValue)
double	Decrement (double aAmount)
double	Increment (double aAmount)
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	LoadInstance (UtInput &aInput, Container *&aContainerPtr)

Protected Attributes
Tender	mTender
double	mQuantity

Detailed Description

Container, which holds the quantity of tangible or non-tangible items that are exchanged in a Transactor.

Constructor & Destructor Documentation

Container() [1/2]

WsfExchange::Container::Container

(

)

References mQuantity, mTender, and WsfNamed::WsfNamed().

Referenced by LoadInstance().

Container() [2/2]

WsfExchange::Container::Container

(

WsfStringId

aNameId

)

References mQuantity, mTender, and WsfNamed::WsfNamed().

Member Function Documentation

CurrentQuantity()

double WsfExchange::Container::CurrentQuantity ( ) const

inline

References mQuantity.

Decrement()

double WsfExchange::Container::Decrement

(

double

aAmount

)

References mQuantity.

GetScriptClassName()

const char * WsfExchange::Container::GetScriptClassName

(

)

const

Increment()

double WsfExchange::Container::Increment

(

double

aAmount

)

References mQuantity, and mTender.

Initialize()

bool WsfExchange::Container::Initialize

(

)

References mQuantity, and mTender.

IsCompatibleWith()

bool WsfExchange::Container::IsCompatibleWith

(

const Tender &

aTender

)

const

References mTender.

IsEmpty()

bool WsfExchange::Container::IsEmpty

(

)

const

References mQuantity, and mTender.

IsFull()

bool WsfExchange::Container::IsFull

(

)

const

References mQuantity, and mTender.

IsService()

bool WsfExchange::Container::IsService ( ) const

inline

References mTender.

LoadInstance()

bool WsfExchange::Container::LoadInstance ( UtInput & aInput, Container *& aContainerPtr )

static

References Container(), and ProcessInput().

Referenced by WsfExchangeProcessor::ProcessInput().

MaximumQuantity()

double WsfExchange::Container::MaximumQuantity ( ) const

inline

References mTender.

MaximumTender() [1/2]

Tender & WsfExchange::Container::MaximumTender ( )

inline

References mTender.

MaximumTender() [2/2]

const Tender & WsfExchange::Container::MaximumTender ( ) const

inline

References mTender.

ProcessInput()

bool WsfExchange::Container::ProcessInput

(

UtInput &

aInput

)

References WsfExchange::Tender::LoadInstance(), mQuantity, and mTender.

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

QuantityNeeded()

double WsfExchange::Container::QuantityNeeded

(

)

const

References mQuantity, and mTender.

SetQuantity()

bool WsfExchange::Container::SetQuantity

(

double

aValue

)

References mQuantity, and mTender.

TenderNeeded()

Tender WsfExchange::Container::TenderNeeded

(

)

const

References mQuantity, mTender, and WsfExchange::Tender::SetQuantity().

TenderRemaining()

Tender WsfExchange::Container::TenderRemaining

(

)

const

References mQuantity, mTender, and WsfExchange::Tender::SetQuantity().

Member Data Documentation

mQuantity

double WsfExchange::Container::mQuantity

protected

Referenced by Container(), Container(), CurrentQuantity(), Decrement(), Increment(), Initialize(), IsEmpty(), IsFull(), ProcessInput(), QuantityNeeded(), SetQuantity(), TenderNeeded(), and TenderRemaining().

mTender

Tender WsfExchange::Container::mTender

protected

Referenced by Container(), Container(), Increment(), Initialize(), IsCompatibleWith(), IsEmpty(), IsFull(), IsService(), MaximumQuantity(), MaximumTender(), MaximumTender(), ProcessInput(), QuantityNeeded(), SetQuantity(), TenderNeeded(), and TenderRemaining().

---

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

• WsfExchange.hpp
• WsfExchange.cpp