CCL: CigiBaseSymbolCtrl Class Reference

The enumeration for the Attach State Group

Enumerator:

Detach
Attach

Definition at line 83 of file CigiBaseSymbolCtrl.h.

00084    {
00085       Detach=0,
00086       Attach=1
00087    };

enum CigiBaseSymbolCtrl::FlashCtrlGrp

The enumeration for the Flash Control flag

Enumerator:

Continue
Reset

Definition at line 92 of file CigiBaseSymbolCtrl.h.

00093    {
00094       Continue=0,
00095       Reset=1
00096    };

enum CigiBaseSymbolCtrl::InheritColorGrp

The enumeration for the Inherit Color flag

Enumerator:

NotInherit
Inherit

Definition at line 101 of file CigiBaseSymbolCtrl.h.

00102    {
00103       NotInherit=0,
00104       Inherit=1
00105    };

enum CigiBaseSymbolCtrl::SymbolStateGrp

The enumeration for the Symbol State Group

Enumerator:

Hidden
Visible
Destroyed

Definition at line 73 of file CigiBaseSymbolCtrl.h.

00074    {
00075       Hidden=0,
00076       Visible=1,
00077       Destroyed=2
00078    };

CigiBaseSymbolCtrl::CigiBaseSymbolCtrl ( void )

General Constructor

Definition at line 55 of file CigiBaseSymbolCtrl.cpp.

00056 {
00057 }

CigiBaseSymbolCtrl::~CigiBaseSymbolCtrl ( void ) [virtual]

General Destructor

Definition at line 62 of file CigiBaseSymbolCtrl.cpp.

00063 {
00064 }

Cigi_uint8 CigiBaseSymbolCtrl::GetAlpha ( void ) const [inline]

Gets the Alpha with bound checking control

Returns:: The alpha component of the symbol's color.

Definition at line 593 of file CigiBaseSymbolCtrl.h.

References Alpha.

00593 { return(Alpha); }

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

Gets the AttachState with bound checking control

Returns:: The attach state of this symbol

Definition at line 226 of file CigiBaseSymbolCtrl.h.

References AttachState.

00226 { return(AttachState); }

Cigi_uint8 CigiBaseSymbolCtrl::GetBlue ( void ) const [inline]

Gets the Blue with bound checking control

Returns:: The blue component of the symbol's color.

Definition at line 571 of file CigiBaseSymbolCtrl.h.

References Blue.

00571 { return(Blue); }

int CigiBaseSymbolCtrl::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 70 of file CigiBaseSymbolCtrl.cpp.

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

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

int CigiBaseSymbolCtrl::GetColorDatum	(	Cigi_uint8 &	RedValue,
		Cigi_uint8 &	GreenValue,
		Cigi_uint8 &	BlueValue,
		Cigi_uint8 &	AlphaValue,
		bool	bndchk = `true`
	)			`[inline]`

Gets the ParentSymbolID with bound checking control

Parameters:

	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 493 of file CigiBaseSymbolCtrl.h.

References Alpha, Blue, CIGI_SUCCESS, Green, and Red.

00498    {
00499       RedValue = Red;
00500       GreenValue = Green;
00501       BlueValue = Blue;
00502       AlphaValue = Alpha;
00503 
00504       return(CIGI_SUCCESS);
00505    }

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

Gets the FlashCtrl with bound checking control

Returns:: The commanded flash control of this symbol.

Definition at line 245 of file CigiBaseSymbolCtrl.h.

References FlashCtrl.

00245 { return(FlashCtrl); }

Cigi_uint8 CigiBaseSymbolCtrl::GetFlashDutyCycle ( void ) const [inline]

Gets the FlashDutyCycle with bound checking control

Returns:: The percentage of time that the symbol is visible.

Definition at line 355 of file CigiBaseSymbolCtrl.h.

References FlashDutyCycle.

00355 { return(FlashDutyCycle); }

float CigiBaseSymbolCtrl::GetFlashPeriod ( void ) const [inline]

Gets the FlashPeriod with bound checking control

Returns:: The amount of time in seconds of a full flash cycle.

Definition at line 379 of file CigiBaseSymbolCtrl.h.

References FlashPeriod.

00379 { return(FlashPeriod); }

