WT_End_Of_DWF Class Reference
[Support objects]

#include <endofdwf.h>

Inheritance diagram for WT_End_Of_DWF:

Inheritance graph
[legend]
Collaboration diagram for WT_End_Of_DWF:

Collaboration graph
[legend]
List of all members.

Detailed Description

Indicates the end of the WHIP! data.

Note:
Internal use only - not intended for direct use by client code.

Definition at line 38 of file endofdwf.h.

Public Member Functions

 WT_End_Of_DWF ()
 Constructs a WT_End_Of_DWF object.
virtual ~WT_End_Of_DWF ()
WT_Result materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Type object_type () const
 Returns the WT_Type for this object.
WT_Result process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
WT_Result serialize (WT_File &file) const
 Causes the serialization of the object to the file.
WT_Result skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.

Static Public Member Functions

static WT_Result default_process (WT_End_Of_DWF &item, WT_File &file)
 Provides a default action handler for this object.

Friends

class WT_W2D_Class_Factory
class WT_Opcode
class WT_File


Member Function Documentation

static WT_Result WT_End_Of_DWF::default_process WT_End_Of_DWF item,
WT_File file
[static]
 

Provides a default action handler for this object.

Warning:
This is used by the framework and should not be called by client code.
Parameters:
item  The object to process.
file  The file being read.

WT_Result WT_End_Of_DWF::materialize WT_Opcode const &  opcode,
WT_File file
[virtual]
 

Materializes the contents of the object from the file and the given opcode.

Reads in the object data and causes the file reading to proceed to the end of this object.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.
WT_Result::Opcode_Not_Valid_For_This_Object The object does not support the opcode type.
WT_Result::Internal_Error Something went very wrong.

Implements WT_Object.

WT_Result WT_End_Of_DWF::process WT_File file  )  [virtual]
 

Calls the configured action handler for this object (passes in the file reference.).

Warning:
This is used by the framework and should not be called by client code.

Implements WT_Object.

WT_Result WT_End_Of_DWF::serialize WT_File file  )  const [virtual]
 

Causes the serialization of the object to the file.

If this is a WT_Drawable derived object, this method may cause the object to be delayed (in case a coincident like-object follows) and/or merged (in case a coincident like-object preceeded) so as to optimize the output.

Return values:
WT_Result::Success The operation was successful.

Implements WT_Object.

WT_Result WT_End_Of_DWF::skip_operand WT_Opcode const &  opcode,
WT_File file
[virtual]
 

Causes the file reading to proceed to the end of this object.

Warning:
This is used by the framework and should not be called by client code.
Bug:
Not all objects perform skip_operand() correctly; this is a known problem. For best results, if client code must use WT_File::get_next_object_shell() manually, it should also call the corresponding WT_Object::materialize() method to avoid this problem.
See also:
WT_File::get_next_object_shell(), WT_File_Heuristics::set_deferred_delete().

Reimplemented from WT_Object.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:17 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5