DWFToolkit::DWFEntity Class Reference
[DWF Package API]

#include "dwf/package/Entity.h"

Collaboration diagram for DWFToolkit::DWFEntity:

Collaboration graph
[legend]
List of all members.

Detailed Description

Entities are used to represent a design element that can be used in a model like a door knob or a laptop.

Since:
7.2.0
Entities are used to represent a design element that can be used in a model like a door knob or a laptop. They can be composed of multiple sub-parts or child entities, just as a laptop can be composed of multiple parts.
Examples:

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

Definition at line 53 of file Entity.h.

Public Types

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

Public Member Functions

virtual _DWFTK_API ~DWFEntity () throw ()
_DWFTK_API DWFEntity::tSortedList::ConstIteratorgetChildren () throw ()
_DWFTK_API size_t getChildCount () const throw ()
_DWFTK_API DWFEntity::tSortedList::ConstIteratorgetParents () throw ()
_DWFTK_API DWFEntitygetParent (size_t index) const throw ()
_DWFTK_API size_t getParentCount () const throw ()
_DWFTK_API bool isParent (DWFEntity *pEntity) const throw ()
_DWFTK_API DWFClass::tList::IteratorgetClasses () throw ()
_DWFTK_API size_t getClassCount () const throw ()
_DWFTK_API bool hasClass (DWFClass *pClass) const throw ()
_DWFTK_API DWFFeature::tList::IteratorgetFeatures () throw ()
_DWFTK_API size_t getFeatureCount () const throw ()
_DWFTK_API bool hasFeature (DWFFeature *pFeature) const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList, tUnresolvedList &rUnresolved) throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFEntity (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::DWFEntity::teUnresolvedAttributes DWFToolkit::DWFEntity::teUnresolvedAttributes
 

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


Member Enumeration Documentation

enum DWFToolkit::DWFEntity::teUnresolvedAttributes
 

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

Definition at line 97 of file Entity.h.


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

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


Member Function Documentation

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

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

_DWFTK_API size_t DWFToolkit::DWFEntity::getChildCount  )  const throw () [inline]
 

Get the number of child entities.

Returns:
Number of child entities.
Exceptions:
None 

Definition at line 146 of file Entity.h.

_DWFTK_API DWFEntity::tSortedList::ConstIterator* DWFToolkit::DWFEntity::getChildren  )  throw () [inline]
 

Access the child entities 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 133 of file Entity.h.

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

Get the number of classes.

Returns:
Number of classes.
Exceptions:
None 

Definition at line 230 of file Entity.h.

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

Get an iterator to access all classes in the entity'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 217 of file Entity.h.

_DWFTK_API size_t DWFToolkit::DWFEntity::getFeatureCount  )  const throw () [inline]
 

Get the number of features associated with the entity.

Returns:
Number of features associated with the entity.
Exceptions:
None 

Definition at line 272 of file Entity.h.

_DWFTK_API DWFFeature::tList::Iterator* DWFToolkit::DWFEntity::getFeatures  )  throw () [inline]
 

Get an iterator to access all features associated with the entity.

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 259 of file Entity.h.

_DWFTK_API DWFEntity* DWFToolkit::DWFEntity::getParent size_t  index  )  const throw () [inline]
 

Access a parent entity by its index in the parent list.

Returns:
A pointer to a parent entity.
Exceptions:
None 

Definition at line 175 of file Entity.h.

_DWFTK_API size_t DWFToolkit::DWFEntity::getParentCount  )  const throw () [inline]
 

Get the number of parent entities.

Returns:
Number of parent entities.
Exceptions:
None 

Definition at line 188 of file Entity.h.

_DWFTK_API DWFEntity::tSortedList::ConstIterator* DWFToolkit::DWFEntity::getParents  )  throw () [inline]
 

Access the parents 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 160 of file Entity.h.

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

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

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

Definition at line 244 of file Entity.h.

_DWFTK_API bool DWFToolkit::DWFEntity::hasFeature DWFFeature pFeature  )  const throw () [inline]
 

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

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

Definition at line 286 of file Entity.h.

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

_DWFTK_API bool DWFToolkit::DWFEntity::isParent DWFEntity pEntity  )  const throw () [inline]
 

This tests whether or not the given entity a parent of this one.

Parameters:
pEntity A pointer to an entity.
Returns:
True if the entity is a parent, false otherwise.
Exceptions:
None 

Definition at line 202 of file Entity.h.

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