Descriptor for a DtComponentSystem. Specified a system being added to an entity. This does not actually define what is in the system. For that, see DtComponentSystemDefinition.

Inheritance diagram for DtComponentSystemDescriptor:

[legend]

Public Types
typedef DtComponentSystemDescriptor (	ComponentSystemDescriptorCreatorFcn )(const DtString &)

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

Public Member Functions
	DtComponentSystemDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

virtual DtComponentSystemDescriptor &	operator= (const DtComponentSystemDescriptor &orig)

virtual	~DtComponentSystemDescriptor () override

virtual void	addVariableBindingsFromMetaData ()

virtual DtComponentSystemDescriptor *	clone () const

bool	operator== (const DtComponentSystemDescriptor &) const


virtual const DtComponentSystemDefinition *	systemDefinition () const

virtual DtComponentSystemDefinition *	systemDefinition ()

virtual void	resetSystemDefinition ()


virtual const DtReaderWriterFile &	systemDefinitionFile () const

virtual DtReaderWriterFile &	systemDefinitionFile ()

virtual void	setSystemDefinitionFile (const DtFilename &)


virtual bool	isEnabled () const

virtual void	setIsEnabled (bool yesNo)


virtual bool	canBeDisabled () const

virtual void	setCanBeDisabled (bool yesNo)


virtual bool	isTemplate () const

virtual void	setIsTemplate (bool yesNo)


virtual bool	partOfRollUp () const

virtual void	setPartOfRollUp (bool yesNo)


virtual void	setCompareSystemDefinition (bool)

bool	compareSystemDefinition () 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	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	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 ComponentSystemDescriptorCreatorFcn	SetCreator (ComponentSystemDescriptorCreatorFcn)

static DtComponentSystemDescriptor *	Create (const DtString &systemName)

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
virtual void	preGetSelf () override

virtual void	postGetSelf () override

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

Protected Attributes
DtReaderWriterFileExtensible	mySystemDefinitionFileName

DtRwBoolean	myIsEnabled

DtRwBoolean	myPartOfRollUp

DtComponentSystemDefinition *	mySystemDefinition

bool	myCompareSystemDefinition

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 ComponentSystemDescriptorCreatorFcn	theCreator

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

Member Typedef Documentation

typedef DtComponentSystemDescriptor*(* DtComponentSystemDescriptor::ComponentSystemDescriptorCreatorFcn)(const DtString &)

Constructor & Destructor Documentation

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

real constructor

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

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

copy constructor

virtual DtComponentSystemDescriptor::~DtComponentSystemDescriptor ( )

overridevirtual

Member Function Documentation

virtual DtComponentSystemDescriptor& DtComponentSystemDescriptor::operator= ( const DtComponentSystemDescriptor & orig )

virtual

assignment

virtual const DtComponentSystemDefinition* DtComponentSystemDescriptor::systemDefinition ( ) const

virtual

The definition of the system itself.

virtual DtComponentSystemDefinition* DtComponentSystemDescriptor::systemDefinition ( )

virtual

The definition of the system itself.

virtual void DtComponentSystemDescriptor::resetSystemDefinition ( )

virtual

The definition of the system itself.

virtual const DtReaderWriterFile& DtComponentSystemDescriptor::systemDefinitionFile ( ) const

virtual

The definition file.

virtual DtReaderWriterFile& DtComponentSystemDescriptor::systemDefinitionFile ( )

virtual

The definition file.

virtual void DtComponentSystemDescriptor::setSystemDefinitionFile ( const DtFilename & )

virtual

The definition file.

virtual void DtComponentSystemDescriptor::addVariableBindingsFromMetaData ( )

virtual

Adds variable bindings that might be found in the meta data to the variable bindings of this descriptor. This must be called if the variable bindings are to be added as this is not called as a function of loading the system definition file.

virtual bool DtComponentSystemDescriptor::isEnabled ( ) const

virtual

Should the system be enabled or disabled upon creation.

virtual void DtComponentSystemDescriptor::setIsEnabled ( bool yesNo )

virtual

Should the system be enabled or disabled upon creation.

virtual bool DtComponentSystemDescriptor::canBeDisabled ( ) const

virtual

Can the system be disabled. If this is a template system will return false all the time.

virtual void DtComponentSystemDescriptor::setCanBeDisabled ( bool yesNo )

virtual

Can the system be disabled. If this is a template system will return false all the time.

virtual bool DtComponentSystemDescriptor::isTemplate ( ) const

virtual

Is this a template system.

virtual void DtComponentSystemDescriptor::setIsTemplate ( bool yesNo )

virtual

Is this a template system.

virtual bool DtComponentSystemDescriptor::partOfRollUp ( ) const

virtual

Was added as part of roll-up. Any system that was added as part of a roll-up when the roll-up happens in the entity editor will be removed.

virtual void DtComponentSystemDescriptor::setPartOfRollUp ( bool yesNo )

virtual

Was added as part of roll-up. Any system that was added as part of a roll-up when the roll-up happens in the entity editor will be removed.

virtual DtComponentSystemDescriptor* DtComponentSystemDescriptor::clone ( ) const

virtual

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

virtual void DtComponentSystemDescriptor::setCompareSystemDefinition ( bool )

virtual

Accessor/mutator for myCompareSystemDefinition.

bool DtComponentSystemDescriptor::compareSystemDefinition ( ) const

Accessor/mutator for myCompareSystemDefinition.

static ComponentSystemDescriptorCreatorFcn DtComponentSystemDescriptor::SetCreator ( ComponentSystemDescriptorCreatorFcn )

static

Sets a creator for this class. Will be used by the component descriptor list to create this descriptor.

static DtComponentSystemDescriptor* DtComponentSystemDescriptor::Create ( const DtString & systemName )

static

virtual void DtComponentSystemDescriptor::preGetSelf ( )

overrideprotectedvirtual

Override to deal with system names so they get restored correctly.

Reimplemented from DtReaderWriter.

virtual void DtComponentSystemDescriptor::postGetSelf ( )

overrideprotectedvirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtReaderWriterFileExtensible DtComponentSystemDescriptor::mySystemDefinitionFileName

protected

DtRwBoolean DtComponentSystemDescriptor::myIsEnabled

protected

DtRwBoolean DtComponentSystemDescriptor::myPartOfRollUp

protected

DtComponentSystemDefinition* DtComponentSystemDescriptor::mySystemDefinition

protected

ComponentSystemDescriptorCreatorFcn DtComponentSystemDescriptor::theCreator

staticprotected

bool DtComponentSystemDescriptor::myCompareSystemDefinition

protected

Whether or not to walk the chain and compare included system definitions. Default is true.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/componentSystemDescriptor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation