Go::ObjectHeader Class Reference
['geometry' - a spline library]

An object representing the "header" usually preceeding a GeomObject in a stream. More...

#include <ObjectHeader.h>

Inheritance diagram for Go::ObjectHeader:

Go::Streamable List of all members.

Public Member Functions

 ObjectHeader ()
 Default constructor (uninitialized header).
 ObjectHeader (ClassType t, int major, int minor)
 Constructor creating an ObjectHeader that is initialized with a given ClassType, major and minor version.
 ObjectHeader (ClassType t, int major, int minor, const std::vector< int > &auxdata)
 Constructor creating an ObjectHeader that is initialized with a given ClassType, major and minor version and auxiliary, class- specific data.
virtual ~ObjectHeader ()
 Virtual destructor, allowing safe destruction of derived objects.
virtual void read (std::istream &is)
 Read the ObjectHeader from an input stream.
virtual void write (std::ostream &os) const
 Write the ObjectHeader to an output stream.
ClassType classType ()
 Get the ClassType stored in this ObjectHeader.
int majorVersion ()
 Get the major version number stored in this ObjectHeader.
int minorVersion ()
 Get the minor version number stored in this ObjectHeader.
int auxdataSize ()
 Get the size of the auxiliary data stored in this ObjectHeader (size measured in number of ints).
int auxdata (int i)
 Get a certain piece of auxiliary data (an integer).

Detailed Description

An object representing the "header" usually preceeding a GeomObject in a stream.

This header contains information about the GeomObject, and this information can be read by ObjectHeader and accessed by its member functions.

Definition at line 54 of file ObjectHeader.h.


Constructor & Destructor Documentation

Go::ObjectHeader::ObjectHeader ( ClassType  t,
int  major,
int  minor 
) [inline]

Constructor creating an ObjectHeader that is initialized with a given ClassType, major and minor version.

Parameters:
t the ClassType of the GeomObject that this ObjectHeader shall represent.
major major version number
minor minor version number

Definition at line 70 of file ObjectHeader.h.

Go::ObjectHeader::ObjectHeader ( ClassType  t,
int  major,
int  minor,
const std::vector< int > &  auxdata 
) [inline]

Constructor creating an ObjectHeader that is initialized with a given ClassType, major and minor version and auxiliary, class- specific data.

Parameters:
t the ClassType of the GeomObject that this ObjectHeader shall represent.
major major version number
minor minor version number
auxdata auxiliary data, specific to the ClassType.

Definition at line 84 of file ObjectHeader.h.


Member Function Documentation

virtual void Go::ObjectHeader::read ( std::istream &  is  )  [virtual]

Read the ObjectHeader from an input stream.

Parameters:
is the input stream from which the ObjectHeader is read

Implements Go::Streamable.

virtual void Go::ObjectHeader::write ( std::ostream &  os  )  const [virtual]

Write the ObjectHeader to an output stream.

Parameters:
os the output stream to which the ObjectHeader is written

Implements Go::Streamable.

int Go::ObjectHeader::auxdata ( int  i  )  [inline]

Get a certain piece of auxiliary data (an integer).

Parameters:
i the requested integer's position in the auxiliary data vector

Definition at line 118 of file ObjectHeader.h.


The documentation for this class was generated from the following file:
Generated on Mon Jun 11 14:48:19 2007 for GoTools Core Library by  doxygen 1.5.1