DWFToolkit::DWFGroup Class Reference
[DWF Package API]

#include "dwf/package/Group.h"

Collaboration diagram for DWFToolkit::DWFGroup:

Collaboration graph
[legend]
List of all members.

Detailed Description

A DWFGroup is used to aggregate multiple elements of a model including groups to provide properties on the aggregate.

Since:
7.2.0
A DWFGroup is used to aggregate multiple elements of a model including groups to provide properties on the aggregate.
Examples:

ReadContentDefinition/ReadContentDefinition.cpp, and WriteContent/WriteContent.cpp.

Definition at line 52 of file Group.h.

Public Types

typedef DWFOrderedVector<
DWFGroup * > 
tList
 This type defines a list of DWFGroup pointers.
typedef DWFStringKeySkipList<
DWFGroup * > 
tMap
 This type defines a mapped collection of DWFGroup pointers.
typedef DWFCachingIterator<
DWFGroup * > 
tCachingIterator
 This type defines a caching iterator on a collection of DWFGroup pointers, that caches the pointers in its own container.
typedef DWFIterator< DWFGroup * > tIterator
 This type defines a basic iterator on a collection of DWFGroup pointers.
typedef enum DWFToolkit::DWFGroup::teUnresolvedAttributes teUnresolvedAttributes
enum  teUnresolvedAttributes

Public Member Functions

virtual _DWFTK_API ~DWFGroup () throw ()
_DWFTK_API DWFContentElement::tList::IteratorgetElements () throw ()
_DWFTK_API size_t getElementCount () const throw ()
_DWFTK_API bool hasElement (DWFContentElement *pElement) const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList, tUnresolvedList &rUnresolved) throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFGroup (const DWFString &zID=L"", DWFContent *pContent=NULL) throw ()
virtual _DWFTK_API void _serializeAttributes (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )
virtual _DWFTK_API void _serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Friends

class DWFContent
class DWFXMLElementBuilder


Member Typedef Documentation

typedef enum DWFToolkit::DWFGroup::teUnresolvedAttributes DWFToolkit::DWFGroup::teUnresolvedAttributes
 

This enum defines the attributes that this class will not resolve when parsing attributes for the reader.


Member Enumeration Documentation

enum DWFToolkit::DWFGroup::teUnresolvedAttributes
 

This enum defines the attributes that this class will not resolve when parsing attributes for the reader.

Definition at line 88 of file Group.h.


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFGroup::DWFGroup const DWFString zID = L"",
DWFContent pContent = NULL
throw () [protected]
 

Constructor

The constructor is for use by the DWFContent and the DWFXMLElementBuilder, during publishing and reading respectively. It should not be used to create the element directly.

Parameters:
zID The UUID to be assigned to the group.
pContent The content that owns this element.
Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFGroup::_serializeAttributes DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [protected, virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFGroup::_serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [protected, virtual]
 

_DWFTK_API size_t DWFToolkit::DWFGroup::getElementCount  )  const throw () [inline]
 

Get the number of elements in the group.

Returns:
Number of elements.
Exceptions:
None 

Definition at line 130 of file Group.h.

_DWFTK_API DWFContentElement::tList::Iterator* DWFToolkit::DWFGroup::getElements  )  throw () [inline]
 

Access the group elements via the iterator.

Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL.
Exceptions:
None 

Definition at line 117 of file Group.h.

_DWFTK_API bool DWFToolkit::DWFGroup::hasElement DWFContentElement pElement  )  const throw () [inline]
 

This tests whether or not the group contains the element.

Parameters:
pElement Pointer to a content element.
Returns:
True if the group contains the element
Exceptions:
None 

Definition at line 144 of file Group.h.

virtual _DWFTK_API void DWFToolkit::DWFGroup::parseAttributeList const char **  ppAttributeList,
tUnresolvedList &  rUnresolved
throw ( DWFException ) [virtual]
 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:29 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5