DWFToolkit::DWFContent Class Reference
[DWF Package API]

#include "dwf/package/Content.h"

Inheritance diagram for DWFToolkit::DWFContent:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFContent:

Collaboration graph
[legend]
List of all members.

Detailed Description

Content is the container and management class for all object defintion elements.

Since:
7.2.0
The DWFContent class provides the management API for all object definition elements. The elements should be created and destroyed via the content class.
Examples:

3DPublish/3DPublish_UTF8.cpp, ReadContentDefinition/ReadContentDefinition.cpp, and WriteContent/WriteContent.cpp.

Definition at line 65 of file Content.h.

Public Types

typedef DWFOrderedVector<
DWFContent * > 
tList
 This type defines a list of DWFContent pointers.
typedef DWFStringKeySkipList<
DWFContent * > 
tMap
 This type defines a mapped collection of DWFContent pointers.
typedef DWFIterator< DWFContent * > tIterator
 This type defines a basic iterator on a collection of DWFContent pointers.
typedef DWFCachingIterator<
DWFContent * > 
tCachingIterator
 This type defines a caching iterator on a collection of DWFContent pointers.
typedef DWFXMLBuildable::tUnresolvedList tUnresolvedList
 Defined data type to collect unresolved attributes during the parsing process.
typedef DWFIterator< DWFStringDWFStringIterator
 This type defines a basic iterator on a collection of DWFString objects.

Public Member Functions

