Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFDefinedObjectContainer Class Reference
[DWF Package API]

#include "dwf/package/utility/DefinedObjectContainer.h"

Inheritance diagram for DWFToolkit::DWFDefinedObjectContainer:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFDefinedObjectContainer:

Collaboration graph
[legend]
List of all members.

Detailed Description

An auto-indexing collection utility for DWFDefinedObject objects.
Since:
7.0.1.

Definition at line 43 of file DefinedObjectContainer.h.

Public Member Functions

_DWFTK_API DWFDefinedObjectContainer () throw ()
virtual _DWFTK_API ~DWFDefinedObjectContainer () throw ()
_DWFTK_API void addObject (DWFDefinedObject *pObject, uint32_t nGroup=0) throw ()
_DWFTK_API DWFDefinedObjectfindObject (const DWFString &zID) throw ( DWFException )
_DWFTK_API bool empty () const throw ()
_DWFTK_API DWFPropertyContainergetObjectProperties () throw ()
DWFXMLSerializablegetSerializableObjectContainer () const throw ()

Protected Types

typedef multimap< uint32_t,
DWFDefinedObject * > 
_tGroupedObjectMap
 This type is used to describe the object groups.

Protected Attributes

DWFDefinedObject::tMap _oKeyedObjects
 The contained objects keyed by object ID.
DWFPropertyContainer _oObjectProperties
 The internal property container exposed through getObjectProperties().
_tGroupedObjectMap _oGroupedObjects
 The object groups.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFDefinedObjectContainer::DWFDefinedObjectContainer  )  throw ()
 

Constructor

Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFDefinedObjectContainer::~DWFDefinedObjectContainer  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFDefinedObjectContainer::addObject DWFDefinedObject pObject,
uint32_t  nGroup = 0
throw ()
 

Inserts an object into the container.

Parameters:
pObject The object to add. This pointer is now owned by the container and will be released with the DWFCORE_FREE_OBJECT macro.
nGroup An optional parameter that preserves order relative to the other children. This value does not have to be unique, in fact, it is a group not a key. Groups are sorted in ascending order, so children in group 0 will be ordered before children in group 1 (or any other group for that matter.) There is no rule defined for child ordering within a group.
Exceptions:
None 
Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp, and SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp.

_DWFTK_API bool DWFToolkit::DWFDefinedObjectContainer::empty  )  const throw ()
 

Indicates whether or not any object have been added to the container.

Returns:
true if there is at least one object in the container, false otherwise.
Exceptions:
None 

_DWFTK_API DWFDefinedObject* DWFToolkit::DWFDefinedObjectContainer::findObject const DWFString zID  )  throw ( DWFException )
 

Locates an object by it's unique ID.

Parameters:
zID Identifies the object.
Returns:
A pointer to the object. The caller must not delete this pointer.
Exceptions:
DWFException 

_DWFTK_API DWFPropertyContainer& DWFToolkit::DWFDefinedObjectContainer::getObjectProperties  )  throw ()
 

Returns an interface with which properties can be associated with the container itself.

Returns:
A reference to a property container interface.
Exceptions:
None 

DWFXMLSerializable& DWFToolkit::DWFDefinedObjectContainer::getSerializableObjectContainer  )  const throw () [inline]
 

Returns an interface with which the container can be serialized into an XML document.

Returns:
A reference to a serialization inteface.
Exceptions:
None 

Definition at line 125 of file DefinedObjectContainer.h.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:08 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1