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

class DtSimResourceList: More...

Inheritance diagram for DtSimResourceList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSimResourceList ()
 default constructor
 DtSimResourceList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 real constructor
 DtSimResourceList (const DtSimResourceList &orig, DtSimResource *parent, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
DtSimResourceListoperator= (const DtSimResourceList &orig)
 assignment operator
virtual ~DtSimResourceList ()
 destructor
virtual void addResource (DtSimResource *resource)
virtual bool removeResource (DtSimResource *resource)
 Removes the specified resource from this list, or any from any of the subresource lists of resources in this list.
virtual DtSimResourceListclone (DtSimResource *parent, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 This method must be overridden by a subclass.
virtual DtSimResourceparent () const
virtual void setParent (DtSimResource *parent)
virtual void addResourceToParent (DtSimResource *resource)
virtual void copyList (const DtSimResourceList &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.

Protected Attributes

DtSimResourcemyParent
 The resource for which this list maintains sub resources.

Detailed Description

class DtSimResourceList:


Constructor & Destructor Documentation

default constructor

DtSimResourceList::DtSimResourceList ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)

real constructor

DtSimResourceList::DtSimResourceList ( const DtSimResourceList orig,
DtSimResource parent,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

destructor


Member Function Documentation

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

assignment operator

virtual void DtSimResourceList::addResource ( DtSimResource resource) [virtual]
virtual bool DtSimResourceList::removeResource ( DtSimResource resource) [virtual]

Removes the specified resource from this list, or any from any of the subresource lists of resources in this list.

Sets the resource's parent to NULL if it is removed. Does not delete the resource.

Returns:
True if the resource was removed.
virtual DtSimResourceList* DtSimResourceList::clone ( DtSimResource parent,
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]
virtual DtlObjPtr DtSimResourceList::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [virtual]

This method must be overridden by a subclass.

Within this method, new instances of the DtReaderWriter subclass that is being handled by this list must be created, and then retrieved from the mtl stream, using the getSelf member of that item.

Here is some sample code that could be used to implement a override of this class: (This is used in the DtRwIntegerList::getData() method)
 DtlObjPtr nameObj = DtcCar(args);
 DtRwInt* value = new DtRwInt(nameObj->pname());
 value->getSelf(args, searchPath, variableBindings);
 this->add(value);
 return DtcCdr(DtcCdr(args));

Implements DtRwList.

virtual DtSimResource* DtSimResourceList::parent ( ) const [virtual]
virtual void DtSimResourceList::setParent ( DtSimResource parent) [virtual]
virtual void DtSimResourceList::addResourceToParent ( DtSimResource resource) [virtual]
virtual void DtSimResourceList::copyList ( const DtSimResourceList orig,
DtReaderWriterRegistry parentRegistry = 0 
) [virtual]
virtual const char* DtSimResourceList::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.


Member Data Documentation

The resource for which this list maintains sub resources.


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)