DtVrfSubObjectParameterList is a readable/writable list of DtVrfSubObjectParameterEntrys.

Inheritance diagram for DtVrfSubObjectParameterList:

Classes
struct	SubordinateAdder

Public Member Functions
	DtVrfSubObjectParameterList (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)

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

	DtVrfSubObjectParameterList (const DtVrfSubObjectParameterList &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)

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

const DtVrfSubObjectParameterList &	operator= (const DtVrfSubObjectParameterList &orig)

virtual	~DtVrfSubObjectParameterList () override

virtual DtVrfSubObjectParameterList *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const

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

virtual DtVrfSubObjectParameterEntry *	addSubObjectEntry (const DtVrfSubObjectParameterEntry &subEntry)

virtual void	removeSubObjectEntry (const DtVrfSubObjectParameterEntry *subEntry)

bool	operator== (const DtVrfSubObjectParameterList &) const

bool	operator!= (const DtVrfSubObjectParameterList &) const

virtual const char *	readerWriterType () const override

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

virtual std::vector< DtEntityType >	subordinateObjects () const

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList () override

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

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

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset () override

bool	operator== (const DtRwList &rhs) const

bool	operator!= (const DtRwList &rhs) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

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

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

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

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	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 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 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	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 Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual void	emptyList ()

virtual void	copyList (const DtVrfSubObjectParameterList &orig)

virtual DtVrfSubObjectParameterEntry *	addSubObjectEntry (DtVrfSubObjectParameterEntry *subEntry)

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

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

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual const char *	xmlType () const override

virtual std::set< DtString >	supportedXmlTypes () const override

static const char *	theXmlType ()

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 DtRwList
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 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 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

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

constructor with parameters to set up read/writability correctly

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

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

copy constructor

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

virtual DtVrfSubObjectParameterList::~DtVrfSubObjectParameterList ( )

overridevirtual

destructor

Member Function Documentation

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

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

virtual

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

virtual

virtual DtVrfSubObjectParameterEntry* DtVrfSubObjectParameterList::addSubObjectEntry ( const DtVrfSubObjectParameterEntry & subEntry )

virtual

virtual void DtVrfSubObjectParameterList::removeSubObjectEntry ( const DtVrfSubObjectParameterEntry * subEntry )

virtual

Removes the specified subEntry from the list, if it is on the list.

Note: : Does not delete the entry iteself. Caller is now responsible for deletion of this object.

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

Equivalence operator.

bool DtVrfSubObjectParameterList::operator!= ( const DtVrfSubObjectParameterList & ) const

virtual const char* DtVrfSubObjectParameterList::readerWriterType ( ) const

overridevirtual

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 DtRwList.

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

overridevirtual

from parent to ensure list is clear before getting self

Reimplemented from DtRwList.

virtual void DtVrfSubObjectParameterList::getData	(	const DtEnvironmentSP	,
		const DtEnvValueSP	value,
		const DtReaderWriter::SearchPaths &	searchPaths = `DtReaderWriter::SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

static const char* DtVrfSubObjectParameterList::theXmlType ( )

static

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

virtual const char* DtVrfSubObjectParameterList::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

References DtRwList::theXmlType().

virtual std::set<DtString> DtVrfSubObjectParameterList::supportedXmlTypes ( ) const

overridevirtual

Returns the list of xml types supported by this list. Default is DtXMLVrfSubObjectParameterEntryType.

Reimplemented from DtRwList.

virtual std::vector<DtEntityType> DtVrfSubObjectParameterList::subordinateObjects ( ) const

virtual

Returns subordinate objects only in this list (each entry generates one item, so, there could be duplicates)

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

overrideprotectedvirtual

Creates the DtVrfSubObjectParameterEntry, reads it, and adds it to the list.

Implements DtRwList.

virtual void DtVrfSubObjectParameterList::emptyList ( )

protectedvirtual

virtual void DtVrfSubObjectParameterList::copyList ( const DtVrfSubObjectParameterList & orig )

protectedvirtual

virtual DtVrfSubObjectParameterEntry* DtVrfSubObjectParameterList::addSubObjectEntry ( DtVrfSubObjectParameterEntry * subEntry )

protectedvirtual

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

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

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation