DtEnvObject Class Reference

The high level object specialization of a named list. More...

Inheritance diagram for DtEnvObject:

Collaboration diagram for DtEnvObject:

Public Member Functions
virtual DtString	type () const
virtual DtString	name () const
	Get the name of the list. More...
virtual DtEnvValueSP	first () const
	Get the first child in the list. More...
virtual void	setType (const DtString &type)
virtual void	setName (const DtString &type)
	Set the name of the list. More...
DtEnvValueSP	attribute (const DtString &name) const
DtString	attributeValue (const DtString &name) const
virtual DtEnvObjectSync *	sync () const
	Get sync object. More...
Public Member Functions inherited from DtEnvNamedList
virtual	~DtEnvNamedList ()
	DTOR. 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	isObject (DtEnvValueSP)
static bool	isObject (DtEnvValueSP, const DtString &type)
static bool	isObject (DtEnvValueSP, const DtString &name, const DtString &type)
static DtEnvObject *	castToObject (DtEnvValueSP)
Static Public Member Functions inherited from DtEnvNamedList
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 Types
typedef std::map< DtString, DtEnvValueWP >	DtEnvAttributeMap

Protected Member Functions
	DtEnvObject (const DtString &objName, const DtString &objType, const DtString &objValue)
virtual DtEnvValue *	clone () const
	Clone the DtEnvObject and its children, but not the DtEnvObjectSync. More...
virtual void	valueChanged ()
	Value changed callback, calls sync callback. More...
virtual void	childChanged (DtEnvValue *)
	Child value changed callback, calls sync callback. More...
virtual void	append (DtEnvValueSP)
	Append child value, calls sync callback. More...
virtual void	remove (DtEnvValueSP)
	Remove child value, calls sync callback. More...
virtual void	setSync (DtEnvObjectSync *sync)
	Set sync object, to remove, set to NULL. More...
Protected Member Functions inherited from DtEnvNamedList
	DtEnvNamedList (const DtString &name, const DtString &value)
Protected Member Functions inherited from DtEnvList
	DtEnvList (const DtString &value)
	CTOR. More...
virtual void	cloneChildren (DtEnvList *list) const
	Duplicate children in object. More...
Protected Member Functions inherited from DtEnvValue
void	addFormat (DtEnvValueFormat format)
	DtEnvValue (const DtString &value, DtEnvValueFormat format)

Protected Attributes
DtEnvAttributeMap	myAttributes
DtEnvObjectSync *	mySyncObject
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

Friends
class	DtEnvironment
class	DtEnvObjectSync

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 }

Detailed Description

The high level object specialization of a named list.

Member Typedef Documentation

typedef std::map<DtString,DtEnvValueWP> DtEnvObject::DtEnvAttributeMap

protected

Constructor & Destructor Documentation

DtEnvObject::DtEnvObject ( const DtString &  objName, const DtString &  objType, const DtString &  objValue  )

protected

Member Function Documentation

virtual void DtEnvObject::append ( DtEnvValueSP  )

protectedvirtual

Append child value, calls sync callback.

Reimplemented from DtEnvList.

DtEnvValueSP DtEnvObject::attribute

(

const DtString &

name

)

const

DtString DtEnvObject::attributeValue

(

const DtString &

name

)

const

static DtEnvObject* DtEnvObject::castToObject ( DtEnvValueSP  )

static

virtual void DtEnvObject::childChanged ( DtEnvValue *  )

protectedvirtual

Child value changed callback, calls sync callback.

Reimplemented from DtEnvValue.

virtual DtEnvValue* DtEnvObject::clone ( ) const

protectedvirtual

Clone the DtEnvObject and its children, but not the DtEnvObjectSync.

Reimplemented from DtEnvNamedList.

virtual DtEnvValueSP DtEnvObject::first ( ) const

virtual

Get the first child in the list.

Reimplemented from DtEnvNamedList.

static bool DtEnvObject::isObject ( DtEnvValueSP  )

static

static bool DtEnvObject::isObject ( DtEnvValueSP  , const DtString &  type  )

static

static bool DtEnvObject::isObject ( DtEnvValueSP  , const DtString &  name, const DtString &  type  )

static

virtual DtString DtEnvObject::name ( ) const

virtual

Get the name of the list.

Reimplemented from DtEnvNamedList.

virtual void DtEnvObject::remove ( DtEnvValueSP  )

protectedvirtual

Remove child value, calls sync callback.

Reimplemented from DtEnvList.

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

virtual

Set the name of the list.

Reimplemented from DtEnvNamedList.

virtual void DtEnvObject::setSync ( DtEnvObjectSync *  sync )

protectedvirtual

Set sync object, to remove, set to NULL.

virtual void DtEnvObject::setType ( const DtString &  type )

virtual

virtual DtEnvObjectSync* DtEnvObject::sync ( ) const

virtual

Get sync object.

virtual DtString DtEnvObject::type ( ) const

virtual

virtual void DtEnvObject::valueChanged ( )

protectedvirtual

Value changed callback, calls sync callback.

Reimplemented from DtEnvValue.

Friends And Related Function Documentation

friend class DtEnvironment

friend

friend class DtEnvObjectSync

friend

Member Data Documentation

DtEnvAttributeMap DtEnvObject::myAttributes

protected

DtEnvObjectSync* DtEnvObject::mySyncObject

protected

---

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

• envObject.h