DWFToolkit::DWFObjectDefinitionResource Class Reference
[DWF Package API]

#include "dwf/package/ObjectDefinitionResource.h"

Inheritance diagram for DWFToolkit::DWFObjectDefinitionResource:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to create and publish an object definition document.

Since:
7.0.1
This resource class is slightly different from the others in the toolkit in that it is only ever created by the publishing application. This allows the publisher to associate different object definitions with other resources in the same section; specifically, in most cases, tying object instances to graphic nodes.

Todo:
While resources of this type are not created by the parsing process due to efficiency issues (on-demand object/property resolution), it might be more consistent to merge this object and the DWFObjectDefinition together.
Examples:

GlobalSectionWriter/GlobalSectionWriter.cpp, and SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp.

Definition at line 56 of file ObjectDefinitionResource.h.

Public Member Functions

_DWFTK_API DWFObjectDefinitionResource (const DWFString &zType, const DWFString &zRole) throw ()
virtual _DWFTK_API ~DWFObjectDefinitionResource () throw ()
virtual _DWFTK_API DWFInputStreamgetInputStream (bool bCache=false) 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 )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFObjectDefinitionResource::DWFObjectDefinitionResource const DWFString zType,
const DWFString zRole
throw ()
 

Constructor

Parameters:
zType The root element defining the document type. Document types known (but not restricted) to the toolkit currently are:
zRole Describes the role of the document. Roles known (but not restricted) to the toolkit currently are:
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API const DWFXMLNamespace& DWFToolkit::DWFObjectDefinitionResource::addNamespace const DWFString zNamespace,
const DWFString zXMLNS
throw ( DWFException ) [virtual]
 

Reimplemented from DWFCore::DWFXMLSerializableBase.

virtual _DWFTK_API DWFInputStream* DWFToolkit::DWFObjectDefinitionResource::getInputStream bool  bCache = false  )  throw ( DWFException ) [virtual]
 

Provides a stream for reading the resource data.

This method implementation differs from the base class in that an in-memory representation of the entire document is generated on the fly from the current state of the contained objects and instances.

Parameters:
bCache This parameter is ignored.
Returns:
A pointer to a data stream. The caller is responsible for releasing the pointer with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFResource.

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

Reimplemented from DWFToolkit::DWFResource.


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