VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
DtConnectionDescriptor Class Reference

DtConnectionDescriptor is a readable/writeable description of a connection between components. More...

Inheritance diagram for DtConnectionDescriptor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtConnectionDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtConnectionDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
 DtConnectionDescriptor (const DtString &componentName, const DtString &source, const DtString &destination, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor
 DtConnectionDescriptor (const DtSymbolString &componentName, const DtString &source, const DtString &destination, DtReaderWriterRegistry *parentRegistry=NULL)
 DtConnectionDescriptor (const DtConnectionDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
DtConnectionDescriptoroperator= (const DtConnectionDescriptor &orig)
 assignment
virtual ~DtConnectionDescriptor ()
bool operator== (const DtConnectionDescriptor &orig)
 Tests the equality of the two strings.
virtual DtConnectionDescriptorclone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void putData (FILE *fp, int indentLevel=0)
 Overrides base class putData to output our type.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool init ()
 Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
virtual void setSource (const DtString &source)
 Set/get the connection source.
virtual const DtStringsource () const
virtual void setDestination (const DtString &dest)
 Set/get the connection destination.
virtual const DtStringdestination () const

Protected Member Functions

 DtConnectionDescriptor ()
 default constructor

Protected Attributes

DtString mySource
DtString myDestination

Detailed Description

DtConnectionDescriptor is a readable/writeable description of a connection between components.


Constructor & Destructor Documentation

default constructor

DtConnectionDescriptor::DtConnectionDescriptor ( const DtString componentName,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

DtConnectionDescriptor::DtConnectionDescriptor ( const DtSymbolString componentName,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtConnectionDescriptor::DtConnectionDescriptor ( const DtString componentName,
const DtString source,
const DtString destination,
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor

DtConnectionDescriptor::DtConnectionDescriptor ( const DtSymbolString componentName,
const DtString source,
const DtString destination,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor


Member Function Documentation

DtConnectionDescriptor& DtConnectionDescriptor::operator= ( const DtConnectionDescriptor orig)

assignment

bool DtConnectionDescriptor::operator== ( const DtConnectionDescriptor orig)

Tests the equality of the two strings.

virtual DtConnectionDescriptor* DtConnectionDescriptor::clone ( DtReaderWriterRegistry parentRegistry = NULL) const [virtual]
virtual void DtConnectionDescriptor::putData ( FILE *  fp,
int  indentLevel = 0 
) [virtual]

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

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

getData is just used to get us past the type in the data stream, since it's not actually stored.

virtual bool DtConnectionDescriptor::init ( ) [virtual]

Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.

virtual void DtConnectionDescriptor::setSource ( const DtString source) [virtual]

Set/get the connection source.

virtual const DtString& DtConnectionDescriptor::source ( ) const [virtual]
virtual void DtConnectionDescriptor::setDestination ( const DtString dest) [virtual]

Set/get the connection destination.

virtual const DtString& DtConnectionDescriptor::destination ( ) const [virtual]

Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)