GEE_ParamWriter Class Reference

A Utility class for reading and writing parameters to/from a stream. More...

#include <gee_param_writer.h>

List of all members.

Public Types

• enum Type {
    FLOAT, INT, ID, BOOL,
    MATRIX3, MATRIX4, MATRIX4D, VECTOR3,
    VECTOR4, STLSTRING
  }

Public Member Functions

• GEE_ParamWriter ()
• virtual ~GEE_ParamWriter ()
• bool writeParameters (GEE_Io *)
• bool readParameters (GEE_Io *)
• void clear ()
• void addMemberFloat (ushort id, const float *x)
• void addMemberInt (ushort id, const int *x)
• void addMemberUInt (ushort id, const unsigned *x)
• void addMemberId (ushort id, const GEE_id_t *x)
• void addMemberBool (ushort id, const bool *x)
• void addMemberVector3 (ushort id, const VEE_Vector3 *x)
• void addMemberVector4 (ushort id, const VEE_Vector4 *x)
• void addMemberMatrix3 (ushort id, const VEE_Matrix3 *x)
• void addMemberMatrix4 (ushort id, const VEE_Matrix4 *x)
• void addMemberMatrix4d (ushort id, const VEE_Matrix4d *x)
• void addMember (Type, ushort, const void *)

Classes

• class Item

---

Detailed Description

A Utility class for reading and writing parameters to/from a stream.

This class uses a mighty brutal approach: The client gives pointers to the parameters that need IO management. GEE_ParamWriter computes offset values to those variables from "this"-pointer.

Important: The parameters must be relative to "this"-pointer. If they are not then the offset values will get broken whenever objects are copied.

This class is best used by either inheriting it or using it as a member variable in some class.

Author:

Tommi Ilmonen.

---

Member Enumeration Documentation

enum GEE_ParamWriter::Type

Enumerator: FLOAT  INT  ID  BOOL  MATRIX3  MATRIX4  MATRIX4D  VECTOR3  VECTOR4  STLSTRING

---

Constructor & Destructor Documentation

GEE_ParamWriter::GEE_ParamWriter (   )

GEE_ParamWriter::~GEE_ParamWriter (   )  [virtual]

---

Member Function Documentation

bool GEE_ParamWriter::writeParameters (  GEE_Io *   )

bool GEE_ParamWriter::readParameters (  GEE_Io *   )

void GEE_ParamWriter::clear (   )

void GEE_ParamWriter::addMemberFloat (  ushort  id, const float *  x )  [inline]

void GEE_ParamWriter::addMemberInt (  ushort  id, const int *  x )  [inline]

void GEE_ParamWriter::addMemberUInt (  ushort  id, const unsigned *  x )  [inline]

void GEE_ParamWriter::addMemberId (  ushort  id, const GEE_id_t *  x )  [inline]

void GEE_ParamWriter::addMemberBool (  ushort  id, const bool *  x )  [inline]

void GEE_ParamWriter::addMemberVector3 (  ushort  id, const VEE_Vector3 *  x )  [inline]

void GEE_ParamWriter::addMemberVector4 (  ushort  id, const VEE_Vector4 *  x )  [inline]

void GEE_ParamWriter::addMemberMatrix3 (  ushort  id, const VEE_Matrix3 *  x )  [inline]

void GEE_ParamWriter::addMemberMatrix4 (  ushort  id, const VEE_Matrix4 *  x )  [inline]

void GEE_ParamWriter::addMemberMatrix4d (  ushort  id, const VEE_Matrix4d *  x )  [inline]

void GEE_ParamWriter::addMember (  Type  , ushort  , const void *  )

---

The documentation for this class was generated from the following files:

• gee_param_writer.h
• gee_param_writer.C

---