#include <WsfRIPRJob.hpp>

Inheritance diagram for WsfRIPRJob:

Collaboration diagram for WsfRIPRJob:

[legend]

Public Member Functions
	WsfRIPRJob (WsfRIPRManager *aManagerPtr)
	WsfRIPRJob (WsfRIPRManager *aManagerPtr, unsigned int aAssignerRIPRProcId, std::string &aJobName, std::string &aJobDescription, double aPriority=0, int aMaxTakers=1)
	WsfRIPRJob (const WsfRIPRJob &aSrc)
	Copy constructor (for Clone()).
WsfRIPRJob *	Clone () const override
	~WsfRIPRJob () override
WsfRIPRJob &	operator= (const WsfRIPRJob &aSrc)
void	Update (double aSimTime)
void	BidJob (unsigned int aBidderRIPRProcId, double aBid, double aProgress)
void	BidJob (unsigned int aBidderRIPRProcId, double aBid)
ripr::RIPRBidderList::iterator	UnbidJob (unsigned int aQuitterRIPRProcId)
void	ClearBidders ()
double	GetBid (unsigned int aRIPRProcId) const
ripr::RIPRBidderList	GetBidders () const
double	GetBestProgress ()
void	SetWinnersMax (const int aNum)
	Sets the maximum number of bidders who can win this job.
void	SetWinnersMin (const int aNum)
	Sets the minimum number of bidders who can win this job.
void	SetPriority (const double aPriority)
	Set the job's priority.
void	SetProgress (WsfRIPRProcessor *aBidderPtr, int aChannelIndex, double aProgress)
void	SetProgress (unsigned int aRIPRProcId, double aProgress)
double	GetProgress (unsigned int aBidderRIPRProcId)
int	GetRank (unsigned int aBidderRIPRProcId)
int	GetId () const
unsigned int	AssignerProcessorId () const
WsfStringId	AssignerPlatformName () const
size_t	AssignerPlatformIndex () const
WsfPlatform *	AssignerPlatform () const
WsfRIPRProcessor *	Assigner () const
WsfStringId	AssignerProcessorName () const
double	GetPriority () const
int	GetWinnersMax () const
int	GetWinnersMin () const
std::string	Description () const
const ripr::RIPRJobDataMap &	Data () const
UtScriptData	Data (const std::string &aDataKey) const
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
double	CurrentTime () const
void	SetBidWindowOpen (const bool aValue)
bool	IsBidWindowOpen () const
void	SendMessageSetProgress (wsf::comm::Comm aCommPtr, WsfRIPRProcessor aBidderPtr, int aChannelIndex, double aProgress)
void	SendMessageBidJob (wsf::comm::Comm aCommPtr, WsfRIPRProcessor aBidderPtr, int aChannelIndex, double aBid, double aProgress=0)
void	SendMessageUnbidJob (wsf::comm::Comm aCommPtr, WsfRIPRProcessor aBidderPtr, int aChannelIndex)
WsfRIPRManager *	GetManager () const
WsfSimulation *	GetSimulation () const
std::set< int > &	Dependencies ()
void	DependencyAdd (int aDependedOnJobId)
void	DependencyRemove (int aDependedOnJobId)
bool	DependencyCheck (int aDependedOnJobId)
int	DependencyCount ()
void	Touch ()
double	TouchTime ()
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
virtual bool	ProcessInput (UtInput &aInput)
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Static Public Member Functions
static bool	CompareBidders (const ripr::RIPRBidderPair &first, const ripr::RIPRBidderPair &second)
static int	NextId ()
static void	Reset ()

Public Attributes
WsfRIPRManager *	mManagerPtr
ripr::RIPRBidderList	mBidders
	list of pairs matching bidders (by proc id) to their bids (doubles)
ripr::RIPRJobProgressMap	mProgress
	mapping between proc ids and progress performing this job
std::string	mDescription
	a human-readable string describing this job
ripr::RIPRJobDataMap	mData
	key/value pairs of auxiliary data attached to this job

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

◆ WsfRIPRJob() [1/3]

WsfRIPRJob::WsfRIPRJob ( WsfRIPRManager * aManagerPtr )

References WsfSimulation::GetSimTime(), GetSimulation(), mDescription, mManagerPtr, NextId(), WsfObject::SetName(), WsfObject::SetType(), and WsfObject::WsfObject().

Referenced by Clone(), operator=(), and WsfRIPRJob().

◆ WsfRIPRJob() [2/3]

WsfRIPRJob::WsfRIPRJob	(	WsfRIPRManager *	aManagerPtr,
		unsigned int	aAssignerRIPRProcId,
		std::string &	aJobName,
		std::string &	aJobDescription,
		double	aPriority = 0,
		int	aMaxTakers = 1 )

References WsfSimulation::GetSimTime(), GetSimulation(), mDescription, mManagerPtr, NextId(), WsfObject::SetName(), WsfObject::SetType(), and WsfObject::WsfObject().

◆ WsfRIPRJob() [3/3]

WsfRIPRJob::WsfRIPRJob ( const WsfRIPRJob & aSrc )

Copy constructor (for Clone()).

References WsfObject::GetName(), WsfObject::GetType(), mBidders, mData, mDescription, mManagerPtr, mProgress, WsfObject::SetName(), WsfObject::SetType(), WsfObject::WsfObject(), and WsfRIPRJob().

◆ ~WsfRIPRJob()

WsfRIPRJob::~WsfRIPRJob ( )

override

References mBidders, mData, mDescription, and mProgress.

Member Function Documentation

◆ Assigner()

WsfRIPRProcessor * WsfRIPRJob::Assigner ( ) const

References GetManager(), and WsfRIPRManager::GetRiprProcById().

Referenced by SetPriority(), and SetWinnersMax().

◆ AssignerPlatform()

WsfPlatform * WsfRIPRJob::AssignerPlatform ( ) const

References GetManager(), WsfPlatformPart::GetPlatform(), WsfRIPRManager::GetRiprProcById(), and platformPtr.

Referenced by AssignerPlatformIndex(), AssignerPlatformName(), SendMessageBidJob(), SendMessageSetProgress(), and SendMessageUnbidJob().

◆ AssignerPlatformIndex()

size_t WsfRIPRJob::AssignerPlatformIndex ( ) const

References AssignerPlatform(), and platformPtr.

◆ AssignerPlatformName()

WsfStringId WsfRIPRJob::AssignerPlatformName ( ) const

References AssignerPlatform(), and platformPtr.

◆ AssignerProcessorId()

unsigned int WsfRIPRJob::AssignerProcessorId ( ) const

inline

◆ AssignerProcessorName()

WsfStringId WsfRIPRJob::AssignerProcessorName ( ) const

References GetManager(), WsfObject::GetNameId(), and WsfRIPRManager::GetRiprProcById().

Referenced by SendMessageBidJob(), SendMessageSetProgress(), and SendMessageUnbidJob().

◆ BidJob() [1/2]

void WsfRIPRJob::BidJob	(	unsigned int	aBidderRIPRProcId,
		double	aBid )

References GetManager(), WsfRIPRManager::GetRiprProcById(), WsfRIPRProcessor::JobBoard(), mBidders, WsfRIPRJobBoard::SetDirtyJobs(), UnbidJob(), and WsfRIPRJobBoard::UpdateMinMaxBids().

◆ BidJob() [2/2]

void WsfRIPRJob::BidJob	(	unsigned int	aBidderRIPRProcId,
		double	aBid,
		double	aProgress )

References BidJob(), and mProgress.

Referenced by BidJob(), and WsfRIPRProcessor::ProcessMessage().

◆ ClearBidders()

void WsfRIPRJob::ClearBidders ( )

References GetManager(), WsfRIPRManager::GetRiprProcById(), WsfRIPRProcessor::JobBoard(), mBidders, mProgress, and WsfRIPRJobBoard::SetDirtyJobs().

◆ Clone()

WsfRIPRJob * WsfRIPRJob::Clone ( ) const

inlineoverridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References WsfRIPRJob().

◆ CompareBidders()

bool WsfRIPRJob::CompareBidders	(	const ripr::RIPRBidderPair &	first,
		const ripr::RIPRBidderPair &	second )

static

◆ CurrentTime()

double WsfRIPRJob::CurrentTime ( ) const

inline

Returns what this job believes to be the current time. This is intended for internal use, but somebody could conceivably find an external use for it.

Referenced by SetPriority(), and SetWinnersMax().

◆ Data() [1/2]

const ripr::RIPRJobDataMap & WsfRIPRJob::Data ( ) const

inline

References mData.

◆ Data() [2/2]

UtScriptData WsfRIPRJob::Data ( const std::string & aDataKey ) const

References mData.

