DtResourceMonitorInfo Class Reference

Class: DtResourceMonitorInfo. More...

List of all members.

Public Member Functions
	DtResourceMonitorInfo ()
	DtResourceMonitorInfo (const DtResourceMonitorInfo &orig)
virtual	~DtResourceMonitorInfo ()
virtual DtResourceMonitorInfo &	operator= (const DtResourceMonitorInfo &)
void	setObjectIdentifier (const DtEntityIdentifier &id)
const DtEntityIdentifier &	objectIdentifier () const
virtual void	removeMonitorReference (const DtString &name, const DtSimulationAddress &addr)
virtual void	addMonitorReference (const DtString &resourceName, int iMonitorBy, const DtFloat64 &dMonitorPeriod, const DtSimulationAddress &addr, DtSimManager *manager)
const DtResourceCheckInfoList &	monitorResources () const
virtual void	removeAllMonitorReferencesTo (const DtSimulationAddress &simAddr)
	Removes all resources that are being monitored by the sender.
virtual std::list< DtString >	shouldPublishResources (double simTime, const DtString &echelonId, DtSimManager *simManager, bool force=false) const
	Returns a list of resources to publish based on the current sim time.
virtual void	setNextPublicationPeriod (double simTime, const DtString &echelonId, DtSimManager *manager, const std::list< DtString > &publishedResources)
	For each resource that is scheduled for publication, set up the next time the specified resource needs to be published.
Protected Attributes
DtEntityIdentifier	myObjectIdentifier
DtResourceCheckInfoList	myMonitorResources

---

Detailed Description

Class: DtResourceMonitorInfo.

Contains information about objects and resources to publish for those objects

---

Constructor & Destructor Documentation

DtResourceMonitorInfo::DtResourceMonitorInfo

(

)

[inline]

DtResourceMonitorInfo::DtResourceMonitorInfo

(

const DtResourceMonitorInfo &

orig

)

virtual DtResourceMonitorInfo::~DtResourceMonitorInfo

(

)

[inline, virtual]

---

Member Function Documentation

virtual DtResourceMonitorInfo& DtResourceMonitorInfo::operator=

(

const DtResourceMonitorInfo &

)

[virtual]

void DtResourceMonitorInfo::setObjectIdentifier

(

const DtEntityIdentifier &

id

)

[inline]

const DtEntityIdentifier& DtResourceMonitorInfo::objectIdentifier

(

)

const [inline]

virtual void DtResourceMonitorInfo::removeMonitorReference	(	const DtString &	name,
		const DtSimulationAddress &	addr
	)		[virtual]

virtual void DtResourceMonitorInfo::addMonitorReference	(	const DtString &	resourceName,
		int	iMonitorBy,
		const DtFloat64 &	dMonitorPeriod,
		const DtSimulationAddress &	addr,
		DtSimManager *	manager
	)		[virtual]

const DtResourceCheckInfoList& DtResourceMonitorInfo::monitorResources

(

)

const [inline]

virtual void DtResourceMonitorInfo::removeAllMonitorReferencesTo

(

const DtSimulationAddress &

simAddr

)

[virtual]

Removes all resources that are being monitored by the sender.

If there are no requestors left for the specified resource, the resourec is removed from tracking

virtual std::list<DtString> DtResourceMonitorInfo::shouldPublishResources	(	double	simTime,
		const DtString &	echelonId,
		DtSimManager *	simManager,
		bool	force = false
	)		const [virtual]

Returns a list of resources to publish based on the current sim time.

Note that sim time might be only one of the variables used, which is why the sim manager is also passed into this routine. The return value is a list of resources to publish

virtual void DtResourceMonitorInfo::setNextPublicationPeriod	(	double	simTime,
		const DtString &	echelonId,
		DtSimManager *	manager,
		const std::list< DtString > &	publishedResources
	)		[virtual]

For each resource that is scheduled for publication, set up the next time the specified resource needs to be published.

---

Member Data Documentation

DtEntityIdentifier DtResourceMonitorInfo::myObjectIdentifier [protected]

DtResourceCheckInfoList DtResourceMonitorInfo::myMonitorResources [protected]

---

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

• include/vrfobjcore/resourceMonitorInfo.h