CigiBaseVertexSymbolData Class Reference

#include <CigiBaseVertexSymbolData.h>

Inheritance diagram for CigiBaseVertexSymbolData:

CigiVertexSymbolDataV3_3 List of all members.

Public Member Functions

 CigiBaseVertexSymbolData (void)
virtual ~CigiBaseVertexSymbolData (void)
virtual int Pack (CigiBaseVertexSymbolData *Base, Cigi_uint8 *Buff) const =0
virtual int Unpack (Cigi_uint8 *Buff, bool Swap)=0
int SetVertex (const float VertexUIn, const float VertexVIn, bool bndchk=true)
int GetVertex (float &VertexUIn, float &VertexVIn)
int SetVertexU (const float VertexUIn, bool bndchk=true)
float GetVertexU (void) const
int SetVertexV (const float VertexVIn, bool bndchk=true)
float GetVertexV (void) const

Protected Attributes

float VertexU
float VertexV

Friends

class CigiVertexSymbolDataV3_3

Detailed Description

The base class for all packets.

Definition at line 58 of file CigiBaseVertexSymbolData.h.

Constructor & Destructor Documentation

CigiBaseVertexSymbolData::CigiBaseVertexSymbolData ( void   )  [inline]

General Constructor

Definition at line 71 of file CigiBaseVertexSymbolData.h.

00071 {};

virtual CigiBaseVertexSymbolData::~CigiBaseVertexSymbolData ( void   )  [inline, virtual]

General Destructor

Definition at line 76 of file CigiBaseVertexSymbolData.h.

00076 {};

Member Function Documentation

int CigiBaseVertexSymbolData::GetVertex ( float &  VertexUIn,
float &  VertexVIn 
) [inline]

Gets both elements of the Vertex

Parameters:
VertexUIn - A reference to receive the Vertex's U position
VertexVIn - A reference to receive the Vertex's V position
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 134 of file CigiBaseVertexSymbolData.h.

References CIGI_SUCCESS, VertexU, and VertexV.

00135    {
00136       VertexUIn = VertexU;
00137       VertexVIn = VertexV;
00138       return(CIGI_SUCCESS);
00139    }

float CigiBaseVertexSymbolData::GetVertexU ( void   )  const [inline]

Gets the VertexU with bound checking control

Returns:
VertexU

Definition at line 161 of file CigiBaseVertexSymbolData.h.

References VertexU.

00161 { return(VertexU); }

float CigiBaseVertexSymbolData::GetVertexV ( void   )  const [inline]

Gets the VertexV with bound checking control

Returns:
VertexV

Definition at line 183 of file CigiBaseVertexSymbolData.h.

References VertexV.

00183 { return(VertexV); }

virtual int CigiBaseVertexSymbolData::Pack ( CigiBaseVertexSymbolData *  Base,
Cigi_uint8 *  Buff 
) const [pure virtual]

A pure virtual Pack function. This function is not implemented in this class.

Parameters:
Base - A pointer to the instance of the Circle Data to be packed. (Downcast to CigiBaseVertexSymbolData)
Buff - A pointer to the current pack point.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implemented in CigiVertexSymbolDataV3_3.

int CigiBaseVertexSymbolData::SetVertex ( const float  VertexUIn,
const float  VertexVIn,
bool  bndchk = true 
) [inline]

Sets both elements of the Vertex with bound checking control

Parameters:
VertexUIn - The Vertex's U position
VertexVIn - The Vertex's V position
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 118 of file CigiBaseVertexSymbolData.h.

References CIGI_SUCCESS, VertexU, and VertexV.

00119    {
00120       VertexU = VertexUIn;
00121       VertexV = VertexVIn;
00122       return(CIGI_SUCCESS);
00123    }

int CigiBaseVertexSymbolData::SetVertexU ( const float  VertexUIn,
bool  bndchk = true 
) [inline]

Sets the VertexU with bound checking control

Parameters:
VertexUIn - The Vertex's U position
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 151 of file CigiBaseVertexSymbolData.h.

References CIGI_SUCCESS, and VertexU.

00152    {
00153       VertexU = VertexUIn;
00154       return(CIGI_SUCCESS);
00155    }

int CigiBaseVertexSymbolData::SetVertexV ( const float  VertexVIn,
bool  bndchk = true 
) [inline]

Sets the VertexV with bound checking control

Parameters:
VertexVIn - The Vertex's V position
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 173 of file CigiBaseVertexSymbolData.h.

References CIGI_SUCCESS, and VertexV.

00174    {
00175       VertexV = VertexVIn;
00176       return(CIGI_SUCCESS);
00177    }

virtual int CigiBaseVertexSymbolData::Unpack ( Cigi_uint8 *  Buff,
bool  Swap 
) [pure virtual]

A pure virtual Unpack function. This function is not implemented in this class.

Parameters:
Buff - A pointer to the current pack point.
Swap - N/A for V1 & V2
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implemented in CigiVertexSymbolDataV3_3.

Referenced by CigiSymbolLineDefV3_3::Unpack().

Friends And Related Function Documentation

friend class CigiVertexSymbolDataV3_3 [friend]

Definition at line 61 of file CigiBaseVertexSymbolData.h.

Member Data Documentation

float CigiBaseVertexSymbolData::VertexU [protected]

VertexU
The Vertex's U position

Definition at line 195 of file CigiBaseVertexSymbolData.h.

Referenced by CigiVertexSymbolDataV3_3::CigiVertexSymbolDataV3_3(), GetVertex(), GetVertexU(), CigiVertexSymbolDataV3_3::Pack(), SetVertex(), SetVertexU(), and CigiVertexSymbolDataV3_3::Unpack().

float CigiBaseVertexSymbolData::VertexV [protected]

VertexV
The Vertex's V position

Definition at line 201 of file CigiBaseVertexSymbolData.h.

Referenced by CigiVertexSymbolDataV3_3::CigiVertexSymbolDataV3_3(), GetVertex(), GetVertexV(), CigiVertexSymbolDataV3_3::Pack(), SetVertex(), SetVertexV(), and CigiVertexSymbolDataV3_3::Unpack().

The documentation for this class was generated from the following file:
Generated on Wed Apr 29 09:00:06 2009 for CCL by  doxygen 1.4.7