DtSimResource is an abstract base class that can be used to create a hierarchical resource list of a type specified by the deriving class.

The deriving class must provide an implementation of getData that knows how to create the right kind of resource when reading from a file. It also must provide implementations of updateAmountFromChildren(), which determines the amount of this resource by summing up from any child resources, and distributeAmountToChildren().

Inheritance diagram for DtSimResource:

[legend]

Public Member Functions
virtual	~DtSimResource ()

virtual bool	init ()

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

virtual void	addChildResource (DtSimResource *resource)

virtual bool	removeChildResource (DtSimResource *resource)

virtual void	copyResource (const DtSimResource &orig)

virtual void	updateAmountFromChildren ()=0

virtual void	updateFullAmountFromChildren ()=0

virtual void	distributeAmountToChildren ()=0

virtual void	distributeFullAmountToChildren ()=0

virtual DtReal	percentageFull () const =0

virtual void	setPercentageFull (DtReal percent)=0

virtual DtString	type () const =0

virtual DtSimResource *	clone (DtReaderWriterRegistry *parentRegistry=0) const =0

virtual void	setResourceManager (DtSimResourceManager *resourceManager)

virtual DtSimResourceManager *	resourceManager ()

virtual const DtSimResourceManager *	resourceManager () const

virtual DtSimResourceList *	subresources ()

virtual const DtSimResourceList *	subresources () const

virtual void	setParent (DtSimResource *parent)

virtual DtSimResource *	parent ()

virtual const DtSimResource *	parent () const

virtual const char *	readerWriterType () const

virtual bool	isEqual (const DtSimResource &res) const

bool	operator!= (const DtSimResource &orig) const

bool	operator== (const DtSimResource &orig) const

virtual void	merge (const DtSimResource *)

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)

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 const char *	xmlType () const

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	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

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 DtSimResource *	createResource (DtlObjPtr mtlStream, const DtVariableBindingsList &variableBindings)

static void	addResourceCreatorFcn (const DtString &type, DtSimResourceCreatorFcn fcn)

static void	addResourceCreatorFcn (const DtSymbolString &type, DtSimResourceCreatorFcn fcn)

static void	setFactory (DtSimResourceFactory *factory)

