CigiBaseTerrestrialSurfaceCtrl Class Reference

#include <CigiBaseTerrestrialSurfaceCtrl.h>

Inheritance diagram for CigiBaseTerrestrialSurfaceCtrl:


Public Types
	Global = 0
	Regional = 1
	Entity = 2
enum	ScopeGrp { Global = 0, Regional = 1, Entity = 2 }
Public Member Functions
	CigiBaseTerrestrialSurfaceCtrl ()
virtual	~CigiBaseTerrestrialSurfaceCtrl ()
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	SetEntityRgnID (const Cigi_uint16 EntityRgnIDIn, bool bndchk=true)
Cigi_uint16	GetEntityRgnID (void) const
int	SetSurfaceCondID (const Cigi_uint16 SurfaceCondIDIn, bool bndchk=true)
Cigi_uint16	GetSurfaceCondID (void) const
int	SetSurfaceCondEn (const bool SurfaceCondEnIn, bool bndchk=true)
bool	GetSurfaceCondEn (void) const
int	SetScope (const ScopeGrp ScopeIn, bool bndchk=true)
ScopeGrp	GetScope (void) const
int	SetSeverity (const Cigi_uint8 SeverityIn, bool bndchk=true)
Cigi_uint8	GetSeverity (void) const
int	SetCoverage (const Cigi_uint8 CoverageIn, bool bndchk=true)
Cigi_uint8	GetCoverage (void) const
Protected Attributes
Cigi_uint16	EntityRgnID
Cigi_uint16	SurfaceCondID
bool	SurfaceCondEn
ScopeGrp	Scope
Cigi_uint8	Severity
Cigi_uint8	Coverage
Friends
class	CigiTerrestrialSurfaceCtrlV3

Detailed Description

Definition at line 71 of file CigiBaseTerrestrialSurfaceCtrl.h.

Member Enumeration Documentation

enum CigiBaseTerrestrialSurfaceCtrl::ScopeGrp

The enumeration for the CigiBaseTerrestrialSurfaceCtrl Group

Enumerator:

Global
Regional
Entity

Definition at line 81 of file CigiBaseTerrestrialSurfaceCtrl.h.

00082    {
00083       Global=0,
00084       Regional=1,
00085       Entity=2
00086    };

Constructor & Destructor Documentation

CigiBaseTerrestrialSurfaceCtrl::CigiBaseTerrestrialSurfaceCtrl ( )

General Constructor

Definition at line 64 of file CigiBaseTerrestrialSurfaceCtrl.cpp.

00065 {
00066 
00067 }

CigiBaseTerrestrialSurfaceCtrl::~CigiBaseTerrestrialSurfaceCtrl ( ) [virtual]

General Destructor

Definition at line 74 of file CigiBaseTerrestrialSurfaceCtrl.cpp.

00075 {
00076 
00077 }

Member Function Documentation

int CigiBaseTerrestrialSurfaceCtrl::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 88 of file CigiBaseTerrestrialSurfaceCtrl.cpp.

References CIGI_SUCCESS, CIGI_TERRESTRIAL_SURFACE_CTRL_PACKET_ID_V3, CigiVersionID::CigiMajorVersion, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.

00090 {
00091    if(CnvtVersion.CigiMajorVersion < 3)
00092    {
00093       CnvtInfo.ProcID = CigiProcessType::ProcNone;
00094       CnvtInfo.CnvtPacketID = 0;
00095    }
00096    else
00097    {
00098       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00099       CnvtInfo.CnvtPacketID = CIGI_TERRESTRIAL_SURFACE_CTRL_PACKET_ID_V3;
00100    }
00101 
00102    return(CIGI_SUCCESS);
00103 }

Cigi_uint8 CigiBaseTerrestrialSurfaceCtrl::GetCoverage ( void ) const [inline]

Gets the Coverage value.

Returns:: the current Coverage.

Definition at line 264 of file CigiBaseTerrestrialSurfaceCtrl.h.

References Coverage.

00264 { return(Coverage); }

Cigi_uint16 CigiBaseTerrestrialSurfaceCtrl::GetEntityRgnID ( void ) const [inline]

Gets the EntityRgnID value.

Returns:: the current EntityRgnID.

Definition at line 168 of file CigiBaseTerrestrialSurfaceCtrl.h.

References EntityRgnID.

00168 { return(EntityRgnID); }

ScopeGrp CigiBaseTerrestrialSurfaceCtrl::GetScope ( void ) const [inline]

Gets the Scope value.

Returns:: the current Scope.

Definition at line 230 of file CigiBaseTerrestrialSurfaceCtrl.h.

References Scope.

00230 { return(Scope); }

