DWFToolkit::DWFEPlotSection Class Reference
[DWF Package API]

#include "dwf/package/EPlotSection.h"

Inheritance diagram for DWFToolkit::DWFEPlotSection:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

An EPlot section encapsulates a 2D data model in the DWF package.

Since:
7.0.1
The type constant for these object is _DWF_FORMAT_EPLOT_TYPE_STRING (defined in dwf/Version.h)
Examples:

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

Definition at line 52 of file EPlotSection.h.

Public Types

typedef DWFWCharKeySkipList<
DWFEPlotSection * > 
tMap
 This type defines a mapped collection of DWFEPlotSection pointers.
typedef std::multimap< const
wchar_t *, DWFEPlotSection *,
tDWFWCharCompareLess
tMultiMap
 This type defines a multi-value mapped collection of DWFEPlotSection pointers.

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFEPlotSection *) tList
 This type defines a list of DWFEPlotSection pointers.
_DWFTK_API DWFEPlotSection (const DWFString &zName, const DWFString &zTitle, DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFEPlotSection (const DWFString &zTitle, const DWFString &zObjectID, double nPlotOrder, const DWFSource &rSource, unsigned int nColorARGB, const DWFPaper *pPaper) throw ()
virtual _DWFTK_API ~DWFEPlotSection () throw ()
_DWFTK_API unsigned int color () const throw ()
_DWFTK_API DWFPaperpaper () const throw ()
virtual _DWFTK_API void setPaper (const DWFPaper *pPaper) throw (DWFException)
_DWFTK_API DWFInterfacebuildInterface () throw ( DWFException )
_DWFTK_API const DWFResourcereadDescriptor (DWFSectionDescriptorReader *pSectionDescriptorReader=NULL) const throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )
_DWFTK_API const char * provideName (const char *zName) throw ()
_DWFTK_API const char * provideObjectID (const char *zObjectID) throw ()
_DWFTK_API double provideVersion (double nVersion) throw ()
_DWFTK_API double providePlotOrder (double nPlotOrder) throw ()
_DWFTK_API unsigned int provideColor (unsigned int nColorARGB) throw ()
_DWFTK_API DWFPaperprovidePaper (DWFPaper *pPaper) throw ()
_DWFTK_API DWFPropertyprovideProperty (DWFProperty *pProperty) throw ()
_DWFTK_API DWFResourceprovideResource (DWFResource *pResource) throw ()
_DWFTK_API DWFFontResourceprovideFontResource (DWFFontResource *pResource) throw ()
_DWFTK_API DWFGraphicResourceprovideGraphicResource (DWFGraphicResource *pResource) throw ()
_DWFTK_API DWFImageResourceprovideImageResource (DWFImageResource *pResource) throw ()
_DWFTK_API DWFContentPresentationResourceprovideContentPresentationResource (DWFContentPresentationResource *pResource) throw ()

Classes

class  Factory
 Class factory for DWFEPlotSection objects. More...


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFEPlotSection::DWFEPlotSection const DWFString zName,
const DWFString zTitle,
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 section content data from the DWF package.

Parameters:
zName A string that uniquely identifies the section in the DWF package.
zTitle The descriptive and display friendly title text.
pPackageReader Provides access to section content in the DWF package.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFEPlotSection::DWFEPlotSection const DWFString zTitle,
const DWFString zObjectID,
double  nPlotOrder,
const DWFSource rSource,
unsigned int  nColorARGB,
const DWFPaper pPaper
throw ()
 

Constructor

This constructor is generally used by applications and publishers for creating new section objects.

Parameters:
zTitle The descriptive and display friendly title text.
zObjectID Uniquely identifies the section.
nPlotOrder Indicates the initial position in the package to which the section was/will be published.
rSource Describes the original source of the data in the section (a drawing file, for example.)
nColorARGB Deprecated. Not used.
pPaper Defines the virtual paper onto which the 2D section graphics will be placed. This parameter is required if any graphic resources are added to the section. A copy will be made of this object, the caller remains responsible for deleting this pointer.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API DWFInterface* DWFToolkit::DWFEPlotSection::buildInterface  )  throw ( DWFException ) [virtual]
 

Returns the interface associated with an EModel section.

This interface will be defined with the following constant data:

name: DWFInterface::kzEPlot_Name href: DWFInterface::kzEPlot_HRef id: DWFInterface::kzEPlot_ID

Returns:
A pointer to a new interface object. This object will be allocated using the DWFCORE_ALLOC_OBJECT macro and must be deleted by the caller using the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFSection.

_DWFTK_API unsigned int DWFToolkit::DWFEPlotSection::color  )  const throw () [inline]
 

