CigiBaseShortSymbolCtrl Class Reference

#include <CigiBaseShortSymbolCtrl.h>

Inheritance diagram for CigiBaseShortSymbolCtrl:

CigiBasePacket CigiShortSymbolCtrlV3_3 List of all members.

Public Types

typedef CigiBaseShortSymbolCtrl::DatumUnion DatumUnionType
 None = 0
 SurfaceIdDatumType = 1
 ParentIdDatumType = 2
 LayerDatumType = 3
 FlashDutyCycleDatumType = 4
 FlashPeriodDatumType = 5
 UPositionDatumType = 6
 VPositionDatumType = 7
 RotationDatumType = 8
 ColorDatumType = 9
 ScaleUDatumType = 10
 ScaleVDatumType = 11
enum  DatumTypeGrp {
  None = 0, SurfaceIdDatumType = 1, ParentIdDatumType = 2, LayerDatumType = 3,
  FlashDutyCycleDatumType = 4, FlashPeriodDatumType = 5, UPositionDatumType = 6, VPositionDatumType = 7,
  RotationDatumType = 8, ColorDatumType = 9, ScaleUDatumType = 10, ScaleVDatumType = 11
}

Public Member Functions

 CigiBaseShortSymbolCtrl (void)
virtual ~CigiBaseShortSymbolCtrl (void)
virtual int Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0
virtual int Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0
virtual int GetCnvt (CigiVersionID &CnvtVersion, CigiCnvtInfoType::Type &CnvtInfo)
int SetSymbolID (const Cigi_uint16 SymbolIDIn, bool bndchk=true)
Cigi_uint16 GetSymbolID (void) const
int SetSymbolState (const CigiBaseSymbolCtrl::SymbolStateGrp SymbolStateIn, bool bndchk=true)
CigiBaseSymbolCtrl::SymbolStateGrp GetSymbolState (void) const
int SetAttachState (const CigiBaseSymbolCtrl::AttachStateGrp AttachStateIn, bool bndchk=true)
CigiBaseSymbolCtrl::AttachStateGrp GetAttachState (void) const
int SetFlashCtrl (const CigiBaseSymbolCtrl::FlashCtrlGrp FlashCtrlIn, bool bndchk=true)
CigiBaseSymbolCtrl::FlashCtrlGrp GetFlashCtrl (void) const
int SetInheritColor (const CigiBaseSymbolCtrl::InheritColorGrp InheritColorIn, bool bndchk=true)
CigiBaseSymbolCtrl::InheritColorGrp GetInheritColor (void) const
DatumTypeGrp GetDatumType (int DatumId) const
Cigi_uint32 GetUIntDatum (int DatumId) const
int GetColorDatum (int DatumId, Cigi_uint8 &RedValue, Cigi_uint8 &GreenValue, Cigi_uint8 &BlueValue, Cigi_uint8 &AlphaValue, bool bndchk=true)
float GetFloatDatum (int DatumId) const
int SetDatumNone (int DatumId, bool bndchk=true)
int SetSurfaceID (int DatumId, const Cigi_uint16 SurfaceIDIn, bool bndchk=true)
int SetParentSymbolID (int DatumId, const Cigi_uint16 ParentSymbolIDIn, bool bndchk=true)
int SetLayer (int DatumId, const Cigi_uint8 LayerIn, bool bndchk=true)
int SetFlashDutyCycle (int DatumId, const Cigi_uint8 FlashDutyCycleIn, bool bndchk=true)
int SetFlashPeriod (int DatumId, const float FlashPeriodIn, bool bndchk=true)
int SetUPosition (int DatumId, const float UPositionIn, bool bndchk=true)
int SetVPosition (int DatumId, const float VPositionIn, bool bndchk=true)
int SetRotation (int DatumId, const float RotationIn, bool bndchk=true)
int SetScaleU (int DatumId, const float ScaleUIn, bool bndchk=true)
int SetScaleV (int DatumId, const float ScaleVIn, bool bndchk=true)
int SetColor (int DatumId, const Cigi_uint8 RedIn, const Cigi_uint8 GreenIn, const Cigi_uint8 BlueIn, const Cigi_uint8 AlphaIn, bool bndchk=true)

Protected Attributes

Cigi_uint16 SymbolID
CigiBaseSymbolCtrl::SymbolStateGrp SymbolState
CigiBaseSymbolCtrl::AttachStateGrp AttachState
CigiBaseSymbolCtrl::FlashCtrlGrp FlashCtrl
CigiBaseSymbolCtrl::InheritColorGrp InheritColor
DatumTypeGrp DatumType [2]
DatumUnionType Datum [2]

Friends

class CigiShortSymbolCtrlV3_3

Classes

union  DatumUnion

Detailed Description

The base class for all packets.

Definition at line 62 of file CigiBaseShortSymbolCtrl.h.

Member Typedef Documentation

typedef union CigiBaseShortSymbolCtrl::DatumUnion CigiBaseShortSymbolCtrl::DatumUnionType

The union of the types of values that can be used in datum parameter

Member Enumeration Documentation

enum CigiBaseShortSymbolCtrl::DatumTypeGrp

The enumeration for the CigiBaseShortSymbolCtrl Datum type Group

Enumerator:
None 
SurfaceIdDatumType 
ParentIdDatumType 
LayerDatumType 
FlashDutyCycleDatumType 
FlashPeriodDatumType 
UPositionDatumType 
VPositionDatumType 
RotationDatumType 
ColorDatumType 
ScaleUDatumType 
ScaleVDatumType 

Definition at line 75 of file CigiBaseShortSymbolCtrl.h.

00076    {
00077       None=0,
00078       SurfaceIdDatumType=1,
00079       ParentIdDatumType=2,
00080       LayerDatumType=3,
00081       FlashDutyCycleDatumType=4,
00082       FlashPeriodDatumType=5,
00083       UPositionDatumType=6,
00084       VPositionDatumType=7,
00085       RotationDatumType=8,
00086       ColorDatumType=9,
00087       ScaleUDatumType=10,
00088       ScaleVDatumType=11
00089    };

Constructor & Destructor Documentation

CigiBaseShortSymbolCtrl::CigiBaseShortSymbolCtrl ( void   ) 

General Constructor

Definition at line 54 of file CigiBaseShortSymbolCtrl.cpp.

00055 {
00056 }

CigiBaseShortSymbolCtrl::~CigiBaseShortSymbolCtrl ( void   )  [virtual]

General Destructor

Definition at line 61 of file CigiBaseShortSymbolCtrl.cpp.

00062 {
00063 }

Member Function Documentation

CigiBaseSymbolCtrl::AttachStateGrp CigiBaseShortSymbolCtrl::GetAttachState ( void   )  const [inline]

Gets the AttachState with bound checking control

Returns:
The Attach State of this symbol.

Definition at line 218 of file CigiBaseShortSymbolCtrl.h.

00218 { return(AttachState); }

int CigiBaseShortSymbolCtrl::GetCnvt ( CigiVersionID &  CnvtVersion,
CigiCnvtInfoType::Type &  CnvtInfo 
) [virtual]

A virtual Conversion Information function. This function provides conversion information for this packet.

Parameters:
CnvtVersion - The CIGI version to which this packet is being converted.
CnvtInfo - The information needed for conversion
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Reimplemented from CigiBasePacket.

Definition at line 69 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_SHORT_SYMBOL_CONTROL_PACKET_ID_V3_3, CIGI_SUCCESS, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiVersionID::GetCombinedCigiVersion(), CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

00071 {
00072    if(CnvtVersion.GetCombinedCigiVersion() < 0x303)
00073    {
00074       CnvtInfo.ProcID = CigiProcessType::ProcNone;
00075       CnvtInfo.CnvtPacketID = 0;
00076    }
00077    else
00078    {
00079       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00080       CnvtInfo.CnvtPacketID = CIGI_SHORT_SYMBOL_CONTROL_PACKET_ID_V3_3;
00081    }
00082 
00083    return(CIGI_SUCCESS);
00084 }