static DtSimResourceFactory *	factory ()

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 Member Functions
	DtSimResource ()

	DtSimResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtSimResource (const DtSymbolString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtSimResource (const DtSimResource &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtSimResource &	operator= (const DtSimResource &orig)

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

Protected Attributes
DtSimResourceManager *	myResourceManager

DtSimResourceList	mySubresources

DtSimResource *	myParent

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

Static Protected Attributes
static DtSimResourceFactory *	myFactory

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

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 )()

Constructor & Destructor Documentation

DtSimResource::DtSimResource ( )

protected

default constructor

DtSimResource::DtSimResource	(	const DtString &	resourceName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

protected

real constructor

The resource name is the name that will be used to look up the resource in the resource manager.

DtSimResource::DtSimResource	(	const DtSymbolString &	resourceName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

protected

DtSimResource::DtSimResource	(	const DtSimResource &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

protected

copy constructor The copy constructor only calls down to the base class copy constructor. It does not copy the mySubresources member. Derived classes must do this in their copy constructor implementations as follows:

mySubresources.setParent(this); mySubresources.copyList(orig.mySubresources, parentRegistry);

virtual DtSimResource::~DtSimResource ( )

virtual

destructor

Member Function Documentation

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

protected

assignment operator

virtual bool DtSimResource::init ( )

virtual

Base class version just returns true, but this will be called by the createResource call so that deriving classes can do virtual allocation if need be.

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

virtual

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual void DtSimResource::addChildResource ( DtSimResource * resource )

virtual

virtual bool DtSimResource::removeChildResource ( DtSimResource * resource )

virtual

Removes the specified resource from this resource's subresource list, or from the subresources of any of those resources. Does not delete the resource.

Returns: True if the resource was found and removed.

virtual void DtSimResource::copyResource ( const DtSimResource & orig )

virtual

virtual void DtSimResource::updateAmountFromChildren ( )

pure virtual

When the deriving class's setAmount is called, this should be called on the resources parent.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::updateFullAmountFromChildren ( )

pure virtual

When the deriving class's setFullAmount is called, this should be called on the resources parent.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::distributeAmountToChildren ( )

pure virtual

When the deriving class's setAmount is called, this should be called if the resource has any children.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::distributeFullAmountToChildren ( )

pure virtual

When the deriving class's setFullAmount is called, this should be called if the resource has any children.

Implemented in DtRealResource, and DtIntegerResource.

virtual DtReal DtSimResource::percentageFull ( ) const

pure virtual

The deriving class will also provide a function to specify the quantity (of the appropriate type) that indicates a full/complete load of the resource. PercentageFull will return 0. to 1., amount / fullAmount Note: 1. is returned if full amount is <= 0.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::setPercentageFull ( DtReal percent )

pure virtual

Percent will be truncated to be between 0. and 1.

Implemented in DtRealResource, and DtIntegerResource.

virtual DtString DtSimResource::type ( ) const

pure virtual

The data type of the resource. These types are defined in rsrcTypes.h.

Implemented in DtRealResource, DtIntegerResource, and DtMunitionResource.

Referenced by DtMunitionResourceIterator::firstMatch().

virtual DtSimResource* DtSimResource::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

pure virtual

Implemented in DtRealResource, DtIntegerResource, and DtMunitionResource.

virtual void DtSimResource::setResourceManager ( DtSimResourceManager * resourceManager )

virtual

virtual DtSimResourceManager* DtSimResource::resourceManager ( )

virtual

virtual const DtSimResourceManager* DtSimResource::resourceManager ( ) const

virtual

virtual DtSimResourceList* DtSimResource::subresources ( )

virtual

Accessor to this resource's subresources.

Referenced by DtRecursiveResourceIterator::next().

virtual const DtSimResourceList* DtSimResource::subresources ( ) const

virtual

virtual void DtSimResource::setParent ( DtSimResource * parent )

virtual

The parent pointer is actually kept in the subresources list, since it needs it as well.

virtual DtSimResource* DtSimResource::parent ( )

virtual

virtual const DtSimResource* DtSimResource::parent ( ) const

virtual

static DtSimResource* DtSimResource::createResource	(	DtlObjPtr	mtlStream,
		const DtVariableBindingsList &	variableBindings
	)

static

static void DtSimResource::addResourceCreatorFcn	(	const DtString &	type,
		DtSimResourceCreatorFcn	fcn
	)

static

static void DtSimResource::addResourceCreatorFcn	(	const DtSymbolString &	type,
		DtSimResourceCreatorFcn	fcn
	)

static

static void DtSimResource::setFactory ( DtSimResourceFactory * factory )

static

static DtSimResourceFactory* DtSimResource::factory ( )

static

virtual const char* DtSimResource::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.

Reimplemented in DtMunitionResource.

virtual bool DtSimResource::isEqual ( const DtSimResource & res ) const

virtual

Reimplemented in DtRealResource, and DtIntegerResource.

bool DtSimResource::operator!= ( const DtSimResource & orig ) const

inline

Expects subclasses to implement isEqual method. Default returns false.

bool DtSimResource::operator== ( const DtSimResource & orig ) const

virtual void DtSimResource::merge ( const DtSimResource * )

virtual

Reimplemented in DtRealResource, and DtIntegerResource.

Member Data Documentation

DtSimResourceManager* DtSimResource::myResourceManager

protected

DtSimResourceList DtSimResource::mySubresources

protected

DtSimResource* DtSimResource::myParent

protected

DtSimResourceFactory* DtSimResource::myFactory

staticprotected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation