CigiBaseCircleSymbolData Class Reference

#include <CigiBaseCircleSymbolData.h>

Inheritance diagram for CigiBaseCircleSymbolData:

CigiCircleSymbolDataV3_3 List of all members.

Public Member Functions

 CigiBaseCircleSymbolData (void)
virtual ~CigiBaseCircleSymbolData (void)
virtual int Pack (CigiBaseCircleSymbolData *Base, Cigi_uint8 *Buff) const =0
virtual int Unpack (Cigi_uint8 *Buff, bool Swap)=0
int SetCenterUPosition (const float CenterUPositionIn, bool bndchk=true)
float GetCenterUPosition (void) const
int SetCenterVPosition (const float CenterVPositionIn, bool bndchk=true)
float GetCenterVPosition (void) const
int SetRadius (const float RadiusIn, bool bndchk=true)
float GetRadius (void) const
int SetInnerRadius (const float InnerRadiusIn, bool bndchk=true)
float GetInnerRadius (void) const
int SetStartAngle (const float StartAngleIn, bool bndchk=true)
float GetStartAngle (void) const
int SetEndAngle (const float EndAngleIn, bool bndchk=true)
float GetEndAngle (void) const

Protected Attributes

float CenterUPosition
float CenterVPosition
float Radius
float InnerRadius
float StartAngle
float EndAngle

Friends

class CigiCircleSymbolDataV3_3

Detailed Description

The base class for all packets.

Definition at line 58 of file CigiBaseCircleSymbolData.h.

Constructor & Destructor Documentation

CigiBaseCircleSymbolData::CigiBaseCircleSymbolData ( void   ) 

General Constructor

Definition at line 55 of file CigiBaseCircleSymbolData.cpp.

00056 {
00057 }

CigiBaseCircleSymbolData::~CigiBaseCircleSymbolData ( void   )  [virtual]

General Destructor

Definition at line 62 of file CigiBaseCircleSymbolData.cpp.

00063 {
00064 }

Member Function Documentation

float CigiBaseCircleSymbolData::GetCenterUPosition ( void   )  const [inline]

Gets the CenterUPosition with bound checking control

Returns:
CenterUPosition

Definition at line 128 of file CigiBaseCircleSymbolData.h.

References CenterUPosition.

00128 { return(CenterUPosition); }

float CigiBaseCircleSymbolData::GetCenterVPosition ( void   )  const [inline]

Gets the CenterVPosition with bound checking control

Returns:
CenterVPosition

Definition at line 151 of file CigiBaseCircleSymbolData.h.

References CenterVPosition.

00151 { return(CenterVPosition); }

float CigiBaseCircleSymbolData::GetEndAngle ( void   )  const [inline]

Gets the EndAngle with bound checking control

Returns:
EndAngle

Definition at line 226 of file CigiBaseCircleSymbolData.h.

References EndAngle.

00226 { return(EndAngle); }

float CigiBaseCircleSymbolData::GetInnerRadius ( void   )  const [inline]

Gets the InnerRadius with bound checking control

Returns:
InnerRadius

Definition at line 188 of file CigiBaseCircleSymbolData.h.

References InnerRadius.

00188 { return(InnerRadius); }

float CigiBaseCircleSymbolData::GetRadius ( void   )  const [inline]

Gets the Radius with bound checking control

Returns:
Radius

Definition at line 169 of file CigiBaseCircleSymbolData.h.

References Radius.

00169 { return(Radius); }

float CigiBaseCircleSymbolData::GetStartAngle ( void   )  const [inline]

Gets the StartAngle with bound checking control

Returns:
StartAngle

Definition at line 207 of file CigiBaseCircleSymbolData.h.

References StartAngle.

00207 { return(StartAngle); }

virtual int CigiBaseCircleSymbolData::Pack ( CigiBaseCircleSymbolData *  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 CigiBaseCircleSymbolData)
Buff - A pointer to the current pack point.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implemented in CigiCircleSymbolDataV3_3.