◆ Dependencies()

std::set< int > & WsfRIPRJob::Dependencies ( )

inline

References WsfRIPRJobBoard::DependenciesForJob(), and GetId().

Referenced by WsfRIPRJobBoard::DependencyTest().

◆ DependencyAdd()

void WsfRIPRJob::DependencyAdd ( int aDependedOnJobId )

inline

References WsfRIPRJobBoard::DependencyAdd(), and GetId().

◆ DependencyCheck()

bool WsfRIPRJob::DependencyCheck ( int aDependedOnJobId )

inline

References WsfRIPRJobBoard::DependencyCheck(), and GetId().

◆ DependencyCount()

int WsfRIPRJob::DependencyCount ( )

inline

References WsfRIPRJobBoard::DependencyCount(), and GetId().

Referenced by WsfRIPRJobBoard::DependencyTest().

◆ DependencyRemove()

void WsfRIPRJob::DependencyRemove ( int aDependedOnJobId )

inline

References WsfRIPRJobBoard::DependencyRemove(), and GetId().

◆ Description()

std::string WsfRIPRJob::Description ( ) const

inline

References mDescription.

◆ GetBestProgress()

double WsfRIPRJob::GetBestProgress ( )

References mBidders, mProgress, and Update().

◆ GetBid()

double WsfRIPRJob::GetBid ( unsigned int aRIPRProcId ) const

References mBidders.

Referenced by WsfRIPRJobBoard::AllocateJobsCoverThenGreedy().

◆ GetBidders()

ripr::RIPRBidderList WsfRIPRJob::GetBidders ( ) const

inline

References mBidders.

◆ GetId()

int WsfRIPRJob::GetId ( ) const

Referenced by WsfRIPRJobBoard::BlockJobsWithFailedDependencies(), WsfRIPRJobBoard::BlockJobsWithoutMinWinners(), Dependencies(), DependencyAdd(), DependencyCheck(), DependencyCount(), DependencyRemove(), WsfRIPRJobBoard::DependencyTest(), WsfRIPRProcessor::JobFor(), SendMessageBidJob(), SendMessageSetProgress(), SendMessageUnbidJob(), and UT_DEFINE_SCRIPT_METHOD().

◆ GetManager()

WsfRIPRManager * WsfRIPRJob::GetManager ( ) const

inline

References mManagerPtr.

Referenced by Assigner(), AssignerPlatform(), AssignerProcessorName(), BidJob(), ClearBidders(), GetSimulation(), SetPriority(), SetProgress(), SetWinnersMax(), and UnbidJob().

◆ GetPriority()

double WsfRIPRJob::GetPriority ( ) const

inline

Referenced by WsfRIPRJobBoard::AllocateJobsCoverThenGreedy(), WsfRIPRJobBoard::AllocateJobsGreedy(), and WsfRIPRJobBoard::CompareJobPriorities().

◆ GetProgress()

double WsfRIPRJob::GetProgress ( unsigned int aBidderRIPRProcId )

References mProgress.

◆ GetRank()

int WsfRIPRJob::GetRank ( unsigned int aBidderRIPRProcId )

References mBidders, and Update().

◆ GetSimulation()

WsfSimulation * WsfRIPRJob::GetSimulation ( ) const

References GetManager(), and WsfSimulationExtension::GetSimulation().

Referenced by SendMessageBidJob(), SendMessageSetProgress(), SendMessageUnbidJob(), Touch(), WsfRIPRJob(), and WsfRIPRJob().

◆ GetWinnersMax()

int WsfRIPRJob::GetWinnersMax ( ) const

inline

◆ GetWinnersMin()

int WsfRIPRJob::GetWinnersMin ( ) const

inline

Referenced by WsfRIPRJobBoard::BlockJobsWithoutMinWinners(), and WsfRIPRJobBoard::DependencyTest().

◆ IsBidWindowOpen()

bool WsfRIPRJob::IsBidWindowOpen ( ) const

inline

◆ NextId()

int WsfRIPRJob::NextId ( )

static

Referenced by WsfRIPRJob(), and WsfRIPRJob().

◆ operator=()

WsfRIPRJob & WsfRIPRJob::operator= ( const WsfRIPRJob & aSrc )

References WsfObject::GetName(), WsfObject::GetType(), mBidders, mData, mDescription, mManagerPtr, mProgress, WsfObject::SetName(), WsfObject::SetType(), and WsfRIPRJob().

