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

Inheritance diagram for DtConnectionDescriptorList:

Public Member Functions
	DtConnectionDescriptorList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

DtConnectionDescriptorList &	operator= (const DtConnectionDescriptorList &orig)

virtual	~DtConnectionDescriptorList ()

virtual DtConnectionDescriptorList *	clone (DtReaderWriterRegistry *parentRegistry=NULL)

virtual const char *	readerWriterType () const

virtual void	emptyList ()

virtual void	copyList (const DtConnectionDescriptorList &orig)

virtual DtConnectionDescriptor *	addConnectionDescriptor (const DtConnectionDescriptor &descriptor)

virtual DtConnectionDescriptor *	addConnection (const DtString &source, const DtString &destination, bool isFromAutoConnect=false)

virtual DtConnectionDescriptor *	findConnection (const DtString &source, const DtString &destination)

virtual bool	removeConnection (const DtString &source, const DtString &destination)

virtual bool	removeAllConnectionsFrom (const DtString &source)

virtual bool	removeAllConnectionsTo (const DtString &destination)

virtual bool	removeConnections (const std::list< DtConnectionDescriptor * > removeList)

virtual bool	removeConnection (DtConnectionDescriptor *connection)

virtual void	removeAll ()

virtual bool	hasSystemOutput (const DtString &outputPortName) const

virtual bool	hasSystemInput (const DtString &inputPortName) const

bool	operator== (const DtConnectionDescriptorList &) const

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList ()

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAndDeleteAll ()

virtual void	reset ()

bool	operator== (const DtRwList &rhs) const

bool	operator!= (const DtRwList &rhs) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

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

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

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual const char *	xmlType () const

virtual std::set< DtString >	supportedXmlTypes () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
	DtConnectionDescriptorList ()

virtual DtConnectionDescriptor *	addConnectionDescriptor (DtConnectionDescriptor *descriptor)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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,
		bool	isFromAutoConnect = `false`
	)

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 bool DtConnectionDescriptorList::hasSystemOutput ( const DtString & outputPortName ) const

virtual

Returns true if a connection exists with the destination "system:<outputPortName>".

virtual bool DtConnectionDescriptorList::hasSystemInput ( const DtString & inputPortName ) const

virtual

Returns true if a connection exists with the source "system:<inputPortName>".

bool DtConnectionDescriptorList::operator== ( const DtConnectionDescriptorList & ) const

virtual DtConnectionDescriptor* DtConnectionDescriptorList::addConnectionDescriptor ( DtConnectionDescriptor * descriptor )

protectedvirtual

virtual DtlObjPtr DtConnectionDescriptorList::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

protectedvirtual

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/connectionDescriptorList.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation