Description: A model is a set of items that defines a model to create in the back-end from the front-end. More...

Inheritance diagram for DtModelSetEntry:

Public Member Functions
	DtModelSetEntry ()
	default constructor
	DtModelSetEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtModelSetEntry (const DtModelSetEntry &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtModelSetEntry &	operator= (const DtModelSetEntry &orig)
	Assign to DtString. Assigns value only.
virtual	~DtModelSetEntry ()
virtual DtModelSetEntry *	clone ()
virtual const char *	readerWriterType ()
DtString	label () const
void	setLabel (const DtString &)
DtString	uniqueID () const
void	setUniqueID (const DtString &)
bool	canCreate () const
void	setCanCreate (bool)
bool	onOverlayPalette () const
void	setOnOverlayPalette (bool)
bool	canAggregate () const
void	setCanAggregate (bool)
void	setObjectType (const DtObjectType &)
DtObjectType	objectType () const
DtString	menuIcon () const
void	setMenuIcon (const DtString &)
void	setKeywords (const DtString &)
DtString	keywords () const
void	setForces (const DtRwForces &)
const DtRwForces &	forces () const
DtRwForces &	forces ()
void	setCategories (const DtRwNLengthStringVector &)
const DtRwNLengthStringVector &	categories () const
virtual bool	operator== (const DtModelSetEntry &) const
virtual bool	operator!= (const DtModelSetEntry &) const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtModelSetEntry *	create (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()

Protected Attributes
DtRwBoolean	myCanCreate
DtRwBoolean	myCanAggregate
DtRwBoolean	myOnOverlayPalette
DtRwString	myLabel
DtRwString	myUniqueID
DtRwString	myKeywords
DtRwString	myMenuIcon
DtRwObjectType	myObjectType
DtRwForces	myForces
DtRwNLengthStringVector	myCategories
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

Description: A model is a set of items that defines a model to create in the back-end from the front-end.

Constructor & Destructor Documentation

DtModelSetEntry::DtModelSetEntry ( )

default constructor

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

real constructor

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

copy constructor

virtual DtModelSetEntry::~DtModelSetEntry ( )

virtual

Member Function Documentation

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

Assign to DtString. Assigns value only.

virtual DtModelSetEntry* DtModelSetEntry::clone ( )

virtual

virtual const char* DtModelSetEntry::readerWriterType ( )

virtual

static DtModelSetEntry* DtModelSetEntry::create	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

static

DtString DtModelSetEntry::label ( ) const

inline

References myLabel.

void DtModelSetEntry::setLabel ( const DtString & s )

inline

References myLabel.

DtString DtModelSetEntry::uniqueID ( ) const

inline

References myUniqueID.

void DtModelSetEntry::setUniqueID ( const DtString & s )

inline

References myUniqueID.

bool DtModelSetEntry::canCreate ( ) const

inline

References myCanCreate.

void DtModelSetEntry::setCanCreate ( bool b )

inline

References myCanCreate.

bool DtModelSetEntry::onOverlayPalette ( ) const

inline

References myOnOverlayPalette.

void DtModelSetEntry::setOnOverlayPalette ( bool b )

inline

References myOnOverlayPalette.

bool DtModelSetEntry::canAggregate ( ) const

inline

References myCanAggregate.

void DtModelSetEntry::setCanAggregate ( bool b )

inline

References myCanAggregate.

void DtModelSetEntry::setObjectType ( const DtObjectType & o )

inline

References myObjectType.

DtObjectType DtModelSetEntry::objectType ( ) const

inline

References myObjectType.

DtString DtModelSetEntry::menuIcon ( ) const

inline

References myMenuIcon.

void DtModelSetEntry::setMenuIcon ( const DtString & s )

inline

References myMenuIcon.

void DtModelSetEntry::setKeywords ( const DtString & s )

inline

References myKeywords.

DtString DtModelSetEntry::keywords ( ) const

inline

References myKeywords.

void DtModelSetEntry::setForces ( const DtRwForces & f )

inline

References myForces.

const DtRwForces & DtModelSetEntry::forces ( ) const

inline

References myForces.

DtRwForces & DtModelSetEntry::forces ( )

inline

References myForces.

void DtModelSetEntry::setCategories ( const DtRwNLengthStringVector & c )

inline

References myCategories.

const DtRwNLengthStringVector & DtModelSetEntry::categories ( ) const

inline

References myCategories.

virtual bool DtModelSetEntry::operator== ( const DtModelSetEntry & ) const

virtual

virtual bool DtModelSetEntry::operator!= ( const DtModelSetEntry & ) const

virtual

Member Data Documentation

DtRwBoolean DtModelSetEntry::myCanCreate

protected

Referenced by canCreate(), and setCanCreate().

DtRwBoolean DtModelSetEntry::myCanAggregate

protected

Referenced by canAggregate(), and setCanAggregate().

DtRwBoolean DtModelSetEntry::myOnOverlayPalette

protected

Referenced by onOverlayPalette(), and setOnOverlayPalette().

DtRwString DtModelSetEntry::myLabel

protected

Referenced by label(), and setLabel().

DtRwString DtModelSetEntry::myUniqueID

protected

Referenced by setUniqueID(), and uniqueID().

DtRwString DtModelSetEntry::myKeywords

protected

Referenced by keywords(), and setKeywords().

DtRwString DtModelSetEntry::myMenuIcon

protected

Referenced by menuIcon(), and setMenuIcon().

DtRwObjectType DtModelSetEntry::myObjectType

protected

Referenced by objectType(), and setObjectType().

DtRwForces DtModelSetEntry::myForces

protected

Referenced by forces(), and setForces().

DtRwNLengthStringVector DtModelSetEntry::myCategories

protected

Referenced by categories(), and setCategories().

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

include/vrfutil/modelSetEntry.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation