DtSupplyEntry is a readable/writable triplet of supply's entity type, resource name and maximum transfer rate. It describes the list of supplies that can be transferred between entities. It is used to define the list of supplies in both Receiver and Supplier controllers' descriptor classes

Inheritance diagram for DtSupplyEntry:

[legend]

Public Member Functions
	DtSupplyEntry ()

	DtSupplyEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtSupplyEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtSupplyEntry (const DtSupplyEntry &orig)

	DtSupplyEntry (const DtString &name, const DtSupplyEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtSupplyEntry (const DtSymbolString &name, const DtSupplyEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)

const DtSupplyEntry &	operator= (const DtSupplyEntry &orig)

virtual	~DtSupplyEntry ()

virtual DtSupplyEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtSupplyEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

bool	operator== (const DtSupplyEntry &) const

bool	operator!= (const DtSupplyEntry &rhs) const


virtual const DtEntityType &	supplyType () const

virtual void	setSupplyType (const DtEntityType &type)


virtual const DtString &	internalName () const

virtual void	setInternalName (const DtString &internalName)


virtual const double	maxRate () const

virtual void	setMaxRate (const double rate)

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
parameters
These parameters are available for setting in the sysdef files.
DtRwEntityType	mySupplyType

DtRwString	myInternalName

DtRwReal	myMaxRate

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtSupplyEntry::DtSupplyEntry ( )

default constructor

DtSupplyEntry::DtSupplyEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

real constructor

DtSupplyEntry::DtSupplyEntry	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtSupplyEntry::DtSupplyEntry ( const DtSupplyEntry & orig )

copy constructor

DtSupplyEntry::DtSupplyEntry	(	const DtString &	name,
		const DtSupplyEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtSupplyEntry::DtSupplyEntry	(	const DtSymbolString &	name,
		const DtSupplyEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtSupplyEntry::~DtSupplyEntry ( )

virtual

Member Function Documentation

const DtSupplyEntry& DtSupplyEntry::operator= ( const DtSupplyEntry & orig )

assignment operator

virtual DtSupplyEntry* DtSupplyEntry::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual DtSupplyEntry* DtSupplyEntry::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual const DtEntityType& DtSupplyEntry::supplyType ( ) const

virtual

Accessor/mutator for #myType.

virtual void DtSupplyEntry::setSupplyType ( const DtEntityType & type )

virtual

Accessor/mutator for #myType.

virtual const DtString& DtSupplyEntry::internalName ( ) const

virtual

Accessor/mutator for myInternalName.

virtual void DtSupplyEntry::setInternalName ( const DtString & internalName )

virtual

Accessor/mutator for myInternalName.

virtual const double DtSupplyEntry::maxRate ( ) const

virtual

Accessor/mutator for myMaxRate.

virtual void DtSupplyEntry::setMaxRate ( const double rate )

virtual

Accessor/mutator for myMaxRate.

virtual const char* DtSupplyEntry::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

static const char* DtSupplyEntry::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtSupplyEntry::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

bool DtSupplyEntry::operator== ( const DtSupplyEntry & ) const

bool DtSupplyEntry::operator!= ( const DtSupplyEntry & rhs ) const

inline

Member Data Documentation

DtRwEntityType DtSupplyEntry::mySupplyType

protected

Parameter Name: supply-type
Parameter Description: DIS/RPR entity type enumeration representing the kind of supply that can be transferred.
.

DtRwString DtSupplyEntry::myInternalName

protected

Parameter Name: internal-name
Parameter Description: The resource name of the supply.
.

DtRwReal DtSupplyEntry::myMaxRate

protected

Parameter Name: max-rate
Parameter Description: The maximum rate at which the supply can be transferred.
.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/supplyEntry.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation