DtEnvNamedList Class Reference

A specialization of a list which assigns the first value as a name. More...

Inheritance diagram for DtEnvNamedList:

Collaboration diagram for DtEnvNamedList:

Public Member Functions
virtual	~DtEnvNamedList ()
	DTOR. More...
virtual DtString	name () const
	Get the name of the list. More...
virtual void	setName (const DtString &name)
	Set the name of the list. More...
virtual DtEnvValueSP	first () const
	Get the first child in the list. More...
Public Member Functions inherited from DtEnvList
virtual DtEnvValueSP	last () const
	Get the last value in the list. More...
virtual DtEnvValueSP	next (DtEnvValueSP) const
	Get the next value after the value passed in. More...
Public Member Functions inherited from DtEnvValue
	DtEnvValue (const DtString &value)
virtual	~DtEnvValue ()
virtual DtString	value () const
	Get the object's value. More...
virtual DtString	unmodifiedValue () const
	Get the object's value without environmental expansion. More...
virtual void	setValue (const DtString &value)
	Sets the object's value. More...
virtual DtEnvValueSP	parent () const
	Get the parent of the object. More...
virtual void	setParent (DtEnvValueSP parent)
	Set the parent of the object. More...
DtEnvValueFormat	format () const
	Get the format of the object. More...

Static Public Member Functions
static bool	isNamedList (DtEnvValueSP)
	Check whether a value is a named list. More...
static DtEnvNamedList *	castToNamedList (DtEnvValueSP value)
	Cast the value to a named list. More...
Static Public Member Functions inherited from DtEnvList
static bool	isList (const DtEnvValueSP &)
	Check to see if a value is a list. More...
static DtEnvList *	castToList (const DtEnvValueSP &value)
	Cast a value to a list. More...

Protected Member Functions
	DtEnvNamedList (const DtString &name, const DtString &value)
virtual DtEnvValue *	clone () const
	Create a deep copy. More...
Protected Member Functions inherited from DtEnvList
	DtEnvList (const DtString &value)
	CTOR. More...
virtual void	cloneChildren (DtEnvList *list) const
	Duplicate children in object. More...
virtual void	append (DtEnvValueSP)
	Append a child into the list. More...
virtual void	remove (DtEnvValueSP)
	Remove a child from the list. More...
Protected Member Functions inherited from DtEnvValue
virtual void	valueChanged ()
virtual void	childChanged (DtEnvValue *)
void	addFormat (DtEnvValueFormat format)
	DtEnvValue (const DtString &value, DtEnvValueFormat format)

Friends
class	DtEnvironment

Additional Inherited Members
Public Types inherited from DtEnvValue
enum	DtEnvValueFormat {   Value = 0, Listed = 1, Named = RESERVED_VALUE(1), Typed = RESERVED_VALUE(2),   Native = RESERVED_VALUE(3), NamedListed = Named | Listed, NamedTypedListed = Named | Typed | Listed }
Protected Attributes inherited from DtEnvList
DtEnvValueList	myValues
	The list of values. More...
Protected Attributes inherited from DtEnvValue
DtEnvValueFormat	myFormat
DtEnvValueType	myValue
DtEnvValueType	myUnmodifiedValue
DtEnvValueWP	myParent

Detailed Description

A specialization of a list which assigns the first value as a name.

Constructor & Destructor Documentation

virtual DtEnvNamedList::~DtEnvNamedList ( )

virtual

DTOR.

DtEnvNamedList::DtEnvNamedList ( const DtString &  name, const DtString &  value  )

protected

Member Function Documentation

static DtEnvNamedList* DtEnvNamedList::castToNamedList ( DtEnvValueSP  value )

static

Cast the value to a named list.

Returns

Returns a null pointer if the value is not a named list.

virtual DtEnvValue* DtEnvNamedList::clone ( ) const

protectedvirtual

Create a deep copy.

Reimplemented from DtEnvList.

Reimplemented in DtEnvObject.

virtual DtEnvValueSP DtEnvNamedList::first ( ) const

virtual

Get the first child in the list.

Reimplemented from DtEnvList.

Reimplemented in DtEnvObject.

static bool DtEnvNamedList::isNamedList ( DtEnvValueSP  )

static

Check whether a value is a named list.

virtual DtString DtEnvNamedList::name ( ) const

virtual

Get the name of the list.

Reimplemented in DtEnvObject.

virtual void DtEnvNamedList::setName ( const DtString &  name )

virtual

Set the name of the list.

Reimplemented in DtEnvObject.

Friends And Related Function Documentation

friend class DtEnvironment

friend

---

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

• envNamedList.h