DWFToolkit::DWFFeature Class Reference
[DWF Package API]

#include "dwf/package/Feature.h"

Collaboration diagram for DWFToolkit::DWFFeature:

Collaboration graph
[legend]
List of all members.

Detailed Description

Features are used to represent a design aspect of an entity or an object, e.g. a hole or an extrusion.

Since:
7.2.0
Features are used to represent a design aspect of an entity or an object, e.g. a hole or an extrusion. In and of themselves, they cannot be considered as individual design items and hence cannot be realized or rendered without a corresponding entity or object.
Examples:

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

Definition at line 55 of file Feature.h.

Public Types

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

Public Member Functions

virtual _DWFTK_API ~DWFFeature () throw ()
_DWFTK_API DWFClass::tList::IteratorgetClasses () throw ()
_DWFTK_API size_t getClassCount () const throw ()
_DWFTK_API bool hasClass (DWFClass *pClass) const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList, tUnresolvedList &rUnresolved) throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFFeature (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 Enumeration Documentation

enum DWFToolkit::DWFFeature::teUnresolvedAttributes
 

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

Definition at line 91 of file Feature.h.


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFFeature::DWFFeature 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 feature.
pContent The content that owns this element.
Exceptions:
None 


Member Function Documentation

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

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

_DWFTK_API size_t DWFToolkit::DWFFeature::getClassCount  )  const throw () [inline]
 

Get the number of classes.

Returns:
Number of classes.
Exceptions:
None 

Definition at line 133 of file Feature.h.

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

Get an iterator to access all classes in the feature's class list.

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 120 of file Feature.h.

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

This tests whether or not the given class is refered to by the feature.

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

Definition at line 147 of file Feature.h.

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

virtual _DWFTK_API void DWFToolkit::DWFFeature::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