int CigiBaseCircleSymbolData::SetCenterUPosition ( const float  CenterUPositionIn,
bool  bndchk = true 
) [inline]

Sets the CenterUPosition with bound checking control

Parameters:
CenterUPositionIn - Specifies the position of the center of the circle along the current U Axis.
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 CigiBaseCircleSymbolData.h.

References CenterUPosition, and CIGI_SUCCESS.

00119    {
00120       CenterUPosition = CenterUPositionIn;
00121       return(CIGI_SUCCESS);
00122    }

int CigiBaseCircleSymbolData::SetCenterVPosition ( const float  CenterVPositionIn,
bool  bndchk = true 
) [inline]

Sets the CenterVPosition with bound checking control

Parameters:
CenterVPositionIn - Specifies the position of the center of the circle along the current V Axis.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 141 of file CigiBaseCircleSymbolData.h.

References CenterVPosition, and CIGI_SUCCESS.

00142    {
00143       CenterVPosition = CenterVPositionIn;
00144       return(CIGI_SUCCESS);
00145    }

int CigiBaseCircleSymbolData::SetEndAngle ( const float  EndAngleIn,
bool  bndchk = true 
)

Sets the EndAngle with bound checking control

Parameters:
EndAngleIn - Specifies the angle from the current X Axis that the circle ends.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 143 of file CigiBaseCircleSymbolData.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and EndAngle.

00144 {
00145 
00146 #ifndef CIGI_NO_BND_CHK
00147    if(bndchk && ((EndAngleIn < 0.0)||(EndAngleIn > 360.0)))
00148    {
00149 #ifndef CIGI_NO_EXCEPT
00150       throw CigiValueOutOfRangeException("EndAngle", (double)EndAngleIn,0.0,360.0);
00151 #endif
00152       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00153    }
00154 #endif
00155 
00156    EndAngle = EndAngleIn;
00157 
00158    return(CIGI_SUCCESS);
00159 
00160 }

int CigiBaseCircleSymbolData::SetInnerRadius ( const float  InnerRadiusIn,
bool  bndchk = true 
)

Sets the InnerRadius with bound checking control

Parameters:
InnerRadiusIn - Specifies the inner radius of a filled or partially filled circle.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 97 of file CigiBaseCircleSymbolData.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and InnerRadius.

00098 {
00099 
00100 #ifndef CIGI_NO_BND_CHK
00101    if(bndchk && ((InnerRadiusIn < 0.0)))
00102    {
00103 #ifndef CIGI_NO_EXCEPT
00104       throw CigiValueOutOfRangeException("InnerRadiusIn", (int)InnerRadiusIn,">=",0.0);
00105 #endif
00106       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00107    }
00108 #endif
00109 
00110    InnerRadius = InnerRadiusIn;
00111 
00112    return(CIGI_SUCCESS);
00113 
00114 }

int CigiBaseCircleSymbolData::SetRadius ( const float  RadiusIn,
bool  bndchk = true 
)

Sets the Radius with bound checking control

Parameters:
RadiusIn - Specifies the radius of the circle
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 74 of file CigiBaseCircleSymbolData.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Radius.

00075 {
00076 
00077 #ifndef CIGI_NO_BND_CHK
00078    if(bndchk && ((RadiusIn < 0.0)))
00079    {
00080 #ifndef CIGI_NO_EXCEPT
00081       throw CigiValueOutOfRangeException("RadiusIn", (int)RadiusIn,">=",0.0);
00082 #endif
00083       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00084    }
00085 #endif
00086 
00087    Radius = RadiusIn;
00088 
00089    return(CIGI_SUCCESS);
00090 
00091 }

int CigiBaseCircleSymbolData::SetStartAngle ( const float  StartAngleIn,
bool  bndchk = true 
)

Sets the StartAngle with bound checking control

Parameters:
StartAngleIn - Specifies the angle from the current X Axis that the circle starts.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 120 of file CigiBaseCircleSymbolData.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and StartAngle.

00121 {
00122 
00123 #ifndef CIGI_NO_BND_CHK
00124    if(bndchk && ((StartAngleIn < 0.0)||(StartAngleIn > 360.0)))
00125    {
00126 #ifndef CIGI_NO_EXCEPT
00127       throw CigiValueOutOfRangeException("StartAngle", (double)StartAngleIn,0.0,360.0);
00128 #endif
00129       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00130    }
00131 #endif
00132 
00133    StartAngle = StartAngleIn;
00134 
00135    return(CIGI_SUCCESS);
00136 
00137 }

virtual int CigiBaseCircleSymbolData::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 CigiCircleSymbolDataV3_3.

Referenced by CigiSymbolCircleDefV3_3::Unpack().

Friends And Related Function Documentation

friend class CigiCircleSymbolDataV3_3 [friend]

Definition at line 61 of file CigiBaseCircleSymbolData.h.

Member Data Documentation

float CigiBaseCircleSymbolData::CenterUPosition [protected]

CenterUPosition
The position of the center of the circle along the current U Axis.

Definition at line 239 of file CigiBaseCircleSymbolData.h.

Referenced by CigiCircleSymbolDataV3_3::CigiCircleSymbolDataV3_3(), GetCenterUPosition(), CigiCircleSymbolDataV3_3::Pack(), SetCenterUPosition(), and CigiCircleSymbolDataV3_3::Unpack().

float CigiBaseCircleSymbolData::CenterVPosition [protected]

CenterVPosition
The position of the center of the circle along the current V Axis.

Definition at line 246 of file CigiBaseCircleSymbolData.h.

Referenced by CigiCircleSymbolDataV3_3::CigiCircleSymbolDataV3_3(), GetCenterVPosition(), CigiCircleSymbolDataV3_3::Pack(), SetCenterVPosition(), and CigiCircleSymbolDataV3_3::Unpack().

float CigiBaseCircleSymbolData::EndAngle [protected]

StartAngle
The angle from the current X Axis where the circle or arc ends.

Definition at line 272 of file CigiBaseCircleSymbolData.h.

Referenced by CigiCircleSymbolDataV3_3::CigiCircleSymbolDataV3_3(), GetEndAngle(), CigiCircleSymbolDataV3_3::Pack(), SetEndAngle(), and CigiCircleSymbolDataV3_3::Unpack().

float CigiBaseCircleSymbolData::InnerRadius [protected]

InnerRadius
The inner radius of a filled or partially filled circle

Definition at line 258 of file CigiBaseCircleSymbolData.h.

Referenced by CigiCircleSymbolDataV3_3::CigiCircleSymbolDataV3_3(), GetInnerRadius(), CigiCircleSymbolDataV3_3::Pack(), SetInnerRadius(), and CigiCircleSymbolDataV3_3::Unpack().

float CigiBaseCircleSymbolData::Radius [protected]

Radius
The radius of this circle

Definition at line 252 of file CigiBaseCircleSymbolData.h.

Referenced by CigiCircleSymbolDataV3_3::CigiCircleSymbolDataV3_3(), GetRadius(), CigiCircleSymbolDataV3_3::Pack(), SetRadius(), and CigiCircleSymbolDataV3_3::Unpack().

float CigiBaseCircleSymbolData::StartAngle [protected]

StartAngle
The angle from the current X Axis where the circle or arc starts.

Definition at line 265 of file CigiBaseCircleSymbolData.h.

Referenced by CigiCircleSymbolDataV3_3::CigiCircleSymbolDataV3_3(), GetStartAngle(), CigiCircleSymbolDataV3_3::Pack(), SetStartAngle(), and CigiCircleSymbolDataV3_3::Unpack().

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