int CigiBaseShortSymbolCtrl::GetColorDatum ( int  DatumId,
Cigi_uint8 &  RedValue,
Cigi_uint8 &  GreenValue,
Cigi_uint8 &  BlueValue,
Cigi_uint8 &  AlphaValue,
bool  bndchk = true 
)

Gets the color value of the specified datum

Parameters:
DatumId - The ID of the Datum to read (0 or 1)
RedValue - The reference to the variable in which the value of the red component will be placed
GreenValue - The reference to the variable in which the value of the Green component will be placed
BlueValue - The reference to the variable in which the value of the Blue component will be placed
AlphaValue - The reference to the variable in which the value of the Alpha component will be placed
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 232 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Datum.

00238 {
00239 
00240    //This must be bound checked!
00241    if((DatumId < 0)||(DatumId > 1))
00242    {
00243 #ifndef CIGI_NO_EXCEPT
00244       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00245 #endif
00246       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00247    }
00248 
00249    RedValue = (Cigi_uint8)((Datum[(DatumId)].UIntValue >> 24) & 0xff);
00250    GreenValue = (Cigi_uint8)((Datum[(DatumId)].UIntValue >> 16) & 0xff);
00251    BlueValue = (Cigi_uint8)((Datum[(DatumId)].UIntValue >> 8) & 0xff);
00252    AlphaValue = (Cigi_uint8)((Datum[(DatumId)].UIntValue) & 0xff);
00253 
00254    return(CIGI_SUCCESS);
00255 
00256 }

CigiBaseShortSymbolCtrl::DatumTypeGrp CigiBaseShortSymbolCtrl::GetDatumType ( int  DatumId  )  const

Gets the ID specifying the datum contained in Datum 0

Parameters:
DatumId - The ID of the Datum being checked (0 or 1)
Returns:
ParentSymbolID

Definition at line 190 of file CigiBaseShortSymbolCtrl.cpp.

References DatumType, and None.

00191 {
00192 
00193    //This must be bound checked!
00194    if((DatumId < 0)||(DatumId > 1))
00195    {
00196 #ifndef CIGI_NO_EXCEPT
00197       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00198 #endif
00199       return(None);
00200    }
00201 
00202    return(DatumType[(DatumId)]);
00203 
00204 }

CigiBaseSymbolCtrl::FlashCtrlGrp CigiBaseShortSymbolCtrl::GetFlashCtrl ( void   )  const [inline]

Gets the FlashCtrl with bound checking control

Returns:
The Flash Ctrl of this symbol.

Definition at line 237 of file CigiBaseShortSymbolCtrl.h.

00237 { return(FlashCtrl); }

float CigiBaseShortSymbolCtrl::GetFloatDatum ( int  DatumId  )  const

Gets thefloating point value of the specified datum.

Parameters:
DatumId - The ID or the Datum to read (0 or 1)
Returns:
ParentSymbolID

Definition at line 263 of file CigiBaseShortSymbolCtrl.cpp.

References Datum.

00264 {
00265 
00266    //This must be bound checked!
00267    if((DatumId < 0)||(DatumId > 1))
00268    {
00269 #ifndef CIGI_NO_EXCEPT
00270       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00271 #endif
00272       return(0.0);
00273    }
00274 
00275    return(Datum[(DatumId)].FloatValue);
00276 
00277 }

CigiBaseSymbolCtrl::InheritColorGrp CigiBaseShortSymbolCtrl::GetInheritColor ( void   )  const [inline]

Gets the InheritColor with bound checking control

Returns:
Whether this symbol inherits its color from its parent or uses its own color.

Definition at line 257 of file CigiBaseShortSymbolCtrl.h.

00257 { return(InheritColor); }

Cigi_uint16 CigiBaseShortSymbolCtrl::GetSymbolID ( void   )  const [inline]

Gets the SymbolID with bound checking control

Returns:
The ID number of this symbol.

Definition at line 180 of file CigiBaseShortSymbolCtrl.h.

00180 { return(SymbolID); }

CigiBaseSymbolCtrl::SymbolStateGrp CigiBaseShortSymbolCtrl::GetSymbolState ( void   )  const [inline]

Gets the SymbolState with bound checking control

Returns:
The State of this symbol.

Definition at line 199 of file CigiBaseShortSymbolCtrl.h.

00199 { return(SymbolState); }

Cigi_uint32 CigiBaseShortSymbolCtrl::GetUIntDatum ( int  DatumId  )  const

Gets the unsigned integer value of the specified datum.

Parameters:
DatumId - The ID of the Datum to read (0 or 1)
Returns:
ParentSymbolID

Definition at line 211 of file CigiBaseShortSymbolCtrl.cpp.

References Datum.

00212 {
00213 
00214    //This must be bound checked!
00215    if((DatumId < 0)||(DatumId > 1))
00216    {
00217 #ifndef CIGI_NO_EXCEPT
00218       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00219 #endif
00220       return(0);
00221    }
00222 
00223    return(Datum[(DatumId)].UIntValue);
00224 
00225 }

virtual int CigiBaseShortSymbolCtrl::Pack ( CigiBasePacket *  Base,
Cigi_uint8 *  Buff,
void *  Spec 
) 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 packet to be packed. (Downcast to CigiBasePacket)
Buff - A pointer to the current pack point.
Spec - A pointer to special data.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiShortSymbolCtrlV3_3.

int CigiBaseShortSymbolCtrl::SetAttachState ( const CigiBaseSymbolCtrl::AttachStateGrp  AttachStateIn,
bool  bndchk = true 
)

Sets the AttachState with bound checking control

Parameters:
AttachStateIn - Specifies whether this symbol is attached to another symbol or is detached.
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 CigiBaseShortSymbolCtrl.cpp.

References AttachState, CIGI_ERROR_VALUE_OUT_OF_RANGE, and CIGI_SUCCESS.

00119 {
00120 
00121 #ifndef CIGI_NO_BND_CHK
00122    if(bndchk && ((AttachStateIn < 0)||(AttachStateIn > 1)))
00123    {
00124 #ifndef CIGI_NO_EXCEPT
00125       throw CigiValueOutOfRangeException("AttachState", (int)AttachStateIn,0,1);
00126 #endif
00127       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00128    }
00129 #endif
00130 
00131    AttachState = AttachStateIn;
00132 
00133    return(CIGI_SUCCESS);
00134 
00135 }

int CigiBaseShortSymbolCtrl::SetColor ( int  DatumId,
const Cigi_uint8  RedIn,
const Cigi_uint8  GreenIn,
const Cigi_uint8  BlueIn,
const Cigi_uint8  AlphaIn,
bool  bndchk = true 
)

Sets the color with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
RedValue - The reference to the variable in which the value of the red component will be placed
GreenValue - The reference to the variable in which the value of the Green component will be placed
BlueValue - The reference to the variable in which the value of the Blue component will be placed
AlphaValue - The reference to the variable in which the value of the Alpha component will be placed
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 568 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, ColorDatumType, Datum, and DatumType.

00574 {
00575 
00576    //This must be bound checked!
00577    if((DatumId < 0)||(DatumId > 1))
00578    {
00579 #ifndef CIGI_NO_EXCEPT
00580       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00581 #endif
00582       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00583    }
00584 
00585    DatumType[(DatumId)] = ColorDatumType;
00586 
00587    Cigi_uint32 cColor = (Cigi_uint32)AlphaIn;
00588    Cigi_uint32 tColor =  (Cigi_uint32)RedIn;
00589    cColor |= ((tColor << 24) & 0xff000000);
00590    tColor =  (Cigi_uint32)GreenIn;
00591    cColor |= ((tColor << 16) & 0x00ff0000);
00592    tColor =  (Cigi_uint32)BlueIn;
00593    cColor |= ((tColor << 8) & 0x0000ff00);
00594    Datum[(DatumId)].UIntValue = cColor;
00595 
00596    return(CIGI_SUCCESS);
00597 
00598 }

