The DtRwPlanVariable is a base class that minimally implements a plan variable. Subclasses will implement the containers of what thos values should be.

Inheritance diagram for DtRwPlanVariable:

[legend]

Public Member Functions
	DtRwPlanVariable (const DtString &name, const DtRwTranslatableStringObject &title, DtReaderWriterRegistry *const parentRegistry=0)

	DtRwPlanVariable (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)

	DtRwPlanVariable (const DtString &name, const DtRwPlanVariable &, DtReaderWriterRegistry *const parentRegistry=0)

	DtRwPlanVariable (const DtRwPlanVariable &, DtReaderWriterRegistry *const parentRegistry=0)

virtual	~DtRwPlanVariable ()

void	setTitle (const DtRwTranslatableStringObject &)

const DtRwTranslatableStringObject &	title () const

virtual DtString	markingText () const

DtRwPlanVariable &	operator= (const DtRwUUID &orig)

DtRwPlanVariable &	operator= (const DtRwPlanVariable &orig)

bool	operator!= (const DtRwPlanVariable &orig) const

bool	operator== (const DtRwPlanVariable &orig) const

Public Member Functions inherited from DtRwUUID
	DtRwUUID ()

	DtRwUUID (const char name, DtReaderWriterRegistry const parentRegistry=0)

	DtRwUUID (const DtString &name, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtString &name, const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtSymbolString &name, const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtSymbolString &name, const DtUUID &, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtString &name, const DtUUID &, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtString &name, const char , DtReaderWriterRegistry const parentRegistry)

	DtRwUUID (const DtSymbolString &name, const char , DtReaderWriterRegistry const parentRegistry)

	DtRwUUID (const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)

	DtRwUUID (const DtRwUUID &)

	DtRwUUID (const DtUUID &)

virtual	~DtRwUUID ()

virtual const char *	readerWriterType () const

virtual void	setMarkingText (const DtString &)

	operator const DtUUID & () const

DtRwUUID &	operator= (const DtRwUUID &orig)

DtRwUUID &	operator= (const DtUUID &orig)

bool	operator!= (const DtRwUUID &orig) const

bool	operator== (const DtRwUUID &orig) const

bool	operator< (const DtRwUUID &rhs) const

bool	operator> (const DtRwUUID &rhs) const

virtual const char *	xmlType () const

const DtUUID &	uuid () const

DtUUID &	uuid ()

virtual void	clearUUID ()

virtual DtString	uuidString () const

virtual bool	isValid () const

virtual void	generateUUID ()

virtual void	setUUID (const DtRwUUID &u)

virtual void	setUUID (const DtString &uuid)

virtual void	setStringUUID (const DtString &uuid)

bool	isVrfUUID () const

const char *	data () const

unsigned int	dataSize () const

void	setBuffer (const char *)

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

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

virtual void	getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &varBindings=DtVariableBindingsList())

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

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

virtual void	putSelf (DtEnvironmentSP env, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

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

virtual DtString	prettyPrint () 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)

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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

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 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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
DtRwTranslatableStringObject	myTitle

Protected Attributes inherited from DtRwUUID
DtUUID	myUUID

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

Static Public Member Functions inherited from DtRwUUID
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 Member Functions inherited from DtRwUUID
virtual void	noRwValueSpecified ()

virtual void	uuidChanged ()

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

DtRwPlanVariable::DtRwPlanVariable	(	const DtString &	name,
		const DtRwTranslatableStringObject &	title,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

CTOR. In order to create a UUID call generateUUID.

DtRwPlanVariable::DtRwPlanVariable	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

DtRwPlanVariable::DtRwPlanVariable	(	const DtString &	name,
		const DtRwPlanVariable &	,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

Copy constructors.

DtRwPlanVariable::DtRwPlanVariable	(	const DtRwPlanVariable &	,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

virtual DtRwPlanVariable::~DtRwPlanVariable ( )

virtual

Member Function Documentation

void DtRwPlanVariable::setTitle ( const DtRwTranslatableStringObject & )

const DtRwTranslatableStringObject& DtRwPlanVariable::title ( ) const

inline

virtual DtString DtRwPlanVariable::markingText ( ) const

virtual

Returns the translatable string.

Reimplemented from DtRwUUID.

DtRwPlanVariable& DtRwPlanVariable::operator= ( const DtRwUUID & orig )

inline

References DtRwUUID::operator=().

Referenced by DtRwPlanSimulationObject::operator=().

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

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

inline

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

Member Data Documentation

DtRwTranslatableStringObject DtRwPlanVariable::myTitle

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation