DtEnvObject Class Reference

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

Inheritance diagram for DtEnvObject:

Collaboration diagram for DtEnvObject:

List of all members.

Public Member Functions
virtual DtString	type () const
virtual DtString	name () const
	Get the name of the list.
virtual DtEnvValueSP	first () const
	Get the first child in the list.
virtual void	setType (const DtString &type)
virtual void	setName (const DtString &type)
	Set the name of the list.
DtEnvValueSP	attribute (const DtString &name) const
DtString	attributeValue (const DtString &name) const
virtual DtEnvObjectSync *	sync () const
	Get sync object.
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)
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.
virtual void	valueChanged ()
	Value changed callback, calls sync callback.
virtual void	childChanged (DtEnvValue *)
	Child value changed callback, calls sync callback.
virtual void	append (DtEnvValueSP)
	Append child value, calls sync callback.
virtual void	remove (DtEnvValueSP)
	Remove child value, calls sync callback.
virtual void	setSync (DtEnvObjectSync *sync)
	Set sync object, to remove, set to NULL.
Protected Attributes
DtEnvAttributeMap	myAttributes
DtEnvObjectSync *	mySyncObject
Friends
class	DtEnvironment
class	DtEnvObjectSync

---

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

)

[protected, virtual]

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 *

)

[protected, virtual]

Child value changed callback, calls sync callback.

Reimplemented from DtEnvValue.

virtual DtEnvValue* DtEnvObject::clone

(

)

const [protected, virtual]

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

)

[protected, virtual]

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

)

[protected, virtual]

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

(

)

[protected, virtual]

Value changed callback, calls sync callback.

Reimplemented from DtEnvValue.

---

Friends And Related Function Documentation

friend class DtEnvironment [friend]

Reimplemented from DtEnvNamedList.

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