W3DOpcodeHandler Interface Reference

#include "dwf/w3dtk/W3DOpcodeHandler.h"

Inheritance diagram for W3DOpcodeHandler:

Inheritance graph
[legend]
Collaboration diagram for W3DOpcodeHandler:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class shim for BOpcodeHandlers.

Since:
1.0.1000

Definition at line 94 of file W3DOpcodeHandler.h.

Public Member Functions

virtual ~W3DOpcodeHandler ()
void setObserver (BaseOpcodeHandlerObserver *pObserver) throw ()
virtual void serialize (const void *pTag=NULL)=0 throw ( DWFException )
virtual unsigned int version () throw ()

Protected Member Functions

 W3DOpcodeHandler (BaseOpcodeHandlerObserver *pObserver=NULL) throw ()

Protected Attributes

unsigned int _nRequiredVersion
BaseOpcodeHandlerObserver_pObserver


Constructor & Destructor Documentation

virtual W3DOpcodeHandler::~W3DOpcodeHandler  )  [inline, virtual]
 

Destructor

Definition at line 102 of file W3DOpcodeHandler.h.

W3DOpcodeHandler::W3DOpcodeHandler BaseOpcodeHandlerObserver pObserver = NULL  )  throw () [inline, protected]
 

Constructor

Parameters:
pObserver The object to notify when this handler is serialized.

Definition at line 148 of file W3DOpcodeHandler.h.


Member Function Documentation

virtual void W3DOpcodeHandler::serialize const void *  pTag = NULL  )  throw ( DWFException ) [pure virtual]
 

This method will write the handler's opcode and data to the W3D stream.

Parameters:
pTag An optional tag to associate the data.
Exceptions:
DWFException 

Implemented in BBaseOpcodeHandler, and TK_Shell.

void W3DOpcodeHandler::setObserver BaseOpcodeHandlerObserver pObserver  )  throw () [inline]
 

This object can be notified when this handler is serialized.

Parameters:
pObserver The object to notify.

Definition at line 110 of file W3DOpcodeHandler.h.

virtual unsigned int W3DOpcodeHandler::version  )  throw () [inline, virtual]
 

This method returns the minimum stream version required to support the data and options captured in the opcode.

Returns:
The minimum version required for support. This is the integer representation of the stream version (i.e. 1000, 1236, etc.) This method returns 0 if there is no existing version restriction.
Since:
1.2.1236

Definition at line 135 of file W3DOpcodeHandler.h.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:41:49 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5