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

Instances of DtRwIntegerList are lists of readable, writeable integers (DtRwInts). More...

Inheritance diagram for DtRwIntegerList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRwIntegerList ()
 default constructor
 DtRwIntegerList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 constructor
 DtRwIntegerList (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual ~DtRwIntegerList ()
 destructor
DtRwIntegerListoperator= (const DtRwIntegerList &orig)
 assignment operator Empties the current list (including deleting all items) before making a deep copy of the specified list.
virtual void addInteger (DtRwInt *rwInt)
 Add a DtRwInt to the list (appended to the end of the list).
virtual void removeInteger (DtRwInt *rwInt, DtListItem *listItem)
 Remove a given DtRwInt from the list.
void emptyList ()
 Removes and deletes all DtRwInt entries from our list.
 DtRwIntegerList (const DtString &name, const DtRwIntegerList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor This performs a deep copy of the list, and creates new DtRwInt instances for each item on the list.
 DtRwIntegerList (const DtSymbolString &name, const DtRwIntegerList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor This performs a deep copy of the list, and creates new DtRwInt instances for each item on the list.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Constructs a DtRwInt item, and then retrieves it from the stream.
void copyList (const DtRwIntegerList &orig)
 Copies list of DtRwInts to ourself.

Detailed Description

Instances of DtRwIntegerList are lists of readable, writeable integers (DtRwInts).

The list contains pointers to DtRwInt instances.


Constructor & Destructor Documentation

default constructor

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

constructor

DtRwIntegerList::DtRwIntegerList ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
virtual DtRwIntegerList::~DtRwIntegerList ( ) [virtual]

destructor

DtRwIntegerList::DtRwIntegerList ( const DtString name,
const DtRwIntegerList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor This performs a deep copy of the list, and creates new DtRwInt instances for each item on the list.

DtRwIntegerList::DtRwIntegerList ( const DtSymbolString name,
const DtRwIntegerList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor This performs a deep copy of the list, and creates new DtRwInt instances for each item on the list.


Member Function Documentation

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

assignment operator Empties the current list (including deleting all items) before making a deep copy of the specified list.

virtual void DtRwIntegerList::addInteger ( DtRwInt rwInt) [virtual]

Add a DtRwInt to the list (appended to the end of the list).

Note:
The items added to this list must have names, otherwise the list will not read and write correctly. For example, to create a new list, and add a new integer with value 5, use code like this:
 DtRwIntegerList iList;
 iList.addInteger(new DtRwInt("item", 5));
virtual void DtRwIntegerList::removeInteger ( DtRwInt rwInt,
DtListItem *  listItem 
) [virtual]

Remove a given DtRwInt from the list.

Just deletes the DtListItem, does not delete the DtRwInt itself. When last item is removed, sets value specified to false.

Removes and deletes all DtRwInt entries from our list.

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

Constructs a DtRwInt item, and then retrieves it from the stream.

Implements DtRwList.

void DtRwIntegerList::copyList ( const DtRwIntegerList orig) [protected]

Copies list of DtRwInts to ourself.


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)