DWFToolkit::DWFContentElement Class Reference
[DWF Package API]

#include "dwf/package/ContentElement.h"

List of all members.


Detailed Description

ContentElement is the base class for the object defintion elements class, feature, entity, object and group.

Since:
7.2.0
The DWFContentElement class is the base class for the object definition elements used to define a model. It provides the property management API specific to the object definition elements, including property inheritance.
Examples:

ReadContentDefinition/ReadContentDefinition.cpp.

Definition at line 51 of file ContentElement.h.

Public Types

typedef DWFOrderedVector<
DWFContentElement * > 
tList
 This type defines a list of DWFContentElement pointers.
typedef DWFStringKeySkipList<
DWFContentElement * > 
tMap
 This type defines a mapped collection of DWFContenteElement pointers.
typedef DWFIterator< DWFContentElement * > tIterator
 This type defines a basic iterator on a collection of DWFContenteElement pointers.

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFContentElement *) tVector
 This type defines an STL vector of DWFContentElement pointers.
virtual _DWFTK_API ~DWFContentElement () throw ()
virtual _DWFTK_API const DWFPropertygetProperty (const DWFString &zName, const DWFString &zCategory=L"", bool bSearchClosedSets=false) throw ( DWFException )
virtual _DWFTK_API const DWFPropertygetPropertyBySchemaID (const DWFString &zSchemaID, const DWFString &zName, const DWFString &zCategory=L"") throw ()
virtual _DWFTK_API const DWFPropertygetPropertyBySetID (const DWFString &zSetID, const DWFString &zName, const DWFString &zCategory=L"") throw ()
virtual _DWFTK_API DWFProperty::tIteratorgetAllProperties (bool bSearchClosedSets=false) throw ()
virtual _DWFTK_API DWFProperty::tIteratorgetAllProperties (const DWFString &zCategory, bool bSearchClosedSets=false) throw ()
virtual _DWFTK_API DWFPropertySetgetPropertySet (const DWFString &zID, teQueryIDType eIDType=eSchemaID) throw ()
virtual _DWFTK_API DWFPropertySet::tIteratorgetPropertySets (bool bReturnClosedSets=false) throw ()
virtual _DWFTK_API void parseAttributeList (const char **) throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFContentElement (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 &) const throw ()

Friends

class DWFContent


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

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

Constructor

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


Member Function Documentation

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

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

virtual _DWFTK_API DWFProperty::tIterator* DWFToolkit::DWFContentElement::getAllProperties const DWFString zCategory,
bool  bSearchClosedSets = false
throw () [virtual]
 

Access all properties that this element owns, references, inherits, provided they are in the given category. These are a subset of the default properties.

Parameters:
zCategory The category of the property. The empty string is a valid category name.
bSearchClosedSets By default closed property sets will not be searched.
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 

virtual _DWFTK_API DWFProperty::tIterator* DWFToolkit::DWFContentElement::getAllProperties bool  bSearchClosedSets = false  )  throw () [virtual]
 

Access all properties that this element owns, references, and/or inherits. These are the default properties.

Parameters:
bSearchClosedSets By default closed property sets will not be searched.
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.

virtual _DWFTK_API const DWFProperty* DWFToolkit::DWFContentElement::getProperty const DWFString zName,
const DWFString zCategory = L"",
bool  bSearchClosedSets = false
throw ( DWFException ) [virtual]
 

Find a property with the given name and category. Properties can come from multiple possible sources. They may be: 1. owned by the element. This will have priority over any property with the same name in any property set. 2. in property sets owned by the element. If two property sets in the element have the same property, then the one listed first will be returned. The order is defined by the order in which the property sets were added to the element. 3. owned by property sets referenced by the element. 4. in property sets owned by referenced property containers. If two property sets in the referenced container have the property, again, the first found is returned. 5. provided as inherited properties from content elements that are higher up in the object defintion model, that this element is a direct or indirect descendent of. The property of the ancestral element may itself be discovered from sources, as given by points 1 through 5 here. The search is performed in the above order so the most derived element provides the property. By default closed property sets will not be searched, unless the user requests it.

Parameters:
zName The property name.
zCategory The category of the property. The empty string is a valid category name.
bSearchClosedSets By default closed property sets will not be searched.
Returns:
A pointer to the property if found, NULL otherwise.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

virtual _DWFTK_API const DWFProperty* DWFToolkit::DWFContentElement::getPropertyBySchemaID const DWFString zSchemaID,
const DWFString zName,
const DWFString zCategory = L""
throw () [inline, virtual]
 

Find a property with the given name and category, in a subset with a specific schema ID.

Parameters:
zSchemaID The Schema ID of the property set to be searched.
zName The property name.
zCategory The category of the property.
Returns:
A pointer to the property if found, NULL otherwise.
Exceptions:
None 

Definition at line 131 of file ContentElement.h.

virtual _DWFTK_API const DWFProperty* DWFToolkit::DWFContentElement::getPropertyBySetID const DWFString zSetID,
const DWFString zName,
const DWFString zCategory = L""
throw () [inline, virtual]
 

Find a property with the given name and category, in a subset with a specific set ID.

Parameters:
zSetID The Set ID of the property set to be searched.
zName The property name.
zCategory The category of the property.
Returns:
A pointer to the property if found, NULL otherwise.
Exceptions:
None 

Definition at line 149 of file ContentElement.h.

virtual _DWFTK_API DWFPropertySet* DWFToolkit::DWFContentElement::getPropertySet const DWFString zID,
teQueryIDType  eIDType = eSchemaID
throw () [virtual]
 

Find a property set with the given UUID. Property sets can come from one of multiple sources. They may be: 1. owned by the element. 2. owned by a property containers referenced by the element. 3. inherited from elements that are higher up in the object defintion model, that this element is a direct or indirect descendent of. The property set of the ancestral element is itself be discovered from sources, as given by points 1 through 3 here.

Parameters:
zID The Schema ID or UUID of the property set to be searched.
eIDType Determines whether to get the property set based on schema ID or UUID.
Returns:
A pointer to the property set if found, NULL otherwise.
Exceptions:
None 

virtual _DWFTK_API DWFPropertySet::tIterator* DWFToolkit::DWFContentElement::getPropertySets bool  bReturnClosedSets = false  )  throw () [virtual]
 

Access all property sets available to the element, namely: 1. owned by the element. 2. owned by a property sets referenced by the element. 3. inherited from elements that are higher up in the object defintion model, that this element is a direct or indirect descendent of. The property set of the ancestral element is itself discovered from sources, as given by points 1 through 3 here. By default closed property sets will not be returned unless requested by the caller.

Parameters:
bReturnClosedSets By default closed property sets will not be returned.
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 

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

For internal use only.

This inserts into the provided list the ancestors elements from which this element can inherit properties. This should be implemented in all classes derived from DWFContentElement if they have classes from which to inherit properties.

Parameters:
rAncestorElements Reference to an vector of content elements to which the elements's "property ancestors" will be added.
Exceptions:
None 

Definition at line 285 of file ContentElement.h.

virtual _DWFTK_API void DWFToolkit::DWFContentElement::parseAttributeList const char **   )  throw ( DWFException ) [inline, virtual]
 

For internal use only.

For the ContentElement derived classes use the overload parseAttributeList( const char** ppAttributeList, tUnresolvedList& rUnresolved )

Definition at line 238 of file ContentElement.h.


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