◆ Reset()

void WsfRIPRJob::Reset ( )

inlinestatic

Referenced by WsfRIPR_ModuleSetup::~WsfRIPR_ModuleSetup().

◆ SendMessageBidJob()

void WsfRIPRJob::SendMessageBidJob	(	wsf::comm::Comm *	aCommPtr,
		WsfRIPRProcessor *	aBidderPtr,
		int	aChannelIndex,
		double	aBid,
		double	aProgress = 0 )

References AssignerPlatform(), AssignerProcessorName(), WsfComponentList::RoleIterator< T >::AtEnd(), wsf::comm::Address::GetAddress(), wsf::comm::Comm::GetAddress(), WsfSimulation::GetCommNetworkManager(), GetId(), WsfRIPRProcessor::GetId(), WsfPlatformPart::GetPlatform(), GetSimulation(), and wsf::comm::Comm::Send().

◆ SendMessageSetProgress()

void WsfRIPRJob::SendMessageSetProgress	(	wsf::comm::Comm *	aCommPtr,
		WsfRIPRProcessor *	aBidderPtr,
		int	aChannelIndex,
		double	aProgress )

References AssignerPlatform(), AssignerProcessorName(), WsfComponentList::RoleIterator< T >::AtEnd(), wsf::comm::Address::GetAddress(), wsf::comm::Comm::GetAddress(), WsfSimulation::GetCommNetworkManager(), GetId(), WsfRIPRProcessor::GetId(), WsfPlatformPart::GetPlatform(), GetSimulation(), and wsf::comm::Comm::Send().

◆ SendMessageUnbidJob()

void WsfRIPRJob::SendMessageUnbidJob	(	wsf::comm::Comm *	aCommPtr,
		WsfRIPRProcessor *	aBidderPtr,
		int	aChannelIndex )

References AssignerPlatform(), AssignerProcessorName(), WsfComponentList::RoleIterator< T >::AtEnd(), wsf::comm::Address::GetAddress(), wsf::comm::Comm::GetAddress(), WsfSimulation::GetCommNetworkManager(), GetId(), WsfRIPRProcessor::GetId(), WsfPlatformPart::GetPlatform(), GetSimulation(), and wsf::comm::Comm::Send().

◆ Serialize()

template<typename T>

void WsfRIPRJob::Serialize ( T & aBuff )

inline

For XIO (de)serialization.

References mBidders, mData, mDescription, mProgress, and WsfObject::Serialize().

◆ SetBidWindowOpen()

void WsfRIPRJob::SetBidWindowOpen ( const bool aValue )

inline

Referenced by WsfRIPRJobBoard::AddJob().

◆ SetPriority()

void WsfRIPRJob::SetPriority ( const double aPriority )

Set the job's priority.

References Assigner(), CurrentTime(), GetManager(), WsfRIPRManager::GetObserver(), WsfRIPRProcessor::JobBoard(), WsfRIPRObserver::JobPriorityChanged, and WsfRIPRJobBoard::SetDirtyJobs().

◆ SetProgress() [1/2]

void WsfRIPRJob::SetProgress	(	unsigned int	aRIPRProcId,
		double	aProgress )

References GetManager(), WsfRIPRManager::GetRiprProcById(), WsfRIPRProcessor::JobChannelByProcId(), and SetProgress().

◆ SetProgress() [2/2]

void WsfRIPRJob::SetProgress	(	WsfRIPRProcessor *	aBidderPtr,
		int	aChannelIndex,
		double	aProgress )

References WsfRIPRProcessor::GetId(), and mProgress.

Referenced by WsfRIPRProcessor::ProcessMessage(), and SetProgress().

◆ SetWinnersMax()

void WsfRIPRJob::SetWinnersMax ( const int aNum )

Sets the maximum number of bidders who can win this job.

References Assigner(), CurrentTime(), GetManager(), WsfRIPRManager::GetObserver(), WsfRIPRProcessor::JobBoard(), WsfRIPRObserver::JobMaxWinnersChanged, and WsfRIPRJobBoard::SetDirtyJobs().

◆ SetWinnersMin()

void WsfRIPRJob::SetWinnersMin ( const int aNum )

Sets the minimum number of bidders who can win this job.

◆ Touch()

void WsfRIPRJob::Touch ( )

References WsfSimulation::GetSimTime(), and GetSimulation().

◆ TouchTime()

double WsfRIPRJob::TouchTime ( )

inline

