WsfExchange::Tender Class Reference

#include <WsfExchange.hpp>

Inheritance diagram for WsfExchange::Tender:

Collaboration diagram for WsfExchange::Tender:

Public Member Functions
	Tender ()
	Tender (WsfStringId aTypeId, double aQuantity=0.0, double aRate=0.0, bool aIsService=false)
Tender *	Clone () const
bool	ProcessInput (UtInput &aInput)
bool	Initialize ()
void	Null ()
bool	IsNull () const
bool	operator== (const Tender &aRhs) const
double	Rate () const
bool	IsService () const
bool	IsCommodity () const
double	Interval () const
double	Quantity () const
bool	IsCompatibleWith (const Tender &aRhs) const
void	SetQuantity (double aValue)
void	SetRate (double aValue)
void	SetIsService (bool aValue)
void	ConstrainQuantityTo (double aQuantity)
void	ConstrainRateTo (double aRate)
void	ConstrainTo (const Tender &aLimit)
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, Tender *&aTenderPtr)

Protected Member Functions
void	SetQuantityP (double aQuantity)
void	SetRateP (double aQuantity)

Protected Attributes
double	mQuantity
double	mRate
bool	mIsService

Detailed Description

Tender, or offer of goods or services. Represents the amount and rate of an exchanged good or service. Services are exchanged in non-dimensional values (i.e. repairs per second), while goods may be exchanged either non-dimensionally, or in mass-rate (kg/hr. etc.).

Constructor & Destructor Documentation

Tender() [1/2]

WsfExchange::Tender::Tender

(

)

References mIsService, mQuantity, mRate, and WsfNamed::WsfNamed().

Referenced by Clone(), ConstrainTo(), IsCompatibleWith(), LoadInstance(), and operator==().

Tender() [2/2]

WsfExchange::Tender::Tender	(	WsfStringId	aTypeId,
		double	aQuantity = 0.0,
		double	aRate = 0.0,
		bool	aIsService = false )

References mIsService, mQuantity, mRate, and WsfNamed::WsfNamed().

Member Function Documentation

Clone()

Tender * WsfExchange::Tender::Clone

(

)

const

References Tender().

ConstrainQuantityTo()

void WsfExchange::Tender::ConstrainQuantityTo

(

double

aQuantity

)

References mQuantity, and SetQuantityP().

Referenced by ConstrainTo().

ConstrainRateTo()

void WsfExchange::Tender::ConstrainRateTo

(

double

aRate

)

References mRate, and SetRateP().

Referenced by ConstrainTo().

ConstrainTo()

void WsfExchange::Tender::ConstrainTo

(

const Tender &

aLimit

)

References ConstrainQuantityTo(), ConstrainRateTo(), WsfNamed::GetNameId(), mQuantity, mRate, and Tender().

Decrement()

double WsfExchange::Tender::Decrement

(

double

aAmount

)

References mQuantity.

GetScriptClassName()

const char * WsfExchange::Tender::GetScriptClassName

(

)

const

References SetQuantityP(), and SetRateP().

Increment()

double WsfExchange::Tender::Increment

(

double

aAmount

)

References mQuantity.

Initialize()

bool WsfExchange::Tender::Initialize

(

)

Interval()

double WsfExchange::Tender::Interval ( ) const

inline

References mQuantity, and mRate.

IsCommodity()

bool WsfExchange::Tender::IsCommodity ( ) const

inline

References mIsService.

Referenced by ProcessInput().

IsCompatibleWith()

bool WsfExchange::Tender::IsCompatibleWith

(

const Tender &

aRhs

)

const

References WsfNamed::GetNameId(), mIsService, and Tender().

Referenced by operator==().

IsNull()

bool WsfExchange::Tender::IsNull ( ) const

inline

References mQuantity.

IsService()

bool WsfExchange::Tender::IsService ( ) const

inline

References mIsService.

Referenced by ProcessInput().

LoadInstance()

bool WsfExchange::Tender::LoadInstance ( UtInput & aInput, Tender *& aTenderPtr )

static

References ProcessInput(), SetIsService(), and Tender().

Referenced by WsfExchange::Container::ProcessInput().

Null()

void WsfExchange::Tender::Null ( )

inline

References mQuantity.

operator==()

bool WsfExchange::Tender::operator==

(

const Tender &

aRhs

)

const

References IsCompatibleWith(), mQuantity, mRate, and Tender().

ProcessInput()

bool WsfExchange::Tender::ProcessInput

(

UtInput &

aInput

)

References IsCommodity(), IsService(), mQuantity, and mRate.

Referenced by LoadInstance().

Quantity()

double WsfExchange::Tender::Quantity ( ) const

inline

References mQuantity.

Referenced by WsfExchange::Transactor::RequestFrom(), WsfExchange::Transactor::ReserveTender(), WsfExchange::Transactor::SetDesiredTender(), and WsfExchange::Transactor::SetOfferedTender().

Rate()

double WsfExchange::Tender::Rate ( ) const

inline

References mRate.

Referenced by WsfExchange::Transactor::RequestFrom(), and WsfExchange::Transactor::SetOfferedTender().

SetIsService()

void WsfExchange::Tender::SetIsService

(

bool

aValue

)

References mIsService.

Referenced by LoadInstance().

SetQuantity()

void WsfExchange::Tender::SetQuantity ( double aValue )

inline

References SetQuantityP().

Referenced by WsfExchange::Container::TenderNeeded(), and WsfExchange::Container::TenderRemaining().

SetQuantityP()

void WsfExchange::Tender::SetQuantityP ( double aQuantity )

protected

References mQuantity.

Referenced by ConstrainQuantityTo(), GetScriptClassName(), and SetQuantity().

SetRate()

void WsfExchange::Tender::SetRate ( double aValue )

inline

References SetRateP().

SetRateP()

void WsfExchange::Tender::SetRateP ( double aQuantity )

protected

References mRate.

Referenced by ConstrainRateTo(), GetScriptClassName(), and SetRate().

Member Data Documentation

mIsService

bool WsfExchange::Tender::mIsService

protected

Referenced by IsCommodity(), IsCompatibleWith(), IsService(), SetIsService(), Tender(), and Tender().

mQuantity

double WsfExchange::Tender::mQuantity

protected

Referenced by ConstrainQuantityTo(), ConstrainTo(), Decrement(), Increment(), Interval(), IsNull(), Null(), operator==(), ProcessInput(), Quantity(), SetQuantityP(), Tender(), and Tender().

mRate

double WsfExchange::Tender::mRate

protected

Referenced by ConstrainRateTo(), ConstrainTo(), Interval(), operator==(), ProcessInput(), Rate(), SetRateP(), Tender(), and Tender().

---

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

• WsfExchange.hpp
• WsfExchange.cpp