DWFToolkit::DWFObject Class Reference
[DWF Package API]

#include "dwf/package/Object.h"

Collaboration diagram for DWFToolkit::DWFObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

Objects represent realizations of entities (design elements) in a model.

Since:
7.2.0
Objects represent realizations of entities (design elements) in a model. They define the final model that a publisher intends to show.
Examples:

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

Definition at line 58 of file Object.h.

Public Types

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

Public Member Functions

virtual _DWFTK_API ~DWFObject () throw ()
_DWFTK_API DWFEntitygetEntity () throw ()
_DWFTK_API DWFObject::tList::IteratorgetChildren () throw ()
_DWFTK_API size_t getChildCount () const throw ()
_DWFTK_API DWFObjectgetParent () 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 DWFObject (const DWFString &zID, DWFEntity *pEntity, DWFContent *pContent=NULL) throw ( DWFInvalidArgumentException )
_DWFTK_API DWFObject () 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::DWFObject::teUnresolvedAttributes DWFToolkit::DWFObject::teUnresolvedAttributes
 

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


Member Enumeration Documentation

enum DWFToolkit::DWFObject::teUnresolvedAttributes
 

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

Definition at line 94 of file Object.h.


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFObject::DWFObject const DWFString zID,
DWFEntity pEntity,
DWFContent pContent = NULL
throw ( DWFInvalidArgumentException ) [protected]
 

Constructor

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

Parameters:
zID The UUID assigned to the object.
pEntity The entity that this object realizes.
pContent The content that owns this element.
Exceptions:
A DWFInvalidArgumentException is thrown if the entity pointer is NULL.

_DWFTK_API DWFToolkit::DWFObject::DWFObject  )  throw () [protected]
 

Constructor

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

Exceptions:
None. 


Member Function Documentation

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

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

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

Get the number of child objects.

Returns:
Number of child objects.
Exceptions:
None 

Definition at line 152 of file Object.h.

_DWFTK_API DWFObject::tList::Iterator* DWFToolkit::DWFObject::getChildren  )  throw () [inline]
 

Access the child objects 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 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

Definition at line 139 of file Object.h.

_DWFTK_API DWFEntity* DWFToolkit::DWFObject::getEntity  )  throw () [inline]
 

Get the entity that this object realizes.

Returns:
A pointer to an entity.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

Definition at line 125 of file Object.h.

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

Get the number of features associated with the object.

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

Definition at line 194 of file Object.h.

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

Get an iterator to access all associated with an object.

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 181 of file Object.h.

_DWFTK_API DWFObject* DWFToolkit::DWFObject::getParent  )  const throw () [inline]
 

Access the parents via the iterator.

Returns:
A pointer to the parent object. This pointer may be NULL if it has no parent.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

Definition at line 167 of file Object.h.

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

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

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

Definition at line 208 of file Object.h.

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

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