File: setResource.h.

Class: DtSetResourceRequest DtSetResourceRequest is used to set a resource value for an entity. It inherits read/writableness from DtSetDataRequest, and includes the name of the resource and the value to set it to.

set-data-request-type: DtSetResourceRequestType

parameters: resource name - String name of the resource to be set. The list of resource types supported in VR-Forces is in resource- Types.h.

resource value - The value of the resource (a real number).

Inheritance diagram for DtSetResourceRequest:

[legend]

Public Member Functions
	DtSetResourceRequest ()

	DtSetResourceRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtSetResourceRequest (const DtString &writeName, const DtSetResourceRequest &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtSetResourceRequest &	operator= (const DtSetResourceRequest &orig)

virtual	~DtSetResourceRequest () override

virtual const DtSetMessageType &	type () const override

virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const override

virtual DtString	stringRep () const override

virtual const DtEntityType &	resourceType () const

const DtEntityType &	resourceName () const

virtual void	setResourceType (const DtEntityType &resource)

void	setResourceName (const DtEntityType &resource)

virtual DtReal	resourceValue () const

virtual void	setResourceValue (DtReal value)

virtual int	netRepSize () const override

virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override

virtual bool	setToNet () override

virtual void	setBin (int)

virtual int	bin () const

Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest () override

virtual bool	init ()

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

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

virtual char *	netRep ()

virtual bool	isOneClick () const

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

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

virtual bool	peekChangedSinceLastChecked () const

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 DtSetDataRequest *	creator ()

Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)

static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)

static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)

static void	setFactory (DtSetDataRequestFactory *factory)

static DtSetDataRequestFactory *	factory ()

static bool	isTypeRegistered (DtSetMessageType setDataType)

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
DtRwResource	myResourceName

DtRwReal	myResourceValue

DtRwInt	myBin

Protected Attributes inherited from DtSetDataRequest
char *	myNetRep

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

	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)

virtual char *	createNetworkBuffer ()

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

Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	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

Constructor & Destructor Documentation

DtSetResourceRequest::DtSetResourceRequest ( )

default constructor

DtSetResourceRequest::DtSetResourceRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetResourceRequest::DtSetResourceRequest	(	const DtString &	writeName,
		const DtSetResourceRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

virtual DtSetResourceRequest::~DtSetResourceRequest ( )

overridevirtual

Member Function Documentation

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

assignment operator

virtual const DtSetMessageType& DtSetResourceRequest::type ( ) const

overridevirtual

Returns "set-resource".

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetResourceRequest::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

overridevirtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetResourceRequest::stringRep ( ) const

overridevirtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtEntityType& DtSetResourceRequest::resourceType ( ) const

virtual

The list of resource types supported is in resourceTypes.h.

const DtEntityType& DtSetResourceRequest::resourceName ( ) const

inline

virtual void DtSetResourceRequest::setResourceType ( const DtEntityType & resource )

virtual

void DtSetResourceRequest::setResourceName ( const DtEntityType & resource )

inline

virtual DtReal DtSetResourceRequest::resourceValue ( ) const

virtual

virtual void DtSetResourceRequest::setResourceValue ( DtReal value )

virtual

virtual int DtSetResourceRequest::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetResourceRequest::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)

overridevirtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetResourceRequest::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

virtual void DtSetResourceRequest::setBin ( int )

virtual

If this resource appears in more than one bin (location) then specify the bin to update the resource from. Default is 0.

virtual int DtSetResourceRequest::bin ( ) const

virtual

static DtSetDataRequest* DtSetResourceRequest::creator ( )

static

Member Data Documentation

DtRwResource DtSetResourceRequest::myResourceName

protected

DtRwReal DtSetResourceRequest::myResourceValue

protected

DtRwInt DtSetResourceRequest::myBin

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrftasks/setResourceRequest.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation