DWFToolkit::DWFSectionContentResource Class Reference
[DWF Package API]

#include "dwf/package/SectionContentResource.h"

Collaboration diagram for DWFToolkit::DWFSectionContentResource:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to publish and read the DWFInstance data related to a section.

Since:
7.2.0
This resource allows the section to publish and parse the resource-related instance data stored in the associated content library.
Examples:

WriteContent/WriteContent.cpp.

Definition at line 57 of file SectionContentResource.h.

Public Member Functions

_DWFTK_API DWFSectionContentResource (DWFContent *pContent) throw ( DWFException )
_DWFTK_API DWFSectionContentResource (DWFPackageReader *pPackageReader) throw ( DWFException )
virtual _DWFTK_API ~DWFSectionContentResource () throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API DWFString contentID () const throw ()
virtual _DWFTK_API void setObjectID (const DWFString &zObjectID) throw ()
virtual _DWFTK_API DWFInputStreamgetInputStream (bool bCache=false) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )
_DWFTK_API DWFContentgetContent () const throw ()


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSectionContentResource::DWFSectionContentResource DWFContent pContent  )  throw ( DWFException )
 

Constructor

Parameters:
pContent The content library in which the resource instances are stored.
Exceptions:
DWFException is thrown if pContent is NULL.

_DWFTK_API DWFToolkit::DWFSectionContentResource::DWFSectionContentResource DWFPackageReader pPackageReader  )  throw ( DWFException )
 

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 resource content data from the DWF package.

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

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API DWFString DWFToolkit::DWFSectionContentResource::contentID  )  const throw () [inline]
 

A section content resource should only have one content associated with it. This method provides direct access to the one and only content ID in this resource

Definition at line 111 of file SectionContentResource.h.

_DWFTK_API DWFContent* DWFToolkit::DWFSectionContentResource::getContent  )  const throw ()
 

Access associated content.

Returns:
A pointer to the assocaited content.
Exceptions:
None 

virtual _DWFTK_API DWFInputStream* DWFToolkit::DWFSectionContentResource::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 section specific content information.

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 

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

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

virtual _DWFTK_API void DWFToolkit::DWFSectionContentResource::setObjectID const DWFString zObjectID  )  throw () [virtual]
 

Sets the resource object ID.

Parameters:
zObjectID A unique identifier.
Exceptions:
None 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:34 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5