DtTargetPriorityList Class Reference

DtTargetPriorityList is a readable/writable list of DtTargetPriorityEntrys. More...

Inheritance diagram for DtTargetPriorityList:

Public Member Functions
	DtTargetPriorityList ()
	DtTargetPriorityList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtTargetPriorityList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtTargetPriorityList (const DtString &name, const DtTargetPriorityList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtTargetPriorityList (const DtSymbolString &name, const DtTargetPriorityList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtTargetPriorityList (const DtTargetPriorityList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtTargetPriorityList &	operator= (const DtTargetPriorityList &orig)
virtual	~DtTargetPriorityList ()
	destructor
virtual DtTargetPriorityList *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtTargetPriorityList *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtTargetPriorityEntry *	addTargetPriorityEntry (const DtTargetPriorityEntry &priEntry)
	Adds a target priority entry.
virtual DtTargetPriorityEntry *	addTargetPriorityEntry (const DtEntityType &priEntry)
virtual int	priority (const DtEntityType &entityType, DtEntityType *bestMatch=NULL) const
	Returns the priority of the entity specified.
virtual DtListItem *	lookupTargetPriorityEntry (const DtEntityType &entityType) const
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
	Add element to the list just after the indicated item.
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	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 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.

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates the DtTargetPriorityEntry, reads it, and adds it to the list.
void	emptyList ()
	Non-virtual because it is called from constructor/destructor.
void	copyList (const DtTargetPriorityList &orig)
	Non-virtual because it is called from constructor/destructor.
virtual DtTargetPriorityEntry *	addTargetPriorityEntry (DtTargetPriorityEntry *priEntry)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
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.

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
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 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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

DtTargetPriorityList is a readable/writable list of DtTargetPriorityEntrys.

It's sorted by the entity type in the entry, and will return a priority based on the best match found for the entity type indicated.

Constructor & Destructor Documentation

DtTargetPriorityList::DtTargetPriorityList

(

)

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

constructor with parameters to set up read/writability correctly

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

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

copy constructor

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

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

virtual DtTargetPriorityList::~DtTargetPriorityList ( )

virtual

destructor

Member Function Documentation

const DtTargetPriorityList& DtTargetPriorityList::operator=

(

const DtTargetPriorityList &

orig

)

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

virtual

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

virtual

virtual DtTargetPriorityEntry* DtTargetPriorityList::addTargetPriorityEntry ( const DtTargetPriorityEntry &  priEntry )

virtual

Adds a target priority entry.

List is kept in ascending order (by the entity type specified in the entry).

virtual DtTargetPriorityEntry* DtTargetPriorityList::addTargetPriorityEntry ( const DtEntityType &  priEntry )

virtual

virtual int DtTargetPriorityList::priority ( const DtEntityType &  entityType, DtEntityType *  bestMatch = NULL  ) const

virtual

Returns the priority of the entity specified.

If no match is found, -1 is returned.

virtual DtListItem* DtTargetPriorityList::lookupTargetPriorityEntry ( const DtEntityType &  entityType ) const

virtual

virtual DtlObjPtr DtTargetPriorityList::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

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

Implements DtRwList.

void DtTargetPriorityList::emptyList ( )

protected

Non-virtual because it is called from constructor/destructor.

void DtTargetPriorityList::copyList ( const DtTargetPriorityList &  orig )

protected

Non-virtual because it is called from constructor/destructor.

virtual DtTargetPriorityEntry* DtTargetPriorityList::addTargetPriorityEntry ( DtTargetPriorityEntry *  priEntry )

protectedvirtual

virtual const char* DtTargetPriorityList::readerWriterType ( ) const

protectedvirtual

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.

---

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

• include/vrfobjparam/tgtPriList.h