GVectors Namespace Reference

The namespace for libgvectors related symbols. More...


Classes

class  BinaryReader
 The template used to read a VectorStore from a binary file. More...
class  BinaryWriter
 Class for writing a binary vector store file to disk. More...
class  Color
 Represents a color in RGB style. More...
class  Coordinates
 Class representing 2D coordinates. More...
class  Drawer
 A pure abstract class for drawing primitives. More...
class  FileReader
 The base template class for reading a VectorStore from disk. More...
class  FileWriter
 The FileWriter pure abstract class. More...
class  GVector
 Class representing a 3D vector. More...
struct  BFileHeaderV_0_1
 The header of a binary vector store file. More...
struct  BFileVectorV_0_1
 Representing a VisualVector in a binary vector store file. More...
class  GVException
 The base exception class. More...
class  GVEUnsupported
 Unsupported function called. More...
class  GVEDynCastFailed
 dynamic_cast failed. More...
class  GVEItemNotFound
 An item in the vector store was not found. More...
class  GVEInvalidMatrixIndex
 An invalid matrix index has been requested. More...
class  GVEInvalidMDimension
 The matrix passed to the function has an invalid dimension. More...
class  GVEStoreCorrupt
 The vector store has been corrupted. More...
class  GVEWrongFileVersion
 The binary vector store file has an unkown version. More...
class  GVEXMLFileWrite
 Error writing the vector store to a XML vector store file. More...
class  GVEXMLInvalid
 The XML vector store file has an invalid structure. More...
class  Matrix
 The base matrix class. More...
class  Matrix4x1
 A 4x1 matrix. More...
class  Matrix4x4
 A 4x4 matrix. More...
class  Rotation
 The Rotation class. More...
class  Segment
 Class representing a segment. More...
class  VectorStore
 Class for storing VisualVector object in a hierarchical manner. More...
class  VisualVector
 Class intended to visualize a GVector. More...
class  VDelete
 Used to delete vector store items. More...
class  VSetOrigin
 Class used to set the origin of vector store items. More...
class  VSetScale
 Class used to set the scale of vector store items. More...
class  VSetArrowLength
 Class used to set the arrow length of vector store items. More...
class  VSetRotation
 Class used to set the rotation of vector store items. More...
class  VDraw
 Class used to draw VisualVectors. More...
class  VRemoveItemByAddress
 Class used to remove items according their memory addresses. More...
class  GetMinMax
 Class for getting minimum and maximum. More...
class  ForEachMinMax
 Class for using GetMinMax with std::for_each(). More...
class  SyncLookup
 Class used to synchronize the lookup map. More...
class  FindTopLevel
 Finds the top level item serving as root for the given id. More...
class  CountItems
 Counts the item stored in the vector store. More...
class  SaveItems
 Writes items to disk using the given FileWriter. More...
class  VStoreID
 Provides vector store ids. More...
class  VStoreItem
 Class used to store a VisualVector in a VectorStore. More...
class  XMLReader
 The template class for reading XML vector store files. More...
class  XMLWriter
 The class writing a VectorStore to disk. More...

Typedefs

typedef Coordinatesco_ptr_t
 Convenience typedef.
typedef Coordinatesco_ref_t
 Convenience typedef.
typedef const Coordinatesconst_co_ptr_t
 Convenience typedef.
typedef const Coordinatesconst_co_ref_t
 Convenience typedef.
typedef GVectorgv_ptr_t
 Convenience typedef.
typedef GVectorgv_ref_t
 Convenience typedef.
typedef const GVectorconst_gv_ptr_t
 Convenience typedef.
typedef const GVectorconst_gv_ref_t
 Convenience typedef.
typedef int vslevel_t
 Represents the level of nesting in vector store.
typedef unsigned long vssize_t
 Holds the vector store size.
typedef unsigned long gvid_t
 Type of the vector store id.
typedef unsigned int matindex_t
 Type used to index a matrix.
typedef Segmentse_ptr_t
 Convenience typedef.
typedef Segmentse_ref_t
 Convenience typedef.
typedef const Segmentconst_se_ptr_t
 Convenience typedef.
typedef const Segmentconst_se_ref_t
 Convenience typedef.
typedef VisualVectorvv_ptr_t
 Convenience typedef.
typedef VisualVectorvv_ref_t
 Convenience typedef.
typedef const VisualVectorconst_vv_ptr_t
 Convenience typedef.
typedef const VisualVectorconst_vv_ref_t
 Convenience typedef.
typedef VStoreItemvsi_ptr_t
 Convenience typedef.
typedef VStoreItemvsi_ref_t
 Convenience typedef.
typedef const VStoreItemconst_vsi_ptr_t
 Convenience typedef.
typedef const VStoreItemconst_vsi_ref_t
 Convenience typedef.

Enumerations

enum  Angle_Type { ANG_DEG, ANG_RAD, ANG_GRAD }
 Type of angle measurement. More...
enum  { TOP_LEVEL_NUM = 1 }
enum  { GVID_NONE = 0 }
enum  BinaryFileVersion { BWVER_0_1 = 1 }
 The binary vector store file versions. More...
enum  BinaryFileEndianess { BWLITTLE_E = 0, BWBIG_E = 1 }
 Describes the endianess of a binary vector store file. More...
enum  XMLIndentation {
  XML_IND_ONE = 1, XML_IND_TWO = 2, XML_IND_THREE = 3, XML_IND_FOUR = 4,
  XML_IND_FIVE = 5
}
 The predefined indentation. More...

Functions

double Degree ()
 Used to convert to and from degrees.

Variables

const std::string VERSION_0_1 = "0.1"
 The version of the XML Vector Store file.
const std::string NODE_NAME_VECTOR = "vector"
 The node name of a vector.
const std::string NODE_NAME_COORDINATES = "coordinates"
 The name of the coordinates node.
const std::string NODE_NAME_COMPONENTS [4]
 The names of the nodes in a coordinates node.
const std::string NODE_NAME_XCOMP = "xcomp"
 The name of the x component node.
const std::string NODE_NAME_YCOMP = "ycomp"
 The name of the y component node.
const std::string NODE_NAME_ZCOMP = "zcomp"
 The name of the z component node.
const std::string NODE_NAME_COLOR = "color"
 The name of the color node.
const std::string NODE_NAME_COLORS [4]
 The names of the nodes in a color node.
const std::string NODE_NAME_RED = "red"
 The name of the red component node.
const std::string NODE_NAME_GREEN = "green"
 The name of the green component node.
const std::string NODE_NAME_BLUE = "blue"
 The name of the blue component node.


Detailed Description

Namespace for libgvectors related symbols. This is the only namespace used in the library.


Typedef Documentation

typedef Coordinates* GVectors::co_ptr_t

Typedefs a pointer to a Coordinates class.

typedef Coordinates& GVectors::co_ref_t

Typedefs a reference to a Coordinates class.

typedef const Coordinates* GVectors::const_co_ptr_t

Typedefs a const pointer to a Coordinates class.

typedef const Coordinates& GVectors::const_co_ref_t

Typedefs a const reference to a Coordinates class.

typedef GVector* GVectors::gv_ptr_t

Typedefs a pointer to a GVector class.

typedef GVector& GVectors::gv_ref_t

Typedefs a reference to a GVector class.

typedef const GVector* GVectors::const_gv_ptr_t

Typedefs a const pointer to a GVector class.

typedef const GVector& GVectors::const_gv_ref_t

Typedefs a const reference to a GVector class.

typedef int GVectors::vslevel_t

Type used to represent the level of nesting in the vector store.

typedef unsigned long GVectors::vssize_t

Type used to hold the vector store size in terms of items.

typedef unsigned long GVectors::gvid_t

This type is used to hold the vector store id.

typedef unsigned int GVectors::matindex_t

This type is used as the index type of the matrix classes.

typedef Segment* GVectors::se_ptr_t

Typedefs a pointer to a Segment class.

typedef Segment& GVectors::se_ref_t

Typedefs a reference to a Segment class.

typedef const Segment* GVectors::const_se_ptr_t

Typedefs a const pointer to a Segment class.

typedef const Segment& GVectors::const_se_ref_t

Typedefs a const reference to a Segment class.

typedef VisualVector* GVectors::vv_ptr_t

Typedefs a pointer to a VisualVector.

typedef VisualVector& GVectors::vv_ref_t

Typedefs a reference to a VisualVector.

typedef const VisualVector* GVectors::const_vv_ptr_t

Typedefs a const pointer to a VisualVector.

typedef const VisualVector& GVectors::const_vv_ref_t

Typedefs a const reference to a VisualVector.

typedef VStoreItem* GVectors::vsi_ptr_t

Typedefs a pointer to a VStoreItem.

typedef VStoreItem& GVectors::vsi_ref_t

Typedefs a reference to a VStoreItem.

typedef const VStoreItem* GVectors::const_vsi_ptr_t

Typedefs a const pointer to a VStoreItem.

typedef const VStoreItem& GVectors::const_vsi_ref_t

Typedefs a const reference to a VStoreItem.


Enumeration Type Documentation

enum GVectors::Angle_Type

Holds the types of angle measurement.

Enumerator:
ANG_DEG  Degrees.

The angle is specified in degrees.

ANG_RAD  Radians.

The angle is specified in radians.

ANG_GRAD  Gradians.

The angle is specified in gradians.

anonymous enum

Enumerator:
TOP_LEVEL_NUM  The top most level in a vector store.

This is the top most level in a vector store. Deeper levels are assumed to be greater than TOP_LEVEL_NUM.

anonymous enum

Enumerator:
GVID_NONE  Non-existent vector store id.

This value must not be a valid vector store id. It is used to indicate an error condition.

enum GVectors::BinaryFileVersion

This enum holds the versions of binary vector store files known to libgvectors. Changes to the structure of the binary file results in a new version.

Enumerator:
BWVER_0_1  Version 1.

This is the first version of the binary file structure.

enum GVectors::BinaryFileEndianess

This values are used to describe the endianess used to write a binary vector store file.

Enumerator:
BWLITTLE_E  Little endian.

Little endian.

BWBIG_E  Big endian.

Big endian.

enum GVectors::XMLIndentation

These are used for indentation.

Enumerator:
XML_IND_ONE  One.

Indentation level one.

XML_IND_TWO  Two.

Indentation level two.

XML_IND_THREE  Three.

Indentation level three.

XML_IND_FOUR  Three.

Indentation level three.

XML_IND_FIVE  Five.

Indentation level five.


Function Documentation

double GVectors::Degree (  )  [inline]

This function returns

PI / 180

To convert from radians to degrees, divide by Degree(). To convert from degrees to radians, multiply by Degree().

Returns:
PI / 180


Variable Documentation

const std::string GVectors::VERSION_0_1 = "0.1"

Holds the version of the XML Vector Store file.

const std::string GVectors::NODE_NAME_VECTOR = "vector"

The node name of a vector.

const std::string GVectors::NODE_NAME_COORDINATES = "coordinates"

The name of the coordinates node.

const std::string GVectors::NODE_NAME_COMPONENTS[4]

Initial value:

 {
        "xcomp",
        "ycomp",
        "zcomp",
        ""
    }
The names of the nodes in a coordinates node as an array. Used to access them using a loop.

const std::string GVectors::NODE_NAME_XCOMP = "xcomp"

The name of the x component node.

const std::string GVectors::NODE_NAME_YCOMP = "ycomp"

The name of the y component node.

const std::string GVectors::NODE_NAME_ZCOMP = "zcomp"

The name of the z component node.

const std::string GVectors::NODE_NAME_COLOR = "color"

The name of the color node.

const std::string GVectors::NODE_NAME_COLORS[4]

Initial value:

 {
        "red",
        "green",
        "blue",
        ""
    }
The names of the nodes in a color node as an array. Used to access them using a loop.

const std::string GVectors::NODE_NAME_RED = "red"

The name of the node holding the red color component.

const std::string GVectors::NODE_NAME_GREEN = "green"

The name of the node holding the green color component.

const std::string GVectors::NODE_NAME_BLUE = "blue"

The name of the node holding the blue color component.


Generated on Sat Sep 8 19:37:29 2007 for libgvectors by  doxygen 1.4.7