Cigi_uint8 CigiBaseSymbolCtrl::GetGreen ( void ) const [inline]

Gets the Green with bound checking control

Returns:: The green component of the symbol's color.

Definition at line 549 of file CigiBaseSymbolCtrl.h.

References Green.

00549 { return(Green); }

InheritColorGrp CigiBaseSymbolCtrl::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 265 of file CigiBaseSymbolCtrl.h.

References InheritColor.

00265 { return(InheritColor); }

Cigi_uint8 CigiBaseSymbolCtrl::GetLayer ( void ) const [inline]

Gets the Layer with bound checking control

Returns:: The ID number of the layer that this symbol occupies.

Definition at line 335 of file CigiBaseSymbolCtrl.h.

References Layer.

00335 { return(Layer); }

Cigi_uint16 CigiBaseSymbolCtrl::GetParentSymbolID ( void ) const [inline]

Gets the ParentSymbolID with bound checking control

Returns:: The ParentSymbol ID

Definition at line 288 of file CigiBaseSymbolCtrl.h.

References ParentSymbolID.

00288 { return(ParentSymbolID); }

Cigi_uint8 CigiBaseSymbolCtrl::GetRed ( void ) const [inline]

Gets the Red with bound checking control

Returns:: The red component of the symbol's color.

Definition at line 527 of file CigiBaseSymbolCtrl.h.

References Red.

00527 { return(Red); }

float CigiBaseSymbolCtrl::GetRotation ( void ) const [inline]

Gets the Rotation with bound checking control

Returns:: How much in degrees that the symbol is rotated.

Definition at line 450 of file CigiBaseSymbolCtrl.h.

References Rotation.

00450 { return(Rotation); }

float CigiBaseSymbolCtrl::GetScaleU ( void ) const [inline]

Gets the ScaleU with bound checking control

Returns:: The scale to apply to the symbol's local coordinate system's U axis.

Definition at line 617 of file CigiBaseSymbolCtrl.h.

References ScaleU.

00617 { return(ScaleU); }

float CigiBaseSymbolCtrl::GetScaleV ( void ) const [inline]

Gets the ScaleV with bound checking control

Returns:: The scale to apply to the symbol's local coordinate system'sV axis.

Definition at line 641 of file CigiBaseSymbolCtrl.h.

References ScaleV.

00641 { return(ScaleV); }

Cigi_uint16 CigiBaseSymbolCtrl::GetSurfaceID ( void ) const [inline]

Gets the SurfaceID with bound checking control

Returns:: The Surface ID to which this symbol is attached.

Definition at line 311 of file CigiBaseSymbolCtrl.h.

References SurfaceID.

00311 { return(SurfaceID); }

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

Gets the SymbolID with bound checking control

Returns:: The ID number of this symbol.

Definition at line 187 of file CigiBaseSymbolCtrl.h.

References SymbolID.

00187 { return(SymbolID); }

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

Gets the SymbolState with bound checking control

Returns:: The commanded state of this symbol. (Hidden, Visible, Destroyed)

Definition at line 207 of file CigiBaseSymbolCtrl.h.

References SymbolState.

00207 { return(SymbolState); }

float CigiBaseSymbolCtrl::GetUPosition ( void ) const [inline]

Gets the UPosition with bound checking control

Returns:: The position of the symbol along the U axis of the surface's or symbol parent's coordinate system.

Definition at line 403 of file CigiBaseSymbolCtrl.h.

References UPosition.

00403 { return(UPosition); }

float CigiBaseSymbolCtrl::GetVPosition ( void ) const [inline]

Gets the VPosition with bound checking control

Returns:: The position of the symbol along theV axis of the surface's or symbol parent's coordinate system.

Definition at line 427 of file CigiBaseSymbolCtrl.h.

References VPosition.

00427 { return(VPosition); }

virtual int CigiBaseSymbolCtrl::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 CigiSymbolCtrlV3_3.

