Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFInterface Class Reference
[DWF Package API]

#include "dwf/package/Interface.h"

Inheritance diagram for DWFToolkit::DWFInterface:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class identifies the existence of a section type in a DWF package.
Since:
7.0.1.

Definition at line 48 of file Interface.h.

Public Types

typedef vector< DWFInterface * > tList
 This type defines a list of DWFInterface pointers.

Public Member Functions

_DWFTK_API DWFInterface () throw ()
_DWFTK_API DWFInterface (const DWFString &zName, const DWFString &zHRef, const DWFString &zObjectID) throw ()
virtual _DWFTK_API ~DWFInterface () throw ()
_DWFTK_API const DWFStringname () const throw ()
_DWFTK_API const DWFStringhref () const throw ()
_DWFTK_API const DWFStringobjectID () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Static Public Attributes

static const wchar_t *const kzEPlot_Name
 L"ePlot".
static const wchar_t *const kzEPlot_HRef
 L"http://www.autodesk.com/viewers";.
static const wchar_t *const kzEPlot_ID
 L"715941D4-1AC2-4545-8185-BC40E053B551";.
static const wchar_t *const kzEModel_Name
 L"eModel".
static const wchar_t *const kzEModel_HRef
 L"http://www.autodesk.com/viewers";.
static const wchar_t *const kzEModel_ID
 L"75E513A9-6C41-4C91-BAA6-81E593FAAC10";.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFInterface::DWFInterface  )  throw ()
 

Constructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFInterface::DWFInterface const DWFString zName,
const DWFString zHRef,
const DWFString zObjectID
throw ()
 

Constructor

Parameters:
zName The name of the section interface. Usually corresponds to the section type, either exactly or in abbreviation.
zHRef A location where more information or specifications for handling this section can be found.
zObjectID Uniquely identifies the section interface.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API const DWFString& DWFToolkit::DWFInterface::href  )  const throw () [inline]
 

Returns the interface link location where more information or specifications for handling this section can be found.

Returns:
The interface HRef.
Exceptions:
None 

Definition at line 148 of file Interface.h.

_DWFTK_API const DWFString& DWFToolkit::DWFInterface::name  )  const throw () [inline]
 

Returns the interface name.

The name of the section interface. Usually corresponds to the section type, either exactly or in abbreviation.

Returns:
The interface name.
Exceptions:
None 

Definition at line 135 of file Interface.h.

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

Returns the interface identifier that uniquely identifies the section interface

Returns:
The interface object ID.
Exceptions:
None 

Definition at line 161 of file Interface.h.

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

Receives and processes an attribute list from the parser; using it to initialize class members.

Example:

                 size_t iAttrib = 0;
       
                 for(; ppAttributeList[iAttrib]; iAttrib += 2)
                 {
                    //
                    // dump attribute 
                    //
                    cout << "Attribute Name: " << ppAttributeList[iAttrib] << " ";
                    cout << "Attribute Value: " << ppAttributeList[iAttrib+1] << endl;
                }

Parameters:
ppAttributeList An array of null-terminated atribute name, value string pairs. The array itself is zero-terminated.
Exceptions:
None 

Implements DWFToolkit::DWFXMLBuildable.

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

Writes an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
nFlags An implementation-defined set of options for altering the serialization process of this object.

Implements DWFToolkit::DWFXMLSerializable.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:00 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1