DWFToolkit::DWFClass Class Reference
[DWF Package API]

#include "dwf/package/Class.h"

Collaboration diagram for DWFToolkit::DWFClass:

Collaboration graph
[legend]
List of all members.

Detailed Description

A DWFClass is used to classify entities and features in the DWF content.

Since:
7.2.0
The DWFClass is used to provide a type for entities and features. Classes themselves can be typed by (base) classes. The properties on a class are inherited by the classes, entities and features that they classify.
Examples:

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

Definition at line 52 of file Class.h.

Public Types

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

Public Member Functions

virtual _DWFTK_API ~DWFClass () throw ()
_DWFTK_API DWFClass::tList::IteratorgetBaseClasses () throw ()
_DWFTK_API size_t getBaseClassCount () const throw ()
_DWFTK_API bool isBaseClass (DWFClass *pClass) const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList, tUnresolvedList &rUnresolved) throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFClass (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 )
virtual _DWFTK_API void insertPropertyAncestors (DWFContentElement::tVector &rAncestorElements) const throw ()

Friends

class DWFContent
class DWFXMLElementBuilder


Member Typedef Documentation

typedef enum DWFToolkit::DWFClass::teUnresolvedAttributes DWFToolkit::DWFClass::teUnresolvedAttributes
 

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


Member Enumeration Documentation

enum DWFToolkit::DWFClass::teUnresolvedAttributes
 

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

Definition at line 88 of file Class.h.


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFClass::DWFClass 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 assigned to the class
pContent The content that owns this element.
Exceptions:
None 


Member Function Documentation

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

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

_DWFTK_API size_t DWFToolkit::DWFClass::getBaseClassCount  )  const throw () [inline]
 

Get the number of base classes.

Returns:
Number of base classes.
Exceptions:
None 

Definition at line 130 of file Class.h.

_DWFTK_API DWFClass::tList::Iterator* DWFToolkit::DWFClass::getBaseClasses  )  throw () [inline]
 

Access the base classes 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 Class.h.

virtual _DWFTK_API void DWFToolkit::DWFClass::insertPropertyAncestors DWFContentElement::tVector &  rAncestorElements  )  const throw () [protected, virtual]
 

_DWFTK_API bool DWFToolkit::DWFClass::isBaseClass DWFClass pClass  )  const throw () [inline]
 

This tests whether or not the given class is a base class.

Parameters:
pClass A pointer to a class.
Returns:
True if the class is in the base class list.
Exceptions:
None 

Definition at line 144 of file Class.h.

virtual _DWFTK_API void DWFToolkit::DWFClass::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:27 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5