_DWFTK_API DWFContent (DWFPackageReader *pPackageReader, const DWFString &zID=L"") throw ( DWFException )
_DWFTK_API DWFContent (DWFContentManager *pContentManager, const DWFString &zID=L"") throw ( DWFException )
_DWFTK_API ~DWFContent () throw ()
_DWFTK_API const DWFStringid () const throw ()
_DWFTK_API void setHRef (const DWFString &zHRef) throw ()
_DWFTK_API DWFString href () throw ()
_DWFTK_API bool isLoaded () const throw ()
_DWFTK_API bool isResourceLoaded (const DWFString &zResourceObjectID) throw ()
_DWFTK_API DWFClass::tIteratorfindClassByBaseClass (DWFClass *pBaseClass) throw ()
_DWFTK_API DWFClass::tIteratorfindClassByBaseClass (const DWFString &zID) throw ()
_DWFTK_API DWFEntity::tIteratorfindEntitiesByClass (DWFClass *pClass) throw ()
_DWFTK_API DWFEntity::tIteratorfindEntitiesByClass (const DWFString &zID) throw ()
_DWFTK_API DWFFeature::tIteratorfindFeaturesByClass (DWFClass *pClass) throw ()
_DWFTK_API DWFFeature::tIteratorfindFeaturesByClass (const DWFString &zID) throw ()
_DWFTK_API DWFObject::tIteratorfindObjectsByEntity (DWFEntity *pEntity) throw ()
_DWFTK_API DWFObject::tIteratorfindObjectsByEntity (const DWFString &zID) throw ()
_DWFTK_API DWFEntity::tIteratorfindEntitiesByFeature (DWFFeature *pFeature) throw ()
_DWFTK_API DWFEntity::tIteratorfindEntitiesByFeature (const DWFString &zID) throw ()
_DWFTK_API DWFObject::tIteratorfindObjectsByFeature (DWFFeature *pFeature) throw ()
_DWFTK_API DWFObject::tIteratorfindObjectsByFeature (const DWFString &zID) throw ()
_DWFTK_API DWFGroup::tIteratorfindGroupsByElement (DWFContentElement *pElement) throw ()
_DWFTK_API DWFGroup::tIteratorfindGroupsByElement (const DWFString &zID) throw ()
_DWFTK_API DWFInstance::tIteratorfindInstancesByRenderable (DWFRenderable *pRendered, const DWFString &zResourceObjectID=L"") throw ()
_DWFTK_API DWFInstance::tIteratorfindInstancesByRenderable (const DWFString &zRenderedID, const DWFString &zResourceObjectID=L"") throw ()
_DWFTK_API DWFInstance::tIteratorfindInstancesByResourceID (const DWFString &zResourceObjectID) const throw ( DWFException )
_DWFTK_API DWFIterator< DWFString > * findResourceIDsByRenderable (DWFRenderable *pRenderable) throw ()
_DWFTK_API DWFIterator< DWFString > * findResourceIDsByRenderable (const DWFString &zID) throw ()
_DWFTK_API void setContentManager (DWFContentManager *pContentManager)
_DWFTK_API DWFContentManagergetContentManager () throw ()
_DWFTK_API DWFClassgetClass (const DWFString &zID) throw ()
_DWFTK_API DWFFeaturegetFeature (const DWFString &zID) throw ()
_DWFTK_API DWFEntitygetEntity (const DWFString &zID) throw ()
_DWFTK_API DWFObjectgetObject (const DWFString &zID) throw ()
_DWFTK_API DWFGroupgetGroup (const DWFString &zID) throw ()
_DWFTK_API DWFContentElementgetElement (const DWFString &zID) throw ()
_DWFTK_API DWFInstancegetInstance (const DWFString &zID) throw ()
_DWFTK_API DWFPropertySetgetSharedPropertySet (const DWFString &zID) throw ()
_DWFTK_API DWFClass::tMap::Iterator * getClasses () throw ()
_DWFTK_API DWFFeature::tMap::Iterator * getFeatures () throw ()
_DWFTK_API DWFEntity::tMap::Iterator * getEntities () throw ()
_DWFTK_API DWFObject::tMap::Iterator * getObjects () throw ()
_DWFTK_API DWFGroup::tMap::Iterator * getGroups () throw ()
_DWFTK_API DWFInstance::tMap::Iterator * getInstances () throw ()
_DWFTK_API DWFPropertySet::tMap::Iterator * getSharedPropertySets () throw ()
_DWFTK_API DWFClassaddClass (const DWFClass::tList &oBaseClass, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFClassaddClass (DWFClass *pBaseClass=NULL, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFEntityaddEntity (const DWFClass::tList &oClass, DWFEntity *pParentEntity=NULL, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFEntityaddEntity (DWFClass *pClass, DWFEntity *pParentEntity=NULL, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFEntityaddEntity (DWFEntity *pParentEntity=NULL, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFObjectaddObject (DWFEntity *pRealizedEntity, DWFObject *pParentObject=NULL, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFFeatureaddFeature (const DWFClass::tList &oClass, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFFeatureaddFeature (DWFClass *pClass=NULL, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFGroupaddGroup (const DWFContentElement::tList &oElements, const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFGroupaddGroup (const DWFString &zUUID=L"") throw ( DWFException )
_DWFTK_API DWFPropertySetaddSharedPropertySet (const DWFString &zLabel=L"", const DWFString &zUUID=L"") throw ()
_DWFTK_API DWFInstanceaddInstance (const DWFString &zResourceID, DWFRenderable *pRenderable, int oNodeID, unsigned int nGraphicsAttribute=DWFInstance::eVisible, int nGeometricVariationIndex=-1) throw ( DWFException )
_DWFTK_API void removeClass (DWFClass *pClass) throw ()
_DWFTK_API void removeClass (const DWFString &zID) throw ()
_DWFTK_API void removeEntity (DWFEntity *pEntity) throw ()
_DWFTK_API void removeEntity (const DWFString &zID) throw ()
_DWFTK_API void removeObject (DWFObject *pObject) throw ()
_DWFTK_API void removeObject (const DWFString &zID) throw ()
_DWFTK_API void removeFeature (DWFFeature *pFeature) throw ()
_DWFTK_API void removeFeature (const DWFString &zID) throw ()
_DWFTK_API void removeGroup (DWFGroup *pGroup) throw ()
_DWFTK_API void removeGroup (const DWFString &zID) throw ()
_DWFTK_API void removeInstance (DWFInstance *pInstance) throw ()
_DWFTK_API void removeInstance (const DWFString &zID) throw ()
_DWFTK_API void removeSharedPropertySet (DWFPropertySet *pPropertySet) throw ()
_DWFTK_API void removeSharedPropertySet (const DWFString &zID) throw ()
_DWFTK_API void addBaseClassToClass (DWFClass *pClass, DWFClass *pBaseClass) throw ()
_DWFTK_API void addClassToEntity (DWFEntity *pEntity, DWFClass *pClass) throw ()
_DWFTK_API void addClassToFeature (DWFFeature *pFeature, DWFClass *pClass) throw ()
_DWFTK_API void addFeatureToEntity (DWFEntity *pEntity, DWFFeature *pFeature) throw ()
_DWFTK_API void addFeatureToObject (DWFObject *pObject, DWFFeature *pFeature) throw ()
_DWFTK_API void addChildEntity (DWFEntity *pParentEntity, DWFEntity *pChildEntity) throw ()
_DWFTK_API void addChildObject (DWFObject *pParentObject, DWFObject *pChildObject) throw ()
_DWFTK_API void addElementToGroup (DWFGroup *pGroup, DWFContentElement *pElement) throw ()
_DWFTK_API void addSharedPropertySetToElement (DWFContentElement *pElement, DWFPropertySet *pPropertySet) throw ( DWFException )
_DWFTK_API void addReferenceToPropertySet (DWFPropertySet *pReferingSet, DWFPropertySet *pPropertySet) throw ( DWFException )
_DWFTK_API void removeBaseClassFromClass (DWFClass *pClass, DWFClass *pBaseClass) throw ()
_DWFTK_API void removeClassFromEntity (DWFEntity *pEntity, DWFClass *pClass) throw ()
_DWFTK_API void removeClassFromFeature (DWFFeature *pFeature, DWFClass *pClass) throw ()
_DWFTK_API void removeFeatureFromEntity (DWFEntity *pEntity, DWFFeature *pFeature) throw ()
_DWFTK_API void removeFeatureFromObject (DWFObject *pObject, DWFFeature *pFeature) throw ()
_DWFTK_API void removeChildEntity (DWFEntity *pParentEntity, DWFEntity *pChildEntity) throw ()
_DWFTK_API void removeChildObject (DWFObject *pParentObject, DWFObject *pChildObject) throw ()
_DWFTK_API void removeElementFromGroup (DWFGroup *pGroup, DWFContentElement *pElement) throw ()
_DWFTK_API void removeSharedPropertySetFromElement (DWFContentElement *pElement, DWFPropertySet *pPropertySet) throw ()
_DWFTK_API DWFUUIDgetIDProvider () const throw ( DWFException )
_DWFTK_API const DWFXMLNamespaceaddNamespace (const DWFString &zNamespace, const DWFString &zXMLNS) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )
_DWFTK_API void setResourceForSerialization (const DWFString &zResourceID) throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API DWFContentReadergetContentReader ()
_DWFTK_API DWFContentResourceReadergetContentResourceReader ()
virtual _DWFTK_API void load (DWFContentReader *pReaderFilter=NULL, unsigned int nProviderFlags=DWFContentReader::eProvideAll) throw ( DWFException )
virtual _DWFTK_API void load (DWFContentReader &rCustomReader) throw ( DWFException )
virtual _DWFTK_API bool unload (bool bSkipIfAnyResourceModified=true) throw ( DWFException )
virtual _DWFTK_API bool unloadResourceInstances (const DWFString &zResourceObjectID, bool bSkipIfResourceModified=true) throw ()
_DWFTK_API DWFInputStreamgetInputStream () throw ( DWFException )
_DWFTK_API void mergeContent (DWFContent *pContent, bool bLocalHasPriority) throw ( DWFException )
_DWFTK_API DWFStringIteratormodifiedContentResources () throw ()
_DWFTK_API bool isSectionContentResourceModified (const DWFString zResourceObjectID) const throw ()
_DWFTK_API void notifyContentResourceAdded (const DWFString &zObjectID) throw ()
_DWFTK_API void notifyResourceIDUpdated (const DWFString &zOldObjectID, const DWFString &zNewObjectID) throw ()
virtual _DWFTK_API const char * provideVersion (const char *zVersion) throw ( DWFException )
virtual _DWFTK_API DWFClassprovideClass (DWFClass *pClass, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFFeatureprovideFeature (DWFFeature *pFeature, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFEntityprovideEntity (DWFEntity *pEntity, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFObjectprovideObject (DWFObject *pObject, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFObjectprovideChildObject (DWFObject *pObject, DWFObject *pParent, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFGroupprovideGroup (DWFGroup *pGroup, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFPropertySetprovideSharedProperty (DWFPropertySet *pPropertySet, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFPropertySetprovidePropertySet (DWFPropertySet *pPropertySet, DWFPropertyContainer *pContainer, const tUnresolvedList &rUnresolved) throw ( DWFException )
virtual _DWFTK_API DWFInstanceprovideInstance (DWFInstance *pInstance, const DWFString &zRenderableID, const DWFString &zResourceObjectID) throw ( DWFException )
virtual _DWFTK_API void resolveClasses () throw ()
virtual _DWFTK_API void resolveFeatures () throw ()
virtual _DWFTK_API void resolveEntities () throw ()
virtual _DWFTK_API void resolveObjects () throw ()
virtual _DWFTK_API void resolveGroups () throw ()
virtual _DWFTK_API void resolvePropertySets () throw ()
virtual _DWFTK_API void resolveInstances () throw ()

Static Public Attributes

static const char *const kzExtension_ContentXML
 ".content.xml"

Friends

class DWFContentManager


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFContent::DWFContent DWFPackageReader pPackageReader,
const DWFString zID = L""
throw ( DWFException )
 

Constructor

This constructor is used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read content information from the DWF package.

Parameters:
pPackageReader Provides access to content in the DWF package.
zID The ID to assign to the content. This should be empty if it will be read in later.
Exceptions:
DWFException 

_DWFTK_API DWFToolkit::DWFContent::DWFContent DWFContentManager pContentManager,
const DWFString zID = L""
throw ( DWFException )
 

Constructor

This constructor is generally used when the content is being created by the manager. This should never be called directly.

Parameters:
pContentManager The manager of this content.
zID The ID to assign to the content. If this is empty, the content manager will provide an ID.
Exceptions:
DWFException 

_DWFTK_API DWFToolkit::DWFContent::~DWFContent  )  throw ()
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFContent::addBaseClassToClass DWFClass pClass,
DWFClass pBaseClass
throw ()
 

Add a baseclass to a class so that it can inherit properties from the baseclass.

Parameters:
pClass Pointer to the class which will inherit properties from the other class.
pBaseClass Pointer to the class to be used as the base class.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::addChildEntity DWFEntity pParentEntity,
DWFEntity pChildEntity
throw ()
 

Create a reference from one entity to another. The user has to be careful not to introduce cyclic dependencies in the entity-entity relationship. Note that this is not a strong relationship in that deleting an entity does not delete child entities. This just allows the creation of a tree of entities to convey the composition. An entity may be the child of multiple entities. The relationship implies that the parent entity uses the child entity or subentity in conveying the design concept.

Parameters:
pParentEntity Pointer to the higher level entity.
pChildEntity Pointer to the sub entity.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::addChildObject DWFObject pParentObject,
DWFObject pChildObject
throw ()
 

Add a child object to the parent object. Unlike entities, this is a strong relationship in that the existence of the child depends parent - deleting the parent deletes the child. The corresponding entities that these objects realize may or may not have the corresponding entity-subentity relationship.

Parameters:
pParentObject Pointer to the parent object.
pChildObject Pointer to the child object.
Exceptions:
None 

_DWFTK_API DWFClass* DWFToolkit::DWFContent::addClass DWFClass pBaseClass = NULL,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFClass to the content

Parameters:
pBaseClass A base class of the new class.
zUUID Optionally, provide the UUID for the new class.
Returns:
A pointer to the new class. This pointer may be NULL if the class could not be created.
Exceptions:
DWFException 

_DWFTK_API DWFClass* DWFToolkit::DWFContent::addClass const DWFClass::tList oBaseClass,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFClass to the content

Parameters:
oBaseClass The list of class to set as its base classes.
zUUID Optionally, provide the UUID for the new class.
Returns:
A pointer to the new class. This pointer may be NULL if the class could not be created.
Exceptions:
DWFException 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API void DWFToolkit::DWFContent::addClassToEntity DWFEntity pEntity,
DWFClass pClass
throw ()
 

Add a class to an entity so that it can inherit properties from the class.

Parameters:
pEntity Pointer to the entity which will inherit properties from the class.
pClass Pointer to the class.
Exceptions:
None 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API void DWFToolkit::DWFContent::addClassToFeature DWFFeature pFeature,
DWFClass pClass
throw ()
 

Add a class to a feature so that it can inherit properties from the class.

Parameters:
pFeature Pointer to the feature which will inherit properties from the class.
pClass Pointer to the class.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::addElementToGroup DWFGroup pGroup,
DWFContentElement pElement
throw ()
 

Add a content element (class, entity, feature, object, group) to a group.

Parameters:
pGroup Pointer to the group to add the element to.
pElement Pointer to the element to add.
Exceptions:
None 

_DWFTK_API DWFEntity* DWFToolkit::DWFContent::addEntity DWFEntity pParentEntity = NULL,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFEntity to the content

Parameters:
pParentEntity Pointer to an entity that will be the parent of the new one. This may be NULL.
zUUID Optionally, provide the UUID for the new entity.
Returns:
A pointer to the new entity. This pointer may be NULL if the entity could not be created.
Exceptions:
DWFException 

_DWFTK_API DWFEntity* DWFToolkit::DWFContent::addEntity DWFClass pClass,
DWFEntity pParentEntity = NULL,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFEntity to the content

Parameters:
pClass A class that provide type information to it.
pParentEntity Pointer to an entity that will be the parent of the new one. This may be NULL.
zUUID Optionally, provide the UUID for the new entity.
Returns:
A pointer to the new entity. This pointer may be NULL if the entity could not be created.
Exceptions:
DWFException 

_DWFTK_API DWFEntity* DWFToolkit::DWFContent::addEntity const DWFClass::tList oClass,
DWFEntity pParentEntity = NULL,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFEntity to the content

Parameters:
oClass The list of classes that provide type information to it.
pParentEntity Pointer to an entity that will be the parent of the new one. This may be NULL.
zUUID Optionally, provide the UUID for the new entity.
Returns:
A pointer to the new entity. This pointer may be NULL if the entity could not be created.
Exceptions:
DWFException 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API DWFFeature* DWFToolkit::DWFContent::addFeature DWFClass pClass = NULL,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFFeature to the content

Parameters:
pClass A class that provide type information to the feature.
zUUID Optionally, provide the UUID for the new feature.
Returns:
A pointer to the new feature. This pointer may be NULL if the feature could not be created.
Exceptions:
DWFException 

_DWFTK_API DWFFeature* DWFToolkit::DWFContent::addFeature const DWFClass::tList oClass,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFFeature to the content

Parameters:
oClass The list of classes that provide type information to it.
zUUID Optionally, provide the UUID for the new feature.
Returns:
A pointer to the new feature. This pointer may be NULL if the feature could not be created.
Exceptions:
DWFException 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API void DWFToolkit::DWFContent::addFeatureToEntity DWFEntity pEntity,
DWFFeature pFeature
throw ()
 

Add a feature to an entity.

Parameters:
pEntity Pointer to the entity.
pFeature Pointer to the feature.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::addFeatureToObject DWFObject pObject,
DWFFeature pFeature
throw ()
 

Add a feature to an object.

Parameters:
pObject Pointer to the object.
pFeature Pointer to the feature.
Exceptions:
None 

_DWFTK_API DWFGroup* DWFToolkit::DWFContent::addGroup const DWFString zUUID = L""  )  throw ( DWFException )
 

Add a DWFGroup to the content

Parameters:
zUUID Optionally, provide the UUID for the new group.
Returns:
A pointer to the new group. This pointer may be NULL if the instance could not be created.
Exceptions:
DWFException 

_DWFTK_API DWFGroup* DWFToolkit::DWFContent::addGroup const DWFContentElement::tList oElements,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFGroup to the content

Parameters:
oElements The list of elements to add to the group.
zUUID Optionally, provide the UUID for the new group.
Returns:
A pointer to the new group. This pointer may be NULL if the instance could not be created.
Exceptions:
DWFException 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API DWFInstance* DWFToolkit::DWFContent::addInstance const DWFString zResourceID,
DWFRenderable pRenderable,
int  oNodeID,
unsigned int  nGraphicsAttribute = DWFInstance::eVisible,
int  nGeometricVariationIndex = -1
throw ( DWFException )
 

Add a DWFInstance to the content

Parameters:
zResourceID The resource that is associated with and will serialize this instance.
pRenderable The object or feature that this instance is rendering.
oNodeID The graphics node ID associated with the renderable item.
nGraphicsAttribute The visibility and transparency of the instance given by the flags in DWFInstance::teAttributes.
nGeometricVariationIndex The index of the geometric variation to show. -1 indicates there are none.
Returns:
A pointer to the new instance. This pointer may be NULL if the instance could not be created.
Exceptions:
A DWFInvalidArgumentException is thrown if the pointer to the renderable item is NULL.
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API const DWFXMLNamespace& DWFToolkit::DWFContent::addNamespace const DWFString zNamespace,
const DWFString zXMLNS
throw ( DWFException )
 

_DWFTK_API DWFObject* DWFToolkit::DWFContent::addObject DWFEntity pRealizedEntity,
DWFObject pParentObject = NULL,
const DWFString zUUID = L""
throw ( DWFException )
 

Add a DWFObject to the content

Parameters:
pRealizedEntity Pointer to the entity the new object will realize. This should not be NULL.
pParentObject Pointer to an object that will be the parent of the new one. This may be NULL.
zUUID Optionally, provide the UUID for the new object.
Returns:
A pointer to the new object. This pointer may be NULL if the entity could not be created.
Exceptions:
DWFException. 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API void DWFToolkit::DWFContent::addReferenceToPropertySet DWFPropertySet pReferingSet,
DWFPropertySet pPropertySet
throw ( DWFException )
 

Add a shared property set to a property set or property set derived class in the content. The referenced property set should be in the contents collection of shared properties.

Parameters:
pReferingSet Pointer to the set to which the container will be added.
pPropertySet Pointer to the shared property set.
Exceptions:
DWFException The exception is thrown if the set is not in the content already.

_DWFTK_API DWFPropertySet* DWFToolkit::DWFContent::addSharedPropertySet const DWFString zLabel = L"",
const DWFString zUUID = L""
throw ()
 

Add a DWFPropertySet to the content to hold a property collection shared by multiple items.

Parameters:
zLabel An optional label for the property set.
zUUID Optionally, provide the UUID for the new set.
Returns:
A pointer to the new property set. This pointer may be NULL if the container could not be created.
Exceptions:
None 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API void DWFToolkit::DWFContent::addSharedPropertySetToElement DWFContentElement pElement,
DWFPropertySet pPropertySet
throw ( DWFException )
 

Add a shared property set to an element. Property queries on the element will treat the properties and property sets in this set as properties of the element. The property set must already be in the contents collection of shared properties.

Parameters:
pElement Pointer to the element to which the container will be added.
pPropertySet Pointer to the shared property set.
Exceptions:
DWFException The exception is thrown if the set is not in the content already.
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API DWFClass::tIterator* DWFToolkit::DWFContent::findClassByBaseClass const DWFString zID  )  throw ()
 

Find all classes classified by a given id.

Parameters:
zID The UUID of the class being referred to as the base class.
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 

_DWFTK_API DWFClass::tIterator* DWFToolkit::DWFContent::findClassByBaseClass DWFClass pBaseClass  )  throw ()
 

Find all classes classified by a given base class.

Parameters:
pBaseClass The class being referred to as the base class.
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 

_DWFTK_API DWFEntity::tIterator* DWFToolkit::DWFContent::findEntitiesByClass const DWFString zID  )  throw ()
 

Find all entities classified by a given class.

Parameters:
zID The UUID of the class being referred by the entities.
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 

_DWFTK_API DWFEntity::tIterator* DWFToolkit::DWFContent::findEntitiesByClass DWFClass pClass  )  throw ()
 

Find all entities classified by a given class.

Parameters:
pClass The class being referred by the entities.
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.

_DWFTK_API DWFEntity::tIterator* DWFToolkit::DWFContent::findEntitiesByFeature const DWFString zID  )  throw ()
 

Find all entities using the given feature.

Parameters:
zID The UUID of the feature being used.
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 

_DWFTK_API DWFEntity::tIterator* DWFToolkit::DWFContent::findEntitiesByFeature DWFFeature pFeature  )  throw ()
 

Find all entities using the given feature.

Parameters:
pFeature The feature being used.
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 

_DWFTK_API DWFFeature::tIterator* DWFToolkit::DWFContent::findFeaturesByClass const DWFString zID  )  throw ()
 

Find all features classified by a given class.

Parameters:
zID The UUID of the class being referred by the features.
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 

_DWFTK_API DWFFeature::tIterator* DWFToolkit::DWFContent::findFeaturesByClass DWFClass pClass  )  throw ()
 

Find all features classified by a given class.

Parameters:
pClass The class being referred by the features.
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 

_DWFTK_API DWFGroup::tIterator* DWFToolkit::DWFContent::findGroupsByElement const DWFString zID  )  throw ()
 

Find all groups containing a given element.

Parameters:
zID The UUID of the content element contained by the groups.
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 

_DWFTK_API DWFGroup::tIterator* DWFToolkit::DWFContent::findGroupsByElement DWFContentElement pElement  )  throw ()
 

Find all groups containing a given element.

Parameters:
pElement The content element being contained by the groups.
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 

_DWFTK_API DWFInstance::tIterator* DWFToolkit::DWFContent::findInstancesByRenderable const DWFString zRenderedID,
const DWFString zResourceObjectID = L""
throw ()
 

Find all instances rendering the given renderable, i.e., object or feature.

Parameters:
zRenderedID The UUID of the renderable (object or feature).
zResourceObjectID If this is provided, only instances in that resource will 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 

_DWFTK_API DWFInstance::tIterator* DWFToolkit::DWFContent::findInstancesByRenderable DWFRenderable pRendered,
const DWFString zResourceObjectID = L""
throw ()
 

Find all instances rendering the given renderable, i.e., object or feature.

Parameters:
pRendered The renderable (object or feature).
zResourceObjectID If this is provided, only instances in that resource will 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. If the item is not find this will be NULL.
Exceptions:
None 

_DWFTK_API DWFInstance::tIterator* DWFToolkit::DWFContent::findInstancesByResourceID const DWFString zResourceObjectID  )  const throw ( DWFException )
 

Find all instances associated with a resource object ID.

Parameters:
zResourceObjectID The resource object ID for which we want all instances.
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:
DWFException This is thrown if no such resource ID is found

_DWFTK_API DWFObject::tIterator* DWFToolkit::DWFContent::findObjectsByEntity const DWFString zID  )  throw ()
 

Find all objects realizing the given entity.

Parameters:
zID The UUID of the entity being realized.
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 

_DWFTK_API DWFObject::tIterator* DWFToolkit::DWFContent::findObjectsByEntity DWFEntity pEntity  )  throw ()
 

Find all objects realizing the given entity.

Parameters:
pEntity The entity being realized.
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.

_DWFTK_API DWFObject::tIterator* DWFToolkit::DWFContent::findObjectsByFeature const DWFString zID  )  throw ()
 

Find all objects using the given feature.

Parameters:
zID The UUID of the feature being used.
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 

_DWFTK_API DWFObject::tIterator* DWFToolkit::DWFContent::findObjectsByFeature DWFFeature pFeature  )  throw ()
 

Find all objects using the given feature.

Parameters:
pFeature The feature being used.
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 

_DWFTK_API DWFIterator<DWFString>* DWFToolkit::DWFContent::findResourceIDsByRenderable const DWFString zID  )  throw ()
 

Find all resource object IDs that are associated with instances of the given renderable (object/feature).

Parameters:
zID The UUID of the renderable (object or feature).
Returns:
A pointer to an iterator over resource object IDs (DWFStrings) that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL.
Exceptions:
None 

_DWFTK_API DWFIterator<DWFString>* DWFToolkit::DWFContent::findResourceIDsByRenderable DWFRenderable pRenderable  )  throw ()
 

Find all resource object IDs that are associated with instances of the given renderable (object/feature).

Parameters:
pRenderable Pointer to the renderable object or feature.
Returns:
A pointer to an iterator over resource object IDs (DWFStrings) that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL.
Exceptions:
None 

_DWFTK_API DWFClass* DWFToolkit::DWFContent::getClass const DWFString zID  )  throw ()
 

Get a class by its UUID.

Parameters:
zID The UUID of the class.
Returns:
A pointer to the class. This pointer may be NULL if the class is not found in this content.
Exceptions:
None 

_DWFTK_API DWFClass::tMap::Iterator* DWFToolkit::DWFContent::getClasses  )  throw () [inline]
 

Get an iterator over all classes in the content, keyed off their IDs.

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 590 of file Content.h.

_DWFTK_API DWFContentManager* DWFToolkit::DWFContent::getContentManager  )  throw () [inline]
 

Get the content manager managing this content

Returns:
A pointer to the content manager
Exceptions:
None 

Definition at line 478 of file Content.h.

_DWFTK_API DWFContentReader* DWFToolkit::DWFContent::getContentReader  )  [inline]
 

Access the content reader base of the content.

Returns:
A content reader pointer
Exceptions:
None 

Definition at line 1330 of file Content.h.

_DWFTK_API DWFContentResourceReader* DWFToolkit::DWFContent::getContentResourceReader  )  [inline]
 

Access the content resource reader base of the content.

Returns:
A content resource reader pointer
Exceptions:
None 

Definition at line 1342 of file Content.h.

_DWFTK_API DWFContentElement* DWFToolkit::DWFContent::getElement const DWFString zID  )  throw ()
 

Get an element by its UUID. This will be slower than the specific type based queries since all types will be queried individually, until the element is found or the list of types is exhausted.

Parameters:
zID The UUID of the element.
Returns:
A pointer to the element. This pointer may be NULL if the element is not found in this content.
Exceptions:
None 

_DWFTK_API DWFEntity::tMap::Iterator* DWFToolkit::DWFContent::getEntities  )  throw () [inline]
 

Get an iterator over all entities in the content, keyed off their IDs.

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 619 of file Content.h.

_DWFTK_API DWFEntity* DWFToolkit::DWFContent::getEntity const DWFString zID  )  throw ()
 

Get an entity by its UUID.

Parameters:
zID The UUID of the entity.
Returns:
A pointer to the class. This pointer may be NULL if the entity is not found in this content.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

_DWFTK_API DWFFeature* DWFToolkit::DWFContent::getFeature const DWFString zID  )  throw ()
 

Get a feature by its UUID.

Parameters:
zID The UUID of the feature.
Returns:
A pointer to the feature. This pointer may be NULL if the feature is not found in this content.
Exceptions:
None 

_DWFTK_API DWFFeature::tMap::Iterator* DWFToolkit::DWFContent::getFeatures  )  throw () [inline]
 

Get an iterator over all features in the content, keyed off their IDs.

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 604 of file Content.h.

_DWFTK_API DWFGroup* DWFToolkit::DWFContent::getGroup const DWFString zID  )  throw ()
 

Get a group by its UUID.

Parameters:
zID The UUID of the group.
Returns:
A pointer to the group. This pointer may be NULL if the group is not found in this content.
Exceptions:
None 

_DWFTK_API DWFGroup::tMap::Iterator* DWFToolkit::DWFContent::getGroups  )  throw () [inline]
 

Get an iterator over all groups in the content, keyed off their IDs.

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 648 of file Content.h.

_DWFTK_API DWFUUID* DWFToolkit::DWFContent::getIDProvider  )  const throw ( DWFException )
 

Get the UUID generator. This is used to generate IDs for various items that require ID, such that there is some correlation in the ID values - thus aiding compression.

Returns:
Pointer to the UUID generator.
Exceptions:
DWDFException 
Examples:
WriteContent/WriteContent.cpp.

_DWFTK_API DWFInputStream* DWFToolkit::DWFContent::getInputStream  )  throw ( DWFException )
 

If the content is being read in from a package, the input stream can be requested using this call.

Returns:
The input stream for the content.
Exceptions:
DWFException 

_DWFTK_API DWFInstance* DWFToolkit::DWFContent::getInstance const DWFString zID  )  throw ()
 

Get an instance by its UUID.

Parameters:
zID The UUID of the instance.
Returns:
A pointer to the instance. This pointer may be NULL if the instance is not found in this content.
Exceptions:
None 

_DWFTK_API DWFInstance::tMap::Iterator* DWFToolkit::DWFContent::getInstances  )  throw () [inline]
 

Get an iterator over all instances in the content, keyed off their IDs.

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 662 of file Content.h.

_DWFTK_API DWFObject* DWFToolkit::DWFContent::getObject const DWFString zID  )  throw ()
 

Get an object by its UUID.

Parameters:
zID The UUID of the object.
Returns:
A pointer to the object. This pointer may be NULL if the object is not found in this content.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

_DWFTK_API DWFObject::tMap::Iterator* DWFToolkit::DWFContent::getObjects  )  throw () [inline]
 

Get an iterator over all objects in the content, keyed off their IDs.

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 634 of file Content.h.

_DWFTK_API DWFPropertySet* DWFToolkit::DWFContent::getSharedPropertySet const DWFString zID  )  throw ()
 

Get a shared property set by its UUID.

Parameters:
zID The UUID of the property set.
Returns:
A pointer to the property set. This pointer may be NULL if the set is not found in this content.
Exceptions:
None 

_DWFTK_API DWFPropertySet::tMap::Iterator* DWFToolkit::DWFContent::getSharedPropertySets  )  throw () [inline]
 

Get an iterator over all shared property sets in the content, keyed off their IDs.

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 676 of file Content.h.

_DWFTK_API DWFString DWFToolkit::DWFContent::href  )  throw ()
 

Get the href of the content.

Returns:
The href of the content
Exceptions:
None 

_DWFTK_API const DWFString& DWFToolkit::DWFContent::id  )  const throw () [inline]
 

Get the UUID of the content

Returns:
The UUID of the content
Exceptions:
None 

Definition at line 165 of file Content.h.

_DWFTK_API bool DWFToolkit::DWFContent::isLoaded  )  const throw () [inline]
 

Get the loaded state of the content. If a package is being read in from a file or a stream, we may have the content in an unloaded state in which none of it's elements have been read in.

Returns:
The "loaded" state of the content - true or false
Exceptions:
None 

Definition at line 203 of file Content.h.

_DWFTK_API bool DWFToolkit::DWFContent::isResourceLoaded const DWFString zResourceObjectID  )  throw ()
 

Determine whether a content resource has been loaded into the content. Note this will return true the moment instance from that resource has been added the content.

Parameters:
zResourceObjectID The object ID of the resource.
Returns:
The "loaded" state of content resource from a section - true or false.
Exceptions:
None 

_DWFTK_API bool DWFToolkit::DWFContent::isSectionContentResourceModified const DWFString  zResourceObjectID  )  const throw () [inline]
 

Determine whether list of instances from a resource were modified, using the resource object ID.

Exceptions:
None 
Since:
7.3

Definition at line 1462 of file Content.h.

virtual _DWFTK_API void DWFToolkit::DWFContent::load DWFContentReader rCustomReader  )  throw ( DWFException ) [virtual]
 

This parses the content document using the provided content reader. This allows the user to directly participate in the parsing process. No in-memory representation of the content will be created or cached by the DWFContent.

Parameters:
rCustomReader The custom content reader.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFContent::load DWFContentReader pReaderFilter = NULL,
unsigned int  nProviderFlags = DWFContentReader::eProvideAll
throw ( DWFException ) [virtual]
 

This parses the content document using the default content reader implemented by this content class, and loads the resulting objects into the content. If a filter is provided, it will be set on the default reader. If the content has already been loaded, this will do nothing until the content has been unload()-ed.

Parameters:
pReaderFilter If provided, this will be set on the default reader.
nProviderFlags DWFContentReader provider flags
Exceptions:
DWFException 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

_DWFTK_API void DWFToolkit::DWFContent::mergeContent DWFContent pContent,
bool  bLocalHasPriority
throw ( DWFException )
 

Merge the content elements and shared property sets from the input content into this content. If bLocalHasPriority is true, upon an UUID collision, the local content will be kept, otherwise the source content properties are copied. This should not be called directly. Instead the corresponding method on the DWFPackageWriter or the DWFContentManager should be called.

_DWFTK_API DWFStringIterator* DWFToolkit::DWFContent::modifiedContentResources  )  throw ()
 

Get the collection of resource object IDs for resources that have had their instance list modified.

Returns:
A pointed to an iterator over resource object IDs. The caller must delete the iterator using DWFCORE_FREE_OBJECT.
Exceptions:
None 
Since:
7.3

_DWFTK_API void DWFToolkit::DWFContent::notifyContentResourceAdded const DWFString zObjectID  )  throw ()
 

For internal use only.

This notification is called by the section content resource when it is created.

Parameters:
zObjectID The object ID of the resource.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::notifyResourceIDUpdated const DWFString zOldObjectID,
const DWFString zNewObjectID
throw ()
 

For internal use only.

This notification is called by the section content resource whenever the ID of a resource associated with content instances, is changed.

Parameters:
zOldObjectID The old object ID of the resource.
zNewObjectID The new object ID of the resource.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContent::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLBuildable.

virtual _DWFTK_API DWFObject* DWFToolkit::DWFContent::provideChildObject DWFObject pObject,
DWFObject pParent,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts content objects that have parent content objects.

Parameters:
pObject The new object. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
pParent The content object that will become the parent.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered object object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFClass* DWFToolkit::DWFContent::provideClass DWFClass pClass,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts class element objects.

Parameters:
pClass The new class. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered class object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFEntity* DWFToolkit::DWFContent::provideEntity DWFEntity pEntity,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts entity element objects.

Parameters:
pEntity The new entity. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered entity object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFFeature* DWFToolkit::DWFContent::provideFeature DWFFeature pFeature,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts feature element objects.

Parameters:
pFeature The new feature. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered feature object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFGroup* DWFToolkit::DWFContent::provideGroup DWFGroup pGroup,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts group element objects.

Parameters:
pGroup The new group. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered group object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFInstance* DWFToolkit::DWFContent::provideInstance DWFInstance pInstance,
const DWFString zRenderableID,
const DWFString zResourceObjectID
throw ( DWFException ) [virtual]
 

Accepts instance element objects.

Parameters:
pInstance The new instance. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
zRenderableID The renderable element ID of the instance.
zResourceObjectID The ID of the resource from which this instance is being read.
Returns:
The filtered instance object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentResourceReader.

virtual _DWFTK_API DWFObject* DWFToolkit::DWFContent::provideObject DWFObject pObject,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts object element objects.

Parameters:
pObject The new object. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered object object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFPropertySet* DWFToolkit::DWFContent::providePropertySet DWFPropertySet pPropertySet,
DWFPropertyContainer pContainer,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts property sets contained by content elements or other property sets.

Parameters:
pPropertySet The new shared property set. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
pContainer The content element or property set that will own the property set.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered property object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API DWFPropertySet* DWFToolkit::DWFContent::provideSharedProperty DWFPropertySet pPropertySet,
const tUnresolvedList rUnresolved
throw ( DWFException ) [virtual]
 

Accepts property sets targeted for the shared property collection.

Parameters:
pPropertySet The new shared property set. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
rUnresolved List of unresolved attributes from the parsing process.
Returns:
The filtered property object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API const char* DWFToolkit::DWFContent::provideVersion const char *  zVersion  )  throw ( DWFException ) [virtual]
 

Accepts the content document version number attribute.

Parameters:
zVersion The document version.
Returns:
The filtered document version.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

_DWFTK_API void DWFToolkit::DWFContent::removeBaseClassFromClass DWFClass pClass,
DWFClass pBaseClass
throw ()
 

Remove reference to a baseclass from a class.

Parameters:
pClass Pointer to the class.
pBaseClass Pointer to the class being refered to as the base class.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeChildEntity DWFEntity pParentEntity,
DWFEntity pChildEntity
throw ()
 

Remove reference to a child entity from a entity.

Parameters:
pParentEntity Pointer to the parent entity.
pChildEntity Pointer to the child entity.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeChildObject DWFObject pParentObject,
DWFObject pChildObject
throw ()
 

Remove a child object from an object.

Parameters:
pParentObject Pointer to the parent object.
pChildObject Pointer to the child object.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeClass const DWFString zID  )  throw ()
 

Delete a class from the DWFContent. This will also remove references to the class in other classes, entities and features.

Parameters:
zID UUID of the class to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeClass DWFClass pClass  )  throw ()
 

Delete a class from the DWFContent. This will also remove references to the class in other classes, entities and features.

Parameters:
pClass Pointer to the class to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeClassFromEntity DWFEntity pEntity,
DWFClass pClass
throw ()
 

Remove reference to a class from an entity.

Parameters:
pEntity Pointer to the entity.
pClass Pointer to the class being referenced.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeClassFromFeature DWFFeature pFeature,
DWFClass pClass
throw ()
 

Remove reference to a class from a feature.

Parameters:
pFeature Pointer to the feature.
pClass Pointer to the class being referenced.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeElementFromGroup DWFGroup pGroup,
DWFContentElement pElement
throw ()
 

Remove a content element from a group.

Parameters:
pGroup Pointer to the group.
pElement Pointer to the content element.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeEntity const DWFString zID  )  throw ()
 

Delete an entity from the DWFContent. This also results in the deletion of objects that realize this entity. This in turn deletes all descendent objects. For object deleted the instance is also deleted.

Parameters:
zID UUID of the entity to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeEntity DWFEntity pEntity  )  throw ()
 

Delete an entity from the DWFContent. This also results in the deletion of objects that realize this entity. This in turn deletes all descendent objects. For object deleted the instance is also deleted.

Parameters:
pEntity Pointer to the entity to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeFeature const DWFString zID  )  throw ()
 

Delete a feature from the DWFContent. This in turn requires that all associated instances be deleted. This will also remove all references to the feature from objects and entities refering to it.

Parameters:
zID UUID of the feature to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeFeature DWFFeature pFeature  )  throw ()
 

Delete a feature from the DWFContent. This in turn requires that all associated instances be deleted. This will also remove all references to the feature from objects and entities refering to it.

Parameters:
pFeature Pointer to the feature to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeFeatureFromEntity DWFEntity pEntity,
DWFFeature pFeature
throw ()
 

Remove reference to a feature from an entity.

Parameters:
pEntity Pointer to the entity.
pFeature Pointer to the feature being referenced.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeFeatureFromObject DWFObject pObject,
DWFFeature pFeature
throw ()
 

Remove reference to a feature from an object.

Parameters:
pObject Pointer to the object.
pFeature Pointer to the feature being referenced.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeGroup const DWFString zID  )  throw ()
 

Delete a group from the DWFContent.

Parameters:
zID UUID of the group to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeGroup DWFGroup pGroup  )  throw ()
 

Delete a group from the DWFContent.

Parameters:
pGroup Pointer to the group to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeInstance const DWFString zID  )  throw ()
 

Delete an instance from the DWFContent.

Parameters:
zID UUID of the instance to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeInstance DWFInstance pInstance  )  throw ()
 

Delete an instance from the DWFContent.

Parameters:
pInstance Pointer to the instance being deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeObject const DWFString zID  )  throw ()
 

Delete an object from the DWFContent. All descendent objects are also be deleted. This in turn requires that all associated instances be deleted.

Parameters:
zID UUID of the object to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeObject DWFObject pObject  )  throw ()
 

Delete an object from the DWFContent. All descendent objects are also be deleted. This in turn requires that all associated instances be deleted.

Parameters:
pObject Pointer to the object to be deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeSharedPropertySet const DWFString zID  )  throw ()
 

Delete a shared property set from the DWFContent.

Parameters:
zID ID of the property set being deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeSharedPropertySet DWFPropertySet pPropertySet  )  throw ()
 

Delete a shared property set from the DWFContent.

Parameters:
pPropertySet Pointer to the set being deleted.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFContent::removeSharedPropertySetFromElement DWFContentElement pElement,
DWFPropertySet pPropertySet
throw ()
 

Remove a shared property set from a content element.

Parameters:
pElement Pointer to the content element.
pPropertySet Pointer to the property set.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContent::resolveClasses  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading the collection of classes.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API void DWFToolkit::DWFContent::resolveEntities  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading the collection of entities.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API void DWFToolkit::DWFContent::resolveFeatures  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading the collection of features.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API void DWFToolkit::DWFContent::resolveGroups  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading the collection of groups.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API void DWFToolkit::DWFContent::resolveInstances  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading the collection of instances.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentResourceReader.

virtual _DWFTK_API void DWFToolkit::DWFContent::resolveObjects  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading the collection of objects.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

virtual _DWFTK_API void DWFToolkit::DWFContent::resolvePropertySets  )  throw () [virtual]
 

Resolve the string based ID references into actual pointers. This is called once the reader has finished reading all property sets, i.e. when all collections are complete.

Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentReader.

_DWFTK_API void DWFToolkit::DWFContent::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException )
 

_DWFTK_API void DWFToolkit::DWFContent::setContentManager DWFContentManager pContentManager  )  [inline]
 

This should only be used by the reading code to set the manager when the content has been created by the reader.

Parameters:
pContentManager The content manager pointer.
Exceptions:
None 

Definition at line 466 of file Content.h.

_DWFTK_API void DWFToolkit::DWFContent::setHRef const DWFString zHRef  )  throw () [inline]
 

Sets the href of the content.

Parameters:
zHRef The href of the content
Returns:
None
Exceptions:
None 

Definition at line 179 of file Content.h.

_DWFTK_API void DWFToolkit::DWFContent::setResourceForSerialization const DWFString zResourceID  )  throw () [inline]
 

For internal use only.

This allows the section content resource to let the content know that its section is about to be serialized and that the section should serialize the section's instances.

Parameters:
zResourceID The ID of the resource, whose instance will be serialized.
Exceptions:
None 

Definition at line 1306 of file Content.h.

virtual _DWFTK_API bool DWFToolkit::DWFContent::unload bool  bSkipIfAnyResourceModified = true  )  throw ( DWFException ) [virtual]
 

This completely unloads the content, included DWFInstances that may have been loaded via the section getContent calls. If bSkipIfAnyResourceModified is true, and the list of instances associated with that any of the section content resources has been modified, the unload will not happen and the method will return false.

Parameters:
bSkipIfAnyResourceModified Prevent unload of the resource if this is true and the instance list has changed, unload anyway if false.
Returns:
True if the unload was performed.
Exceptions:
DWFExcepion 

virtual _DWFTK_API bool DWFToolkit::DWFContent::unloadResourceInstances const DWFString zResourceObjectID,
bool  bSkipIfResourceModified = true
throw () [virtual]
 

This unloads the content all instances that were loaded from the resource with the provide resource object identifier. If bSkipIfResourceModified is true, and the list of instances associated with that resource ID has been modified, the unload will not happen and the method will return false.

Parameters:
zResourceObjectID The object identifier of the resource whose instances will be unloaded.
bSkipIfResourceModified Prevent unload of the resource if this is true and the instance list has changed.
Returns:
True if the resource object ID was found and the resource instances were unloaded.
Exceptions:
None 


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