int CigiBaseSymbolCtrl::SetAlpha	(	const Cigi_uint8	AlphaIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Alpha with bound checking control

Parameters:

	AlphaIn	- The alpha component of the symbol's 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 583 of file CigiBaseSymbolCtrl.h.

References Alpha, and CIGI_SUCCESS.

00584    {
00585       Alpha = AlphaIn;
00586       return(CIGI_SUCCESS);
00587    }

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

Sets the AttachState with bound checking control

Parameters:

	AttachStateIn	- Specifies whether the symbol is attached or 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 119 of file CigiBaseSymbolCtrl.cpp.

References AttachState, CIGI_ERROR_VALUE_OUT_OF_RANGE, and CIGI_SUCCESS.

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

int CigiBaseSymbolCtrl::SetBlue	(	const Cigi_uint8	BlueIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Blue with bound checking control

Parameters:

	BlueIn	- The blue component of the symbol's 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 561 of file CigiBaseSymbolCtrl.h.

References Blue, and CIGI_SUCCESS.

00562    {
00563       Blue = BlueIn;
00564       return(CIGI_SUCCESS);
00565    }

int CigiBaseSymbolCtrl::SetColor	(	const Cigi_uint8	RedIn,
		const Cigi_uint8	GreenIn,
		const Cigi_uint8	BlueIn,
		const Cigi_uint8	AlphaIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the color with bound checking control

Parameters:

	RedIn	- The red component of the symbol's color.
	GreenIn	- The green component of the symbol's color.
	BlueIn	- The blue component of the symbol's color.
	AlphaIn	- The alpha component of the symbol's 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 465 of file CigiBaseSymbolCtrl.h.

References Alpha, Blue, CIGI_SUCCESS, Green, and Red.

00470    {
00471       Red = RedIn;
00472       Green = GreenIn;
00473       Blue = BlueIn;
00474       Alpha = AlphaIn;
00475 
00476       return(CIGI_SUCCESS);
00477    }

int CigiBaseSymbolCtrl::SetFlashCtrl	(	const 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 143 of file CigiBaseSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and FlashCtrl.

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

int CigiBaseSymbolCtrl::SetFlashDutyCycle	(	const Cigi_uint8	FlashDutyCycleIn,
		bool	bndchk = `true`
	)

Sets the FlashDutyCycle with bound checking control

Parameters:

	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 191 of file CigiBaseSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and FlashDutyCycle.

00192 {
00193 
00194 #ifndef CIGI_NO_BND_CHK
00195    if(bndchk && ((FlashDutyCycleIn < 0)||(FlashDutyCycleIn > 100)))
00196    {
00197 #ifndef CIGI_NO_EXCEPT
00198       throw CigiValueOutOfRangeException("FlashDutyCycle", (int)FlashDutyCycleIn,0,100);
00199 #endif
00200       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00201    }
00202 #endif
00203 
00204    FlashDutyCycle = FlashDutyCycleIn;
00205 
00206    return(CIGI_SUCCESS);
00207 
00208 }

int CigiBaseSymbolCtrl::SetFlashPeriod	(	const float	FlashPeriodIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the FlashPeriod with bound checking control

Parameters:

	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 368 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and FlashPeriod.

00369    {
00370       FlashPeriod = FlashPeriodIn;
00371       return(CIGI_SUCCESS);
00372    }

int CigiBaseSymbolCtrl::SetGreen	(	const Cigi_uint8	GreenIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Green with bound checking control

Parameters:

	GreenIn	- The green component of the symbol's 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 539 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and Green.

00540    {
00541       Green = GreenIn;
00542       return(CIGI_SUCCESS);
00543    }

int CigiBaseSymbolCtrl::SetInheritColor	(	const 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 167 of file CigiBaseSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and InheritColor.

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

int CigiBaseSymbolCtrl::SetLayer	(	const Cigi_uint8	LayerIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Layer with bound checking control

Parameters:

	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 324 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and Layer.

00325    {
00326       Layer = LayerIn;
00327       return(CIGI_SUCCESS);
00328    }

int CigiBaseSymbolCtrl::SetParentSymbolID	(	const Cigi_uint16	ParentSymbolIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ParentSymbolID with bound checking control

Parameters:

	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 278 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and ParentSymbolID.

00279    {
00280       ParentSymbolID = ParentSymbolIDIn;
00281       return(CIGI_SUCCESS);
00282    }

int CigiBaseSymbolCtrl::SetRed	(	const Cigi_uint8	RedIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Red with bound checking control

Parameters:

	RedIn	- The red component of the symbol's 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 517 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and Red.

00518    {
00519       Red = RedIn;
00520       return(CIGI_SUCCESS);
00521    }

int CigiBaseSymbolCtrl::SetRotation	(	const float	RotationIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the Rotation with bound checking control

Parameters:

	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 440 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and Rotation.

00441    {
00442       Rotation = RotationIn;
00443       return(CIGI_SUCCESS);
00444    }

int CigiBaseSymbolCtrl::SetScaleU	(	const float	ScaleUIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ScaleU with bound checking control

Parameters:

	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 606 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and ScaleU.

00607    {
00608       ScaleU = ScaleUIn;
00609       return(CIGI_SUCCESS);
00610    }

int CigiBaseSymbolCtrl::SetScaleV	(	const float	ScaleVIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the ScaleV with bound checking control

Parameters:

	ScaleVIn	- Specifies the scale to apply to the symbol's local coordinate system'sV 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 630 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and ScaleV.

00631    {
00632       ScaleV = ScaleVIn;
00633       return(CIGI_SUCCESS);
00634    }

int CigiBaseSymbolCtrl::SetSurfaceID	(	const Cigi_uint16	SurfaceIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the SurfaceID with bound checking control

Parameters:

	SurfaceIDIn	- Specifies the ID number of the surface to which this symbol is 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 301 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and SurfaceID.

00302    {
00303       SurfaceID = SurfaceIDIn;
00304       return(CIGI_SUCCESS);
00305    }

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

Sets the SymbolID with bound checking control

Parameters:

	SymbolIDIn	- 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 177 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and SymbolID.

00178    {
00179       SymbolID = SymbolIDIn;
00180       return(CIGI_SUCCESS);
00181    }

int CigiBaseSymbolCtrl::SetSymbolState	(	const 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 95 of file CigiBaseSymbolCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and SymbolState.

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

int CigiBaseSymbolCtrl::SetUPosition	(	const float	UPositionIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the UPosition with bound checking control

Parameters:

	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 392 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and UPosition.

00393    {
00394       UPosition = UPositionIn;
00395       return(CIGI_SUCCESS);
00396    }

int CigiBaseSymbolCtrl::SetVPosition	(	const float	VPositionIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the VPosition with bound checking control

Parameters:

	VPositionIn	- Specifies the position of the symbol along theV 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 416 of file CigiBaseSymbolCtrl.h.

References CIGI_SUCCESS, and VPosition.

00417    {
00418       VPosition = VPositionIn;
00419       return(CIGI_SUCCESS);
00420    }

virtual int CigiBaseSymbolCtrl::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 CigiSymbolCtrlV3_3.

friend class CigiSymbolCtrlV3_3 [friend]

Definition at line 66 of file CigiBaseSymbolCtrl.h.

Cigi_uint8 CigiBaseSymbolCtrl::Alpha [protected]

Alpha
The alpha component of the symbol's color.

Definition at line 755 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetAlpha(), GetColorDatum(), CigiSymbolCtrlV3_3::Pack(), SetAlpha(), SetColor(), and CigiSymbolCtrlV3_3::Unpack().

AttachStateGrp CigiBaseSymbolCtrl::AttachState [protected]

AttachState
Whether this symbol is attached to another symbol.

Definition at line 668 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetAttachState(), CigiSymbolCtrlV3_3::Pack(), SetAttachState(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint8 CigiBaseSymbolCtrl::Blue [protected]

Blue
The blue component of the symbol's color.

Definition at line 749 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetBlue(), GetColorDatum(), CigiSymbolCtrlV3_3::Pack(), SetBlue(), SetColor(), and CigiSymbolCtrlV3_3::Unpack().

FlashCtrlGrp CigiBaseSymbolCtrl::FlashCtrl [protected]

FlashCtrl
Whether the current flash pattern is continued or restarted.

Definition at line 674 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetFlashCtrl(), CigiSymbolCtrlV3_3::Pack(), SetFlashCtrl(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint8 CigiBaseSymbolCtrl::FlashDutyCycle [protected]

FlashDutyCycle
The percentage of time that this symbol is visible.

Definition at line 705 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetFlashDutyCycle(), CigiSymbolCtrlV3_3::Pack(), SetFlashDutyCycle(), and CigiSymbolCtrlV3_3::Unpack().

float CigiBaseSymbolCtrl::FlashPeriod [protected]

FlashPeriod
The amount of time that a flash cycle takes.

Definition at line 711 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetFlashPeriod(), CigiSymbolCtrlV3_3::Pack(), SetFlashPeriod(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint8 CigiBaseSymbolCtrl::Green [protected]

Green
The green component of the symbol's color.

Definition at line 743 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetColorDatum(), GetGreen(), CigiSymbolCtrlV3_3::Pack(), SetColor(), SetGreen(), and CigiSymbolCtrlV3_3::Unpack().

InheritColorGrp CigiBaseSymbolCtrl::InheritColor [protected]

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

Definition at line 681 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetInheritColor(), CigiSymbolCtrlV3_3::Pack(), SetInheritColor(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint8 CigiBaseSymbolCtrl::Layer [protected]

Layer
The ID number of the layer that this symbol occupies.

Definition at line 699 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetLayer(), CigiSymbolCtrlV3_3::Pack(), SetLayer(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint16 CigiBaseSymbolCtrl::ParentSymbolID [protected]

ParentSymbolID
The ID number of this symbol's parent symbol.

Definition at line 687 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetParentSymbolID(), CigiSymbolCtrlV3_3::Pack(), SetParentSymbolID(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint8 CigiBaseSymbolCtrl::Red [protected]

Red
The red component of the symbol's color.

Definition at line 737 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetColorDatum(), GetRed(), CigiSymbolCtrlV3_3::Pack(), SetColor(), SetRed(), and CigiSymbolCtrlV3_3::Unpack().

float CigiBaseSymbolCtrl::Rotation [protected]

Rotation
How much in degrees that the symbol is rotated.

Definition at line 731 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetRotation(), CigiSymbolCtrlV3_3::Pack(), SetRotation(), and CigiSymbolCtrlV3_3::Unpack().

float CigiBaseSymbolCtrl::ScaleU [protected]

ScaleU
The scale to apply to the symbol's local coordinate system's U axis.

Definition at line 762 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetScaleU(), CigiSymbolCtrlV3_3::Pack(), SetScaleU(), and CigiSymbolCtrlV3_3::Unpack().

float CigiBaseSymbolCtrl::ScaleV [protected]

ScaleV
The scale to apply to the symbol's local coordinate system's U axis.

Definition at line 769 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetScaleV(), CigiSymbolCtrlV3_3::Pack(), SetScaleV(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint16 CigiBaseSymbolCtrl::SurfaceID [protected]

SurfaceID
The ID number of the surface to which this symbol is attached.

Definition at line 693 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetSurfaceID(), CigiSymbolCtrlV3_3::Pack(), SetSurfaceID(), and CigiSymbolCtrlV3_3::Unpack().

Cigi_uint16 CigiBaseSymbolCtrl::SymbolID [protected]

SymbolID
The ID number of this symbol

Definition at line 653 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetSymbolID(), CigiSymbolCtrlV3_3::Pack(), SetSymbolID(), and CigiSymbolCtrlV3_3::Unpack().

SymbolStateGrp CigiBaseSymbolCtrl::SymbolState [protected]

SymbolState
The commanded state of this symbol.
Hidden
Visible
Destroyed

Definition at line 662 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetSymbolState(), CigiSymbolCtrlV3_3::Pack(), SetSymbolState(), and CigiSymbolCtrlV3_3::Unpack().

float CigiBaseSymbolCtrl::UPosition [protected]

UPosition
The position of the symbol along the U axis of the surface's or symbol parent's coordinate system.

Definition at line 718 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetUPosition(), CigiSymbolCtrlV3_3::Pack(), SetUPosition(), and CigiSymbolCtrlV3_3::Unpack().

float CigiBaseSymbolCtrl::VPosition [protected]

VPosition
The position of the symbol along theV axis of the surface's or symbol parent's coordinate system.

Definition at line 725 of file CigiBaseSymbolCtrl.h.

Referenced by CigiSymbolCtrlV3_3::CigiSymbolCtrlV3_3(), GetVPosition(), CigiSymbolCtrlV3_3::Pack(), SetVPosition(), and CigiSymbolCtrlV3_3::Unpack().

CigiBaseSymbolCtrl Class Reference

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation


Public Types
	Hidden = 0
	Visible = 1
	Destroyed = 2
	Detach = 0
	Attach = 1
	Continue = 0
	Reset = 1
	NotInherit = 0
	Inherit = 1
enum	SymbolStateGrp { Hidden = 0, Visible = 1, Destroyed = 2 }
enum	AttachStateGrp { Detach = 0, Attach = 1 }
enum	FlashCtrlGrp { Continue = 0, Reset = 1 }
enum	InheritColorGrp { NotInherit = 0, Inherit = 1 }
Public Member Functions
	CigiBaseSymbolCtrl (void)
virtual	~CigiBaseSymbolCtrl (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 SymbolStateGrp SymbolStateIn, bool bndchk=true)
SymbolStateGrp	GetSymbolState (void) const
int	SetAttachState (const AttachStateGrp AttachStateIn, bool bndchk=true)
AttachStateGrp	GetAttachState (void) const
int	SetFlashCtrl (const FlashCtrlGrp FlashCtrlIn, bool bndchk=true)
FlashCtrlGrp	GetFlashCtrl (void) const
int	SetInheritColor (const InheritColorGrp InheritColorIn, bool bndchk=true)
InheritColorGrp	GetInheritColor (void) const
int	SetParentSymbolID (const Cigi_uint16 ParentSymbolIDIn, bool bndchk=true)
Cigi_uint16	GetParentSymbolID (void) const
int	SetSurfaceID (const Cigi_uint16 SurfaceIDIn, bool bndchk=true)
Cigi_uint16	GetSurfaceID (void) const
int	SetLayer (const Cigi_uint8 LayerIn, bool bndchk=true)
Cigi_uint8	GetLayer (void) const
int	SetFlashDutyCycle (const Cigi_uint8 FlashDutyCycleIn, bool bndchk=true)
Cigi_uint8	GetFlashDutyCycle (void) const
int	SetFlashPeriod (const float FlashPeriodIn, bool bndchk=true)
float	GetFlashPeriod (void) const
int	SetUPosition (const float UPositionIn, bool bndchk=true)
float	GetUPosition (void) const
int	SetVPosition (const float VPositionIn, bool bndchk=true)
float	GetVPosition (void) const
int	SetRotation (const float RotationIn, bool bndchk=true)
float	GetRotation (void) const
int	SetColor (const Cigi_uint8 RedIn, const Cigi_uint8 GreenIn, const Cigi_uint8 BlueIn, const Cigi_uint8 AlphaIn, bool bndchk=true)
int	GetColorDatum (Cigi_uint8 &RedValue, Cigi_uint8 &GreenValue, Cigi_uint8 &BlueValue, Cigi_uint8 &AlphaValue, bool bndchk=true)
int	SetRed (const Cigi_uint8 RedIn, bool bndchk=true)
Cigi_uint8	GetRed (void) const
int	SetGreen (const Cigi_uint8 GreenIn, bool bndchk=true)
Cigi_uint8	GetGreen (void) const
int	SetBlue (const Cigi_uint8 BlueIn, bool bndchk=true)
Cigi_uint8	GetBlue (void) const
int	SetAlpha (const Cigi_uint8 AlphaIn, bool bndchk=true)
Cigi_uint8	GetAlpha (void) const
int	SetScaleU (const float ScaleUIn, bool bndchk=true)
float	GetScaleU (void) const
int	SetScaleV (const float ScaleVIn, bool bndchk=true)
float	GetScaleV (void) const
Protected Attributes
Cigi_uint16	SymbolID
SymbolStateGrp	SymbolState
AttachStateGrp	AttachState
FlashCtrlGrp	FlashCtrl
InheritColorGrp	InheritColor
Cigi_uint16	ParentSymbolID
Cigi_uint16	SurfaceID
Cigi_uint8	Layer
Cigi_uint8	FlashDutyCycle
float	FlashPeriod
float	UPosition
float	VPosition
float	Rotation
Cigi_uint8	Red
Cigi_uint8	Green
Cigi_uint8	Blue
Cigi_uint8	Alpha
float	ScaleU
float	ScaleV
Friends
class	CigiSymbolCtrlV3_3