DWFToolkit::DWFManifest Class Reference
[DWF Package API]

#include "dwf/package/Manifest.h"

Inheritance diagram for DWFToolkit::DWFManifest:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents a fully parsed DWF package manifest document.

Since:
7.0.1
Examples:

Aggregate/Aggregate.cpp, ReadContentDefinition/ReadContentDefinition.cpp, SimpleEnumReader/SimpleEnumReader.cpp, SimpleW3DStreamProcessor/SimpleW3DStreamProcessor.cpp, and TimedXMLReader/TimedXMLReader.cpp.

Definition at line 65 of file Manifest.h.

Public Types

typedef DWFWCharKeySkipList<
DWFInterface * >::Iterator 
tInterfaceIterator
 This type defines the iterator for enumerating manifest interfaces.

Public Member Functions

_DWFTK_API DWFManifest (DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFManifest (const DWFString &zObjectID) throw ()
virtual _DWFTK_API ~DWFManifest () throw ()
_DWFTK_API double version () const throw ()
_DWFTK_API const DWFStringobjectID () const throw ()
_DWFTK_API tInterfaceIteratorgetInterfaces () throw ()
_DWFTK_API DWFSectionfindSectionByName (const DWFString &zName) throw ()
_DWFTK_API SectionIteratorfindSectionsByType (const DWFString &zType) throw ()
_DWFTK_API SectionIteratorgetSections () throw ()
_DWFTK_API SectionIteratorgetGlobalSections () throw ()
_DWFTK_API DWFContentManagergetContentManager () const throw ()
_DWFTK_API DWFContentPresentation::tList::IteratorgetContentPresentations () throw ()
_DWFTK_API DWFContentPresentation::tList::ConstIteratorgetContentPresentations () const throw ()
_DWFTK_API void attachContentManager (DWFContentManager *pContentManager, bool bTakeOwnership=true, bool bDeletePrevious=true) throw ( DWFException )
_DWFTK_API double provideVersion (double nVersion) throw ()
_DWFTK_API const char * provideObjectID (const char *zObjectID) throw ()
_DWFTK_API DWFDependencyprovideDependency (DWFDependency *pDependency) throw ()
_DWFTK_API DWFInterfaceprovideInterface (DWFInterface *pInterface) throw ()
_DWFTK_API DWFPropertyprovideProperty (DWFProperty *pProperty) throw ()
_DWFTK_API DWFSectionprovideSection (DWFSection *pSection) throw ()
_DWFTK_API DWFContentprovideContent (DWFContent *pContent) throw ( DWFException )
_DWFTK_API DWFPackageContentPresentationsprovideContentPresentations (DWFPackageContentPresentations *pPackageContentPresentations) throw ()
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Protected Member Functions

virtual _DWFTK_API void notifyOwnerChanged (DWFOwnable &rOwnable) throw ( DWFException )
virtual _DWFTK_API void notifyOwnableDeletion (DWFOwnable &rOwnable) throw ( DWFException )

Classes

class  SectionIterator
 This class defines the iterator for enumerating manifest sections. More...


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFManifest::DWFManifest DWFPackageReader pPackageReader  )  throw ()
 

Constructor

This constructor is generally only 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 from the DWF package.

Parameters:
pPackageReader Provides access to section content in the DWF package.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFManifest::DWFManifest const DWFString zObjectID  )  throw ()
 

Constructor

This constructor is generally used by applications and publishers for creating a package manifest.

Parameters:
zObjectID Uniquely identifies the manifest.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFManifest::attachContentManager DWFContentManager pContentManager,
bool  bTakeOwnership = true,
bool  bDeletePrevious = true
throw ( DWFException )
 

This attaches the content manager to the manifest. The manifest will take ownership of the manager, only if requested to.

Parameters:
pContentManager The content manager to attach.
bTakeOwnership Set this to true if the manifest should take ownership.
bDeletePrevious Set this to true if a previously attached content manager should be deleted.
Exceptions:
DWFException 

_DWFTK_API DWFSection* DWFToolkit::DWFManifest::findSectionByName const DWFString zName  )  throw ()
 

Locates a section in the manifest by name.

Parameters:
zName The unique name of the section in the package.
Returns:
A pointer to the section, if it exists, NULL otherwise. The caller must not delete this pointer without explicitly claiming ownership of it using the DWFCore::DWFOwnable interface exposed by DWFSection.
Exceptions:
None 

_DWFTK_API SectionIterator* DWFToolkit::DWFManifest::findSectionsByType const DWFString zType  )  throw ()
 

Locates all sections in the manifest that share a type.

Parameters:
zType The type of sections to locate.
Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL. The caller must not delete any section pointers obtained from the iterator without explicitly claiming ownership of it using the DWFCore::DWFOwnable interface exposed by DWFSection.
Exceptions:
None 
Examples:
SimpleW3DStreamProcessor/SimpleW3DStreamProcessor.cpp.

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

Get the content manager from the manifest. The caller should not delete the content manager unless it was attached to the manifest using attachContentManager with bTakeOwnership set to false.

Returns:
A pointer the to content manager that the manifest points to.
Exceptions:
None 
Examples:
ReadContentDefinition/ReadContentDefinition.cpp.

Definition at line 391 of file Manifest.h.

_DWFTK_API DWFContentPresentation::tList::ConstIterator* DWFToolkit::DWFManifest::getContentPresentations  )  const throw () [inline]
 

Gets the package level content presentations.

Returns:
A pointer to a const iterator for enumerating the presentations (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Presentations returned from the iterator are owned by the container and must not be deleted by the caller.
Exceptions:
None 

Definition at line 433 of file Manifest.h.

_DWFTK_API DWFContentPresentation::tList::Iterator* DWFToolkit::DWFManifest::getContentPresentations  )  throw () [inline]
 

Gets the package level content presentations.

Returns:
A pointer to an iterator for enumerating the presentations (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Presentations returned from the iterator are owned by the container and must not be deleted by the caller.
Exceptions:
None 

Definition at line 409 of file Manifest.h.

_DWFTK_API SectionIterator* DWFToolkit::DWFManifest::getGlobalSections  )  throw ()
 

Locates all global sections in the package.

Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL. The caller must not delete any section pointers obtained from the iterator without explicitly claiming ownership of it using the DWFCore::DWFOwnable interface exposed by DWFSection.
Exceptions:
None 

_DWFTK_API tInterfaceIterator* DWFToolkit::DWFManifest::getInterfaces  )  throw ()
 

Returns an iterator for listing each unique section interface in the manifest.

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 SectionIterator* DWFToolkit::DWFManifest::getSections  )  throw ()
 

Locates all non-global sections in the package.

Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL. The caller must not delete any section pointers obtained from the iterator without explicitly claiming ownership of it using the DWFCore::DWFOwnable interface exposed by DWFSection.
Exceptions:
None 
Examples:
Aggregate/Aggregate.cpp, ReadContentDefinition/ReadContentDefinition.cpp, SimpleEnumReader/SimpleEnumReader.cpp, and TimedXMLReader/TimedXMLReader.cpp.

virtual _DWFTK_API void DWFToolkit::DWFManifest::notifyOwnableDeletion DWFOwnable rOwnable  )  throw ( DWFException ) [protected, virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFManifest::notifyOwnerChanged DWFOwnable rOwnable  )  throw ( DWFException ) [protected, virtual]
 

_DWFTK_API const DWFString& DWFToolkit::DWFManifest::objectID  )  const throw () [inline]
 

Returns the unique identifer of the manifest document.

Returns:
The manifest object ID.
Exceptions:
None 

Definition at line 311 of file Manifest.h.

_DWFTK_API DWFContent* DWFToolkit::DWFManifest::provideContent DWFContent pContent  )  throw ( DWFException ) [virtual]
 

Set the content manager pointed to by the manifest.

If the owner of the content manager is null, the manifest will take ownership. If it already has a owner, the manifest maybe explicitly granted the ownership by calling the manager's own() method. To revoke ownership (to prevent it's deletion with the manifest) call the manager's disown() method.

Parameters:
pContent The new content manager.
Exceptions:
None. 

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API DWFPackageContentPresentations* DWFToolkit::DWFManifest::provideContentPresentations DWFPackageContentPresentations pPackageContentPresentations  )  throw () [virtual]
 

Accepts package level content content presentation

Parameters:
pPackageContentPresentations The new package content presentations. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered package content presentation object.
Exceptions:
None 
Since:
7.3

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API DWFDependency* DWFToolkit::DWFManifest::provideDependency DWFDependency pDependency  )  throw () [virtual]
 

Accepts dependency element objects.

Parameters:
pDependency The new dependency. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered dependency object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API DWFInterface* DWFToolkit::DWFManifest::provideInterface DWFInterface pInterface  )  throw () [virtual]
 

Accepts interface element objects.

Parameters:
pInterface The new interface. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered interface object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API const char* DWFToolkit::DWFManifest::provideObjectID const char *  zObjectID  )  throw () [virtual]
 

Accepts the unique manifest document identifier attribute.

Parameters:
zObjectID The document ID.
Returns:
The filtered document ID.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API DWFProperty* DWFToolkit::DWFManifest::provideProperty DWFProperty pProperty  )  throw () [virtual]
 

Accepts property element objects.

Parameters:
pProperty The new property. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered property object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API DWFSection* DWFToolkit::DWFManifest::provideSection DWFSection pSection  )  throw () [virtual]
 

Accepts section element objects.

Parameters:
pSection The new section. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered section object.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API double DWFToolkit::DWFManifest::provideVersion double  nVersion  )  throw () [virtual]
 

Accepts the manifest document version number attribute.

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

Reimplemented from DWFToolkit::DWFManifestReader.

_DWFTK_API void DWFToolkit::DWFManifest::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLSerializableBase.

_DWFTK_API double DWFToolkit::DWFManifest::version  )  const throw () [inline]
 

Returns version of the manifest document schema.

Returns:
The version number.
Exceptions:
None 
Examples:
SimpleEnumReader/SimpleEnumReader.cpp.

Definition at line 298 of file Manifest.h.


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