Cigi_uint8 CigiBaseTerrestrialSurfaceCtrl::GetSeverity ( void ) const [inline]

Gets the Severity value.

Returns:: the current Severity.

Definition at line 247 of file CigiBaseTerrestrialSurfaceCtrl.h.

References Severity.

00247 { return(Severity); }

bool CigiBaseTerrestrialSurfaceCtrl::GetSurfaceCondEn ( void ) const [inline]

Gets the SurfaceCondEn value.

Returns:: the current SurfaceCondEn.

Definition at line 210 of file CigiBaseTerrestrialSurfaceCtrl.h.

References SurfaceCondEn.

00210 { return(SurfaceCondEn); }

Cigi_uint16 CigiBaseTerrestrialSurfaceCtrl::GetSurfaceCondID ( void ) const [inline]

Gets the SurfaceCondID value.

Returns:: the current SurfaceCondID.

Definition at line 189 of file CigiBaseTerrestrialSurfaceCtrl.h.

References SurfaceCondID.

00189 { return(SurfaceCondID); }

virtual int CigiBaseTerrestrialSurfaceCtrl::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 CigiTerrestrialSurfaceCtrlV3.

int CigiBaseTerrestrialSurfaceCtrl::SetCoverage	(	const Cigi_uint8	CoverageIn,
		bool	bndchk = `true`
	)

Sets the Coverage with bound checking control

Parameters:

	CoverageIn	- Coverage
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 158 of file CigiBaseTerrestrialSurfaceCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Coverage.

00159 {
00160 
00161 #ifndef CIGI_NO_BND_CHK
00162    if(bndchk && ((CoverageIn < 0)||(CoverageIn > 100)))
00163    {
00164 #ifndef CIGI_NO_EXCEPT
00165       throw CigiValueOutOfRangeException("Coverage",(Cigi_uint8)CoverageIn,0,100);
00166 #endif
00167       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00168    }
00169 #endif
00170 
00171    Coverage = CoverageIn;
00172    return(CIGI_SUCCESS);
00173 
00174 }

