DtConnectionDescriptorList Class Reference

Instances of DtConnectionDescriptorList are readable/writeable lists of DtConnectionDescriptor objects. More...

Inheritance diagram for DtConnectionDescriptorList:

List of all members.

Public Member Functions
	DtConnectionDescriptorList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtConnectionDescriptorList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtConnectionDescriptorList (const DtConnectionDescriptorList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtConnectionDescriptorList &	operator= (const DtConnectionDescriptorList &orig)
	Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.
virtual	~DtConnectionDescriptorList ()
	destructor
virtual DtConnectionDescriptorList *	clone (DtReaderWriterRegistry *parentRegistry=NULL)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	emptyList ()
	Removes all descriptors from the list, and destroys them.
virtual void	copyList (const DtConnectionDescriptorList &orig)
virtual DtConnectionDescriptor *	addConnectionDescriptor (const DtConnectionDescriptor &descriptor)
virtual DtConnectionDescriptor *	addConnection (const DtString &source, const DtString &destination)
virtual DtConnectionDescriptor *	findConnection (const DtString &source, const DtString &destination)
virtual bool	removeConnection (const DtString &source, const DtString &destination)
	Removes all connection descriptors that are equivalent to this the source and destination specified.
virtual bool	removeAllConnectionsFrom (const DtString &source)
	Removes all connections that match the specified source and any destination.
virtual bool	removeAllConnectionsTo (const DtString &destination)
	Removes all connections that match the specified destination and any source.
virtual bool	removeConnections (const std::list< DtConnectionDescriptor * > removeList)
	Removes and deleted all the connections specified in the list.
virtual bool	removeConnection (DtConnectionDescriptor *connection)
	Removes and deletes the specified connection.
virtual void	removeAll ()
	Remomves all connections and clears out memory.
Protected Member Functions
	DtConnectionDescriptorList ()
	default constructor
virtual DtConnectionDescriptor *	addConnectionDescriptor (DtConnectionDescriptor *descriptor)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a DtConnectionDescriptor item, retrieves it from the mtl stream, and then adds it to the list.

---

Detailed Description

Instances of DtConnectionDescriptorList are readable/writeable lists of DtConnectionDescriptor objects.

---

Constructor & Destructor Documentation

DtConnectionDescriptorList::DtConnectionDescriptorList

(

)

[protected]

default constructor

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

constructor

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

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

copy constructor

virtual DtConnectionDescriptorList::~DtConnectionDescriptorList

(

)

[virtual]

destructor

---

Member Function Documentation

DtConnectionDescriptorList& DtConnectionDescriptorList::operator=

(

const DtConnectionDescriptorList &

orig

)

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

virtual DtConnectionDescriptorList* DtConnectionDescriptorList::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

[virtual]

virtual const char* DtConnectionDescriptorList::readerWriterType

(

)

const [virtual]

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.

virtual void DtConnectionDescriptorList::emptyList

(

)

[virtual]

Removes all descriptors from the list, and destroys them.

virtual void DtConnectionDescriptorList::copyList

(

const DtConnectionDescriptorList &

orig

)

[virtual]

virtual DtConnectionDescriptor* DtConnectionDescriptorList::addConnectionDescriptor

(

const DtConnectionDescriptor &

descriptor

)

[virtual]

virtual DtConnectionDescriptor* DtConnectionDescriptorList::addConnection	(	const DtString &	source,
		const DtString &	destination
	)		[virtual]

virtual DtConnectionDescriptor* DtConnectionDescriptorList::findConnection	(	const DtString &	source,
		const DtString &	destination
	)		[virtual]

Returns:

The pointer to the first occurrence of a connection equal to the one specified. NULL if none found.

virtual bool DtConnectionDescriptorList::removeConnection	(	const DtString &	source,
		const DtString &	destination
	)		[virtual]

Removes all connection descriptors that are equivalent to this the source and destination specified.

Returns:

True if any removals were done.

virtual bool DtConnectionDescriptorList::removeAllConnectionsFrom

(

const DtString &

source

)

[virtual]

Removes all connections that match the specified source and any destination.

Returns:

True if any removals were done.

virtual bool DtConnectionDescriptorList::removeAllConnectionsTo

(

const DtString &

destination

)

[virtual]

Removes all connections that match the specified destination and any source.

Returns:

True if any removals were done.

virtual bool DtConnectionDescriptorList::removeConnections

(

const std::list< DtConnectionDescriptor * >

removeList

)

[virtual]

Removes and deleted all the connections specified in the list.

Returns:

True if any removals were done.

virtual bool DtConnectionDescriptorList::removeConnection

(

DtConnectionDescriptor *

connection

)

[virtual]

Removes and deletes the specified connection.

Returns:

True if the connection was removed.

virtual void DtConnectionDescriptorList::removeAll

(

)

[virtual]

Remomves all connections and clears out memory.

Reimplemented from DtRwList.

virtual DtConnectionDescriptor* DtConnectionDescriptorList::addConnectionDescriptor

(

DtConnectionDescriptor *

descriptor

)

[protected, virtual]

virtual DtlObjPtr DtConnectionDescriptorList::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[protected, virtual]

Constructs a DtConnectionDescriptor item, retrieves it from the mtl stream, and then adds it to the list.

Implements DtRwList.

---

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

• include/vrfobjparam/connDescList.h