int CigiBaseShortSymbolCtrl::SetDatumNone ( int  DatumId,
bool  bndchk = true 
)

Sets the Datum type to "NONE" and zeros the Datum with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 284 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and None.

00285 {
00286 
00287    //This must be bound checked!
00288    if((DatumId < 0)||(DatumId > 1))
00289    {
00290 #ifndef CIGI_NO_EXCEPT
00291       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00292 #endif
00293       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00294    }
00295 
00296    DatumType[(DatumId)] = None;
00297    Datum[(DatumId)].UIntValue = 0;
00298 
00299    return(CIGI_SUCCESS);
00300 
00301 }

int CigiBaseShortSymbolCtrl::SetFlashCtrl ( const CigiBaseSymbolCtrl::FlashCtrlGrp  FlashCtrlIn,
bool  bndchk = true 
)

Sets the FlashCtrl with bound checking control

Parameters:
FlashCtrlIn - Specifies whether the flashing pattern of this symbol is continued or is reset.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 142 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and FlashCtrl.

00143 {
00144 
00145 #ifndef CIGI_NO_BND_CHK
00146    if(bndchk && ((FlashCtrlIn < 0)||(FlashCtrlIn > 1)))
00147    {
00148 #ifndef CIGI_NO_EXCEPT
00149       throw CigiValueOutOfRangeException("FlashCtrl", (int)FlashCtrlIn,0,1);
00150 #endif
00151       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00152    }
00153 #endif
00154 
00155    FlashCtrl = FlashCtrlIn;
00156 
00157    return(CIGI_SUCCESS);
00158 
00159 }

int CigiBaseShortSymbolCtrl::SetFlashDutyCycle ( int  DatumId,
const Cigi_uint8  FlashDutyCycleIn,
bool  bndchk = true 
)

Sets the FlashDutyCycle with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
FlashDutyCycleIn - Specifies the percentage of time that the symbol is visible.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 383 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and FlashDutyCycleDatumType.

00385 {
00386 
00387    //This must be bound checked!
00388    if((DatumId < 0)||(DatumId > 1))
00389    {
00390 #ifndef CIGI_NO_EXCEPT
00391       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00392 #endif
00393       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00394    }
00395 
00396 #ifndef CIGI_NO_BND_CHK
00397    if(bndchk && ((FlashDutyCycleIn < 0)||(FlashDutyCycleIn > 100)))
00398    {
00399 #ifndef CIGI_NO_EXCEPT
00400       throw CigiValueOutOfRangeException("FlashDutyCycle", (int)FlashDutyCycleIn,0,100);
00401 #endif
00402       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00403    }
00404 #endif
00405 
00406    DatumType[(DatumId)] = FlashDutyCycleDatumType;
00407    Datum[(DatumId)].UIntValue = (Cigi_uint32)FlashDutyCycleIn;
00408 
00409    return(CIGI_SUCCESS);
00410 
00411 }

int CigiBaseShortSymbolCtrl::SetFlashPeriod ( int  DatumId,
const float  FlashPeriodIn,
bool  bndchk = true 
)

Sets the FlashPeriod with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
FlashPeriodIn - Specifies the amount of time in seconds of a full flash cycle.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 418 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and FlashPeriodDatumType.

00420 {
00421 
00422    //This must be bound checked!
00423    if((DatumId < 0)||(DatumId > 1))
00424    {
00425 #ifndef CIGI_NO_EXCEPT
00426       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00427 #endif
00428       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00429    }
00430 
00431    DatumType[(DatumId)] = FlashPeriodDatumType;
00432    Datum[(DatumId)].FloatValue = FlashPeriodIn;
00433 
00434    return(CIGI_SUCCESS);
00435 
00436 }

int CigiBaseShortSymbolCtrl::SetInheritColor ( const CigiBaseSymbolCtrl::InheritColorGrp  InheritColorIn,
bool  bndchk = true 
)

Sets the InheritColor with bound checking control

Parameters:
InheritColorIn - Specifies whether this symbol inherits its color from its parent or uses its own color.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 166 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and InheritColor.

00167 {
00168 
00169 #ifndef CIGI_NO_BND_CHK
00170    if(bndchk && ((InheritColorIn < 0)||(InheritColorIn > 1)))
00171    {
00172 #ifndef CIGI_NO_EXCEPT
00173       throw CigiValueOutOfRangeException("InheritColor", (int)InheritColorIn,0,1);
00174 #endif
00175       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00176    }
00177 #endif
00178 
00179    InheritColor = InheritColorIn;
00180 
00181    return(CIGI_SUCCESS);
00182 
00183 }

int CigiBaseShortSymbolCtrl::SetLayer ( int  DatumId,
const Cigi_uint8  LayerIn,
bool  bndchk = true 
)

Sets the Layer with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
LayerIn - Specifies the ID number of the layer that this symbol occupies.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 358 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and LayerDatumType.

00360 {
00361 
00362    //This must be bound checked!
00363    if((DatumId < 0)||(DatumId > 1))
00364    {
00365 #ifndef CIGI_NO_EXCEPT
00366       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00367 #endif
00368       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00369    }
00370 
00371    DatumType[(DatumId)] = LayerDatumType;
00372    Datum[(DatumId)].UIntValue = (Cigi_uint32)LayerIn;
00373 
00374    return(CIGI_SUCCESS);
00375 
00376 }

int CigiBaseShortSymbolCtrl::SetParentSymbolID ( int  DatumId,
const Cigi_uint16  ParentSymbolIDIn,
bool  bndchk = true 
)

Sets the ParentSymbolID with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
ParentSymbolIDIn - Specifies the ID number of this symbol's parent symbol.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 333 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and ParentIdDatumType.

00335 {
00336 
00337    //This must be bound checked!
00338    if((DatumId < 0)||(DatumId > 1))
00339    {
00340 #ifndef CIGI_NO_EXCEPT
00341       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00342 #endif
00343       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00344    }
00345 
00346    DatumType[(DatumId)] = ParentIdDatumType;
00347    Datum[(DatumId)].UIntValue = (Cigi_uint32)ParentSymbolIDIn;
00348 
00349    return(CIGI_SUCCESS);
00350 
00351 }

int CigiBaseShortSymbolCtrl::SetRotation ( int  DatumId,
const float  RotationIn,
bool  bndchk = true 
)

Sets the Rotation with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
RotationIn - Specifies how much in degrees that the symbol is rotated.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 493 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and RotationDatumType.

00495 {
00496 
00497    //This must be bound checked!
00498    if((DatumId < 0)||(DatumId > 1))
00499    {
00500 #ifndef CIGI_NO_EXCEPT
00501       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00502 #endif
00503       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00504    }
00505 
00506    DatumType[(DatumId)] = RotationDatumType;
00507    Datum[(DatumId)].FloatValue = RotationIn;
00508 
00509    return(CIGI_SUCCESS);
00510 
00511 }

int CigiBaseShortSymbolCtrl::SetScaleU ( int  DatumId,
const float  ScaleUIn,
bool  bndchk = true 
)

Sets the ScaleU with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
ScaleUIn - Specifies the scale to apply to the symbol's local coordinate system's 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 518 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and ScaleUDatumType.

00520 {
00521 
00522    //This must be bound checked!
00523    if((DatumId < 0)||(DatumId > 1))
00524    {
00525 #ifndef CIGI_NO_EXCEPT
00526       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00527 #endif
00528       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00529    }
00530 
00531    DatumType[(DatumId)] = ScaleUDatumType;
00532    Datum[(DatumId)].FloatValue = ScaleUIn;
00533 
00534    return(CIGI_SUCCESS);
00535 
00536 }

int CigiBaseShortSymbolCtrl::SetScaleV ( int  DatumId,
const float  ScaleVIn,
bool  bndchk = true 
)

Sets the ScaleV with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
ScaleVIn - Specifies the scale to apply to the symbol's local coordinate system's 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 543 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and ScaleVDatumType.

00545 {
00546 
00547    //This must be bound checked!
00548    if((DatumId < 0)||(DatumId > 1))
00549    {
00550 #ifndef CIGI_NO_EXCEPT
00551       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00552 #endif
00553       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00554    }
00555 
00556    DatumType[(DatumId)] = ScaleVDatumType;
00557    Datum[(DatumId)].FloatValue = ScaleVIn;
00558 
00559    return(CIGI_SUCCESS);
00560 
00561 }

int CigiBaseShortSymbolCtrl::SetSurfaceID ( int  DatumId,
const Cigi_uint16  SurfaceIDIn,
bool  bndchk = true 
)

Sets the SurfaceID with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
SurfaceIDIn - The ID number of the surface to which this symbol should be attached.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 308 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and SurfaceIdDatumType.

00310 {
00311 
00312    //This must be bound checked!
00313    if((DatumId < 0)||(DatumId > 1))
00314    {
00315 #ifndef CIGI_NO_EXCEPT
00316       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00317 #endif
00318       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00319    }
00320 
00321    DatumType[(DatumId)] = SurfaceIdDatumType;
00322    Datum[(DatumId)].UIntValue = (Cigi_uint32)SurfaceIDIn;
00323 
00324    return(CIGI_SUCCESS);
00325 
00326 }

int CigiBaseShortSymbolCtrl::SetSymbolID ( const Cigi_uint16  SymbolIDIn,
bool  bndchk = true 
) [inline]

Sets the SymbolID with bound checking control

Parameters:
SymbolIDIn - Specifies the ID number of this symbol.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 170 of file CigiBaseShortSymbolCtrl.h.

References CIGI_SUCCESS.

00171    {
00172       SymbolID = SymbolIDIn;
00173       return(CIGI_SUCCESS);
00174    }

int CigiBaseShortSymbolCtrl::SetSymbolState ( const CigiBaseSymbolCtrl::SymbolStateGrp  SymbolStateIn,
bool  bndchk = true 
)

Sets the SymbolState with bound checking control

Parameters:
SymbolStateIn - Specifies the commanded state of this symbol. (Hidden, Visible, Destroyed)
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 94 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and SymbolState.

00095 {
00096 
00097 #ifndef CIGI_NO_BND_CHK
00098    if(bndchk && ((SymbolStateIn < 0)||(SymbolStateIn > 2)))
00099    {
00100 #ifndef CIGI_NO_EXCEPT
00101       throw CigiValueOutOfRangeException("SymbolState", (int)SymbolStateIn,0,2);
00102 #endif
00103       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00104    }
00105 #endif
00106 
00107    SymbolState = SymbolStateIn;
00108 
00109    return(CIGI_SUCCESS);
00110 
00111 }

int CigiBaseShortSymbolCtrl::SetUPosition ( int  DatumId,
const float  UPositionIn,
bool  bndchk = true 
)

Sets the UPosition with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
UPositionIn - Specifies the position of the symbol along the U axis of the surface's or symbol parent's coordinate system.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 443 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and UPositionDatumType.

00445 {
00446 
00447    //This must be bound checked!
00448    if((DatumId < 0)||(DatumId > 1))
00449    {
00450 #ifndef CIGI_NO_EXCEPT
00451       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00452 #endif
00453       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00454    }
00455 
00456    DatumType[(DatumId)] = UPositionDatumType;
00457    Datum[(DatumId)].FloatValue = UPositionIn;
00458 
00459    return(CIGI_SUCCESS);
00460 
00461 }

int CigiBaseShortSymbolCtrl::SetVPosition ( int  DatumId,
const float  VPositionIn,
bool  bndchk = true 
)

Sets the VPosition with bound checking control

Parameters:
DatumId - The ID number of the datum to be set.
VPositionIn - Specifies the position of the symbol along the V axis of the surface's or symbol parent's coordinate system.
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 468 of file CigiBaseShortSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Datum, DatumType, and VPositionDatumType.

00470 {
00471 
00472    //This must be bound checked!
00473    if((DatumId < 0)||(DatumId > 1))
00474    {
00475 #ifndef CIGI_NO_EXCEPT
00476       throw CigiValueOutOfRangeException("DatumId", (int)DatumId,1,2);
00477 #endif
00478       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00479    }
00480 
00481    DatumType[(DatumId)] = VPositionDatumType;
00482    Datum[(DatumId)].FloatValue = VPositionIn;
00483 
00484    return(CIGI_SUCCESS);
00485 
00486 }

virtual int CigiBaseShortSymbolCtrl::Unpack ( Cigi_uint8 *  Buff,
bool  Swap,
void *  Spec 
) [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
Spec - A pointer to special data.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Implements CigiBasePacket.

Implemented in CigiShortSymbolCtrlV3_3.

Friends And Related Function Documentation

friend class CigiShortSymbolCtrlV3_3 [friend]

Definition at line 66 of file CigiBaseShortSymbolCtrl.h.

Member Data Documentation

CigiBaseSymbolCtrl::AttachStateGrp CigiBaseShortSymbolCtrl::AttachState [protected]

AttachState
Whether this symbol is attached to another symbol.

Definition at line 482 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), CigiShortSymbolCtrlV3_3::Pack(), SetAttachState(), and CigiShortSymbolCtrlV3_3::Unpack().

DatumUnionType CigiBaseShortSymbolCtrl::Datum[2] [protected]

ParentSymbolID
The variables containing the specific data to be used.

Definition at line 507 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), GetColorDatum(), GetFloatDatum(), GetUIntDatum(), CigiShortSymbolCtrlV3_3::Pack(), SetColor(), SetDatumNone(), SetFlashDutyCycle(), SetFlashPeriod(), SetLayer(), SetParentSymbolID(), SetRotation(), SetScaleU(), SetScaleV(), SetSurfaceID(), SetUPosition(), SetVPosition(), and CigiShortSymbolCtrlV3_3::Unpack().

DatumTypeGrp CigiBaseShortSymbolCtrl::DatumType[2] [protected]

Datum1Type
The type of data in each of the Datum slots

Definition at line 501 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), GetDatumType(), CigiShortSymbolCtrlV3_3::Pack(), SetColor(), SetDatumNone(), SetFlashDutyCycle(), SetFlashPeriod(), SetLayer(), SetParentSymbolID(), SetRotation(), SetScaleU(), SetScaleV(), SetSurfaceID(), SetUPosition(), SetVPosition(), and CigiShortSymbolCtrlV3_3::Unpack().

CigiBaseSymbolCtrl::FlashCtrlGrp CigiBaseShortSymbolCtrl::FlashCtrl [protected]

FlashCtrl
Whether the current flash pattern is continued or restarted.

Definition at line 488 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), CigiShortSymbolCtrlV3_3::Pack(), SetFlashCtrl(), and CigiShortSymbolCtrlV3_3::Unpack().

CigiBaseSymbolCtrl::InheritColorGrp CigiBaseShortSymbolCtrl::InheritColor [protected]

InheritColor
Whether this symbol inherits its color from its parent or uses its own color.

Definition at line 495 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), CigiShortSymbolCtrlV3_3::Pack(), SetInheritColor(), and CigiShortSymbolCtrlV3_3::Unpack().

Cigi_uint16 CigiBaseShortSymbolCtrl::SymbolID [protected]

SymbolID
The ID number of this symbol

Definition at line 467 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), CigiShortSymbolCtrlV3_3::Pack(), and CigiShortSymbolCtrlV3_3::Unpack().

CigiBaseSymbolCtrl::SymbolStateGrp CigiBaseShortSymbolCtrl::SymbolState [protected]

SymbolState
The commanded state of this symbol.
Hidden
Visible
Destroyed

Definition at line 476 of file CigiBaseShortSymbolCtrl.h.

Referenced by CigiShortSymbolCtrlV3_3::CigiShortSymbolCtrlV3_3(), CigiShortSymbolCtrlV3_3::Pack(), SetSymbolState(), and CigiShortSymbolCtrlV3_3::Unpack().

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