WT_Directory Class Reference

#include <directory.h>

Inheritance diagram for WT_Directory:

Inheritance graph
[legend]
Collaboration diagram for WT_Directory:

Collaboration graph
[legend]
List of all members.

Detailed Description

A linked list of WT_BlockRef objects.

Deprecated:
This class is provided for backward compatibiility with DWF 00.55 files. This object is managed by the framework and is not typically used by client code.
Examples:

WhipExamples/OutputBlocks.cpp, and WhipExamples/ReadTwoBlocks.cpp.

Definition at line 35 of file directory.h.

Public Member Functions

 WT_Directory ()
 Constructs a WT_Directory object.
 WT_Directory (const WT_Directory &directory)
 Constructs a WT_Directory object. Copy constructor.
virtual ~WT_Directory ()
 Destroys a WT_Directory object.
WT_Result add (WT_BlockRef &item)
 Adds a WT_BlockRef item to the list.
WT_BlockRefblockref_from_index (WT_Integer32 index)
 Returns the WT_BlockRef with the given index (returns NULL if not found.).
WT_Integer32 index_from_blockref (WT_BlockRef &item_in)
 Returns the index of the given WT_BlockRef in the list if found (returns -1 if not found.).
WT_Unsigned_Integer32 get_file_offset ()
 Returns the offset of the WT_Directory object within the file.
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.
WT_Directory const & operator= (WT_Directory const &blockref)
 Assignment operator. Assigns the given list contents to this one.
WT_Boolean operator== (WT_Directory const &list) const
 Equality operator. Returns WD_True if the given list's contents is equal to this one.

Static Public Member Functions

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


Member Function Documentation

static WT_Result WT_Directory::default_process WT_Directory 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_Directory::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_Directory::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_Directory::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_Directory::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:16 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5