WT_UserData Class Reference
[Support objects]

#include <userdata.h>

Inheritance diagram for WT_UserData:

Inheritance graph
[legend]
Collaboration diagram for WT_UserData:

Collaboration graph
[legend]
List of all members.

Detailed Description

An object containing user-defined data.

This data is generally ignored by any rendering applications which are not specifically designed to recognize the user-defined data.

Examples:

WhipExamples/UserData.cpp.

Definition at line 39 of file userdata.h.

Public Member Functions

 WT_UserData ()
 Constructs a WT_UserData object.
 WT_UserData (const WT_String &data_description)
 Constructs a WT_UserData object with the given description.
 WT_UserData (const WT_String &data_description, WT_Integer32 data_size, WT_Byte *data, WT_Boolean copy) throw (WT_Result)
 Constructs a WT_UserData object with the given data.
virtual ~WT_UserData ()
 Destroys a WT_UserData object.
WT_Byte const * data () const
 Returns a read-only pointer to the data buffer containing the raw user data.
const WT_Stringdata_description () const
 Returns the description of this user-defined data.
WT_Stringdata_description ()
WT_Integer32 const & data_size () const
 Returns the size of the data buffer containing the user-defined data. */.
WT_Integer32data_size ()
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_UserData &item, WT_File &file)
 Provides a default action handler for this object.

Friends

class WT_W2D_Class_Factory
class WT_Opcode


Constructor & Destructor Documentation

WT_UserData::WT_UserData const WT_String data_description,
WT_Integer32  data_size,
WT_Byte data,
WT_Boolean  copy
throw (WT_Result)
 

Constructs a WT_UserData object with the given data.

Parameters:
data_description  Description of the user-defined data.
data_size  Size of the data array in bytes.
data  Byte buffer containing user-defined data.
copy  Whether the data should be copied or if its content should be used directly from the array.


Member Function Documentation

static WT_Result WT_UserData::default_process WT_UserData 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_UserData::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_UserData::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_UserData::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.

Examples:
WhipExamples/UserData.cpp.

WT_Result WT_UserData::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:28 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5