◆ UnbidJob()

ripr::RIPRBidderList::iterator WsfRIPRJob::UnbidJob ( unsigned int aQuitterRIPRProcId )

References GetManager(), WsfRIPRManager::GetRiprProcById(), WsfRIPRProcessor::JobBoard(), mBidders, mProgress, and WsfRIPRJobBoard::SetDirtyJobs().

Referenced by BidJob(), and WsfRIPRProcessor::ProcessMessage().

◆ Update()

void WsfRIPRJob::Update ( double aSimTime )

if Update is called with a time parameter, update the time member var then call the parameterless Update().

References Update().

Referenced by GetBestProgress(), GetRank(), and Update().

Member Data Documentation

◆ mBidders

ripr::RIPRBidderList WsfRIPRJob::mBidders

list of pairs matching bidders (by proc id) to their bids (doubles)

Referenced by BidJob(), ClearBidders(), GetBestProgress(), GetBid(), GetBidders(), GetRank(), operator=(), Serialize(), UnbidJob(), WsfRIPRJob(), and ~WsfRIPRJob().

◆ mData

ripr::RIPRJobDataMap WsfRIPRJob::mData

key/value pairs of auxiliary data attached to this job

Referenced by Data(), Data(), WsfRIPRJobBoard::GetJobByData(), operator=(), Serialize(), WsfRIPRJob(), and ~WsfRIPRJob().

◆ mDescription

std::string WsfRIPRJob::mDescription

a human-readable string describing this job

Referenced by WsfRIPRJobBoard::AddJob(), WsfRIPRJobBoard::AllocateJobsCoverThenGreedy(), WsfRIPRJobBoard::AllocateJobsGreedy(), WsfRIPRJobBoard::BlockJobsWithFailedDependencies(), WsfRIPRJobBoard::BlockJobsWithoutMinWinners(), WsfRIPRJobBoard::DependencyTest(), Description(), operator=(), WsfRIPRJobBoard::RemoveJob(), Serialize(), WsfRIPRJob(), WsfRIPRJob(), WsfRIPRJob(), and ~WsfRIPRJob().

◆ mManagerPtr

WsfRIPRManager* WsfRIPRJob::mManagerPtr

Referenced by GetManager(), operator=(), WsfRIPRJob(), WsfRIPRJob(), and WsfRIPRJob().

◆ mProgress

ripr::RIPRJobProgressMap WsfRIPRJob::mProgress

mapping between proc ids and progress performing this job

Referenced by BidJob(), ClearBidders(), GetBestProgress(), GetProgress(), operator=(), Serialize(), SetProgress(), UnbidJob(), WsfRIPRJob(), and ~WsfRIPRJob().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ WsfRIPRJob() [1/3]

◆ WsfRIPRJob() [2/3]

◆ WsfRIPRJob() [3/3]

◆ ~WsfRIPRJob()

Member Function Documentation

◆ Assigner()

◆ AssignerPlatform()

◆ AssignerPlatformIndex()

◆ AssignerPlatformName()

◆ AssignerProcessorId()

◆ AssignerProcessorName()

◆ BidJob() [1/2]

◆ BidJob() [2/2]

◆ ClearBidders()

◆ Clone()

◆ CompareBidders()

◆ CurrentTime()

◆ Data() [1/2]

◆ Data() [2/2]

◆ Dependencies()

◆ DependencyAdd()

◆ DependencyCheck()

◆ DependencyCount()

◆ DependencyRemove()

◆ Description()

◆ GetBestProgress()

◆ GetBid()

◆ GetBidders()

◆ GetId()

◆ GetManager()

◆ GetPriority()

◆ GetProgress()

◆ GetRank()

◆ GetSimulation()

◆ GetWinnersMax()

◆ GetWinnersMin()

◆ IsBidWindowOpen()

◆ NextId()

◆ operator=()

◆ Reset()

◆ SendMessageBidJob()

◆ SendMessageSetProgress()

◆ SendMessageUnbidJob()

◆ Serialize()

◆ SetBidWindowOpen()

◆ SetPriority()

◆ SetProgress() [1/2]

◆ SetProgress() [2/2]

◆ SetWinnersMax()

◆ SetWinnersMin()

◆ Touch()

◆ TouchTime()

◆ UnbidJob()

◆ Update()

Member Data Documentation

◆ mBidders

◆ mData

◆ mDescription

◆ mManagerPtr

◆ mProgress