int CigiBaseTerrestrialSurfaceCtrl::SetEntityRgnID	(	const Cigi_uint16	EntityRgnIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the EntityRgnID with bound checking control

Parameters:

	EntityRgnIDIn	- Entity or Region ID
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 159 of file CigiBaseTerrestrialSurfaceCtrl.h.

References CIGI_SUCCESS, and EntityRgnID.

00160    {
00161       EntityRgnID = EntityRgnIDIn;
00162       return(CIGI_SUCCESS);
00163    }

int CigiBaseTerrestrialSurfaceCtrl::SetScope	(	const ScopeGrp	ScopeIn,
		bool	bndchk = `true`
	)

Sets the Scope with bound checking control

Parameters:

	ScopeIn	- Scope of effect Global=0 Regional=1 Entity=2
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 114 of file CigiBaseTerrestrialSurfaceCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Scope.

00115 {
00116 
00117 #ifndef CIGI_NO_BND_CHK
00118    if(bndchk && ((ScopeIn < 0)||(ScopeIn > 2)))
00119    {
00120 #ifndef CIGI_NO_EXCEPT
00121       throw CigiValueOutOfRangeException("Scope",(ScopeGrp)ScopeIn,0,2);
00122 #endif
00123       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00124    }
00125 #endif
00126 
00127    Scope = ScopeIn;
00128    return(CIGI_SUCCESS);
00129 
00130 }

int CigiBaseTerrestrialSurfaceCtrl::SetSeverity	(	const Cigi_uint8	SeverityIn,
		bool	bndchk = `true`
	)

Sets the Severity with bound checking control

Parameters:

	SeverityIn	- Severity
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 136 of file CigiBaseTerrestrialSurfaceCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Severity.

00137 {
00138 
00139 #ifndef CIGI_NO_BND_CHK
00140    if(bndchk && ((SeverityIn < 0)||(SeverityIn > 31)))
00141    {
00142 #ifndef CIGI_NO_EXCEPT
00143       throw CigiValueOutOfRangeException("Severity",(Cigi_uint8)SeverityIn,0,31);
00144 #endif
00145       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00146    }
00147 #endif
00148 
00149    Severity = SeverityIn;
00150    return(CIGI_SUCCESS);
00151 
00152 }

int CigiBaseTerrestrialSurfaceCtrl::SetSurfaceCondEn	(	const bool	SurfaceCondEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the SurfaceCondEn with bound checking control

Parameters:

	SurfaceCondEnIn	- Surface conditions enable
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 201 of file CigiBaseTerrestrialSurfaceCtrl.h.

References CIGI_SUCCESS, and SurfaceCondEn.

00202    {
00203       SurfaceCondEn = SurfaceCondEnIn;
00204       return(CIGI_SUCCESS);
00205    }

int CigiBaseTerrestrialSurfaceCtrl::SetSurfaceCondID	(	const Cigi_uint16	SurfaceCondIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the SurfaceCondID with bound checking control

Parameters:

	SurfaceCondIDIn	- Surface Conditions ID
	bndchk	- Enables (true) or disables (false) bounds checking.

Returns:: This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 180 of file CigiBaseTerrestrialSurfaceCtrl.h.

References CIGI_SUCCESS, and SurfaceCondID.

00181    {
00182       SurfaceCondID = SurfaceCondIDIn;
00183       return(CIGI_SUCCESS);
00184    }

virtual int CigiBaseTerrestrialSurfaceCtrl::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 CigiTerrestrialSurfaceCtrlV3.

Friends And Related Function Documentation

friend class CigiTerrestrialSurfaceCtrlV3 [friend]

Definition at line 74 of file CigiBaseTerrestrialSurfaceCtrl.h.

Member Data Documentation

Cigi_uint8 CigiBaseTerrestrialSurfaceCtrl::Coverage [protected]

Coverage
Percentage coverage over the specified area.

Definition at line 309 of file CigiBaseTerrestrialSurfaceCtrl.h.

Referenced by CigiTerrestrialSurfaceCtrlV3::CigiTerrestrialSurfaceCtrlV3(), GetCoverage(), CigiTerrestrialSurfaceCtrlV3::Pack(), SetCoverage(), and CigiTerrestrialSurfaceCtrlV3::Unpack().

Cigi_uint16 CigiBaseTerrestrialSurfaceCtrl::EntityRgnID [protected]

EntityRgnID
Entity or Region ID

Definition at line 276 of file CigiBaseTerrestrialSurfaceCtrl.h.

Referenced by CigiTerrestrialSurfaceCtrlV3::CigiTerrestrialSurfaceCtrlV3(), GetEntityRgnID(), CigiTerrestrialSurfaceCtrlV3::Pack(), SetEntityRgnID(), and CigiTerrestrialSurfaceCtrlV3::Unpack().

ScopeGrp CigiBaseTerrestrialSurfaceCtrl::Scope [protected]

Scope
Scope of effect
0-Global
1-Regional
2-Entity

Definition at line 298 of file CigiBaseTerrestrialSurfaceCtrl.h.

Referenced by CigiTerrestrialSurfaceCtrlV3::CigiTerrestrialSurfaceCtrlV3(), GetScope(), CigiTerrestrialSurfaceCtrlV3::Pack(), SetScope(), and CigiTerrestrialSurfaceCtrlV3::Unpack().

Cigi_uint8 CigiBaseTerrestrialSurfaceCtrl::Severity [protected]

Severity

Definition at line 303 of file CigiBaseTerrestrialSurfaceCtrl.h.

Referenced by CigiTerrestrialSurfaceCtrlV3::CigiTerrestrialSurfaceCtrlV3(), GetSeverity(), CigiTerrestrialSurfaceCtrlV3::Pack(), SetSeverity(), and CigiTerrestrialSurfaceCtrlV3::Unpack().

bool CigiBaseTerrestrialSurfaceCtrl::SurfaceCondEn [protected]

SurfaceCondEn
Surface conditions enable

Definition at line 288 of file CigiBaseTerrestrialSurfaceCtrl.h.

Referenced by CigiTerrestrialSurfaceCtrlV3::CigiTerrestrialSurfaceCtrlV3(), GetSurfaceCondEn(), CigiTerrestrialSurfaceCtrlV3::Pack(), SetSurfaceCondEn(), and CigiTerrestrialSurfaceCtrlV3::Unpack().

Cigi_uint16 CigiBaseTerrestrialSurfaceCtrl::SurfaceCondID [protected]

SurfaceCondID
Surface conditions ID

Definition at line 282 of file CigiBaseTerrestrialSurfaceCtrl.h.

Referenced by CigiTerrestrialSurfaceCtrlV3::CigiTerrestrialSurfaceCtrlV3(), GetSurfaceCondID(), CigiTerrestrialSurfaceCtrlV3::Pack(), SetSurfaceCondID(), and CigiTerrestrialSurfaceCtrlV3::Unpack().

The documentation for this class was generated from the following files:

ccl/include/CigiBaseTerrestrialSurfaceCtrl.h
ccl/source/CigiBaseTerrestrialSurfaceCtrl.cpp

Generated on Wed Apr 29 09:00:06 2009 for CCL by

1.4.7

CigiBaseTerrestrialSurfaceCtrl 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