Deprecated:
This attribute is not used.

Definition at line 182 of file EPlotSection.h.

_DWFTK_API DWFPaper* DWFToolkit::DWFEPlotSection::paper  )  const throw () [inline]
 

Returns the paper onto which all 2D graphics will be plotted.

Returns:
A pointer to the paper object (may be NULL)
Exceptions:
None 

Definition at line 195 of file EPlotSection.h.

_DWFTK_API unsigned int DWFToolkit::DWFEPlotSection::provideColor unsigned int  nColorARGB  )  throw ()
 

Accepts the section color attribute.

Parameters:
nColorARGB The color value.
Returns:
The filtered color value.
Exceptions:
None 

_DWFTK_API DWFContentPresentationResource* DWFToolkit::DWFEPlotSection::provideContentPresentationResource DWFContentPresentationResource pResource  )  throw ()
 

Accepts content presentation resource element objects

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

_DWFTK_API DWFFontResource* DWFToolkit::DWFEPlotSection::provideFontResource DWFFontResource pResource  )  throw ()
 

Accepts font resource element objects.

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

_DWFTK_API DWFGraphicResource* DWFToolkit::DWFEPlotSection::provideGraphicResource DWFGraphicResource pResource  )  throw ()
 

Accepts graphic resource element objects.

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

_DWFTK_API DWFImageResource* DWFToolkit::DWFEPlotSection::provideImageResource DWFImageResource pResource  )  throw ()
 

Accepts image resource element objects.

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

_DWFTK_API const char* DWFToolkit::DWFEPlotSection::provideName const char *  zName  )  throw ()
 

Accepts the section name attribute.

Parameters:
zName The section name.
Returns:
The filtered section name.
Exceptions:
None 

_DWFTK_API const char* DWFToolkit::DWFEPlotSection::provideObjectID const char *  zObjectID  )  throw ()
 

Accepts the section identifier attribute.

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

_DWFTK_API DWFPaper* DWFToolkit::DWFEPlotSection::providePaper DWFPaper pPaper  )  throw ()
 

Accepts paper element objects.

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

_DWFTK_API double DWFToolkit::DWFEPlotSection::providePlotOrder double  nPlotOrder  )  throw ()
 

Accepts the section plot order attribute.

Parameters:
nPlotOrder The plot order.
Returns:
The filtered plot order.
Exceptions:
None 

_DWFTK_API DWFProperty* DWFToolkit::DWFEPlotSection::provideProperty DWFProperty pProperty  )  throw ()
 

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 

_DWFTK_API DWFResource* DWFToolkit::DWFEPlotSection::provideResource DWFResource pResource  )  throw ()
 

Accepts resource element objects.

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

_DWFTK_API double DWFToolkit::DWFEPlotSection::provideVersion double  nVersion  )  throw ()
 

Accepts the descriptor document version attribute.

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

_DWFTK_API const DWFResource& DWFToolkit::DWFEPlotSection::readDescriptor DWFSectionDescriptorReader pSectionDescriptorReader = NULL  )  const throw ( DWFException ) [virtual]
 

Locates the one descriptor resource in the section and parses it accordingly with the reader provided or the default reader implementation for this section by this object.

As a specialized section class, this class knows how to parse EPlot section descriptor documents and build a data model from them. It derives this functionality by implementing the DWFEPlotSectionDescriptorReader interface. There are two ways to affect the default parsing process. The first of which is to provide a non-NULL interface pointer to this method via the pSectionDescriptorReader parameter. This will bypass this object entirely and process the descriptor using the reader provided. Alternatively, this object can still be used to read the descriptor document but every provider callback can be intercepted using a filter. A filter is just another implementation of the DWFEPlotSectionDescriptorReader set on this object before this call is made using the DWFSectionDescriptorReader::setFilter() method. When a filter is applied, the reader will provide data to the filter interface first and then, depending on how the filter responds, pass the data into the default (this object) provider callback.

Parameters:
pSectionDescriptorReader An optional interface pointer to an object that knows how to read and parse EPlot section descriptor documents.
Returns:
A reference to the EPlot descriptor document resource.
Exceptions:
DWFException 

Reimplemented from DWFToolkit::DWFSection.

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

Reimplemented from DWFToolkit::DWFSection.

virtual _DWFTK_API void DWFToolkit::DWFEPlotSection::setPaper const DWFPaper pPaper  )  throw (DWFException) [virtual]
 

Sets the section's paper.

Parameters:
pPaper Defines the virtual paper onto which the 2D section graphics will be placed. This parameter is required if any graphic resources are added to the section. A copy will be made of this object, the caller remains responsible for deleting this pointer.
Exceptions:
None 
Since:
7.4.0


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