CigiBaseMaritimeSurfaceCtrl Class Reference

#include <CigiBaseMaritimeSurfaceCtrl.h>

Inheritance diagram for CigiBaseMaritimeSurfaceCtrl:


Public Types
	Global = 0
	Regional = 1
	Entity = 2
enum	ScopeGrp { Global = 0, Regional = 1, Entity = 2 }
Public Member Functions
	CigiBaseMaritimeSurfaceCtrl ()
virtual	~CigiBaseMaritimeSurfaceCtrl ()
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	SetSurfaceCondEn (const bool SurfaceCondEnIn, bool bndchk=true)
bool	GetSurfaceCondEn (void) const
int	SetWhitecapEn (const bool WhitecapEnIn, bool bndchk=true)
bool	GetWhitecapEn (void) const
int	SetScope (const ScopeGrp ScopeIn, bool bndchk=true)
ScopeGrp	GetScope (void) const
int	SetSurfaceHeight (const float SurfaceHeightIn, bool bndchk=true)
float	GetSurfaceHeight (void) const
int	SetWaterTemp (const float WaterTempIn, bool bndchk=true)
float	GetWaterTemp (void) const
int	SetClarity (const float ClarityIn, bool bndchk=true)
float	GetClarity (void) const
Protected Attributes
Cigi_uint16	EntityRgnID
bool	SurfaceCondEn
bool	WhitecapEn
ScopeGrp	Scope
float	SurfaceHeight
float	WaterTemp
float	Clarity
Friends
class	CigiMaritimeSurfaceCtrlV3

Detailed Description

Definition at line 71 of file CigiBaseMaritimeSurfaceCtrl.h.

Member Enumeration Documentation

enum CigiBaseMaritimeSurfaceCtrl::ScopeGrp

The enumeration for the CigiBaseMaritimeSurfaceCtrl Group

Enumerator:

Global
Regional
Entity

Definition at line 81 of file CigiBaseMaritimeSurfaceCtrl.h.

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

Constructor & Destructor Documentation

CigiBaseMaritimeSurfaceCtrl::CigiBaseMaritimeSurfaceCtrl ( )

General Constructor

Definition at line 60 of file CigiBaseMaritimeSurfaceCtrl.cpp.

00061 {
00062 
00063 }

CigiBaseMaritimeSurfaceCtrl::~CigiBaseMaritimeSurfaceCtrl ( ) [virtual]

General Destructor

Definition at line 70 of file CigiBaseMaritimeSurfaceCtrl.cpp.

00071 {
00072 
00073 }

Member Function Documentation

float CigiBaseMaritimeSurfaceCtrl::GetClarity ( void ) const [inline]

Gets the Clarity value.

Returns:: the current Clarity.

Definition at line 289 of file CigiBaseMaritimeSurfaceCtrl.h.

References Clarity.

00289 { return(Clarity); }

int CigiBaseMaritimeSurfaceCtrl::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 84 of file CigiBaseMaritimeSurfaceCtrl.cpp.

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

00086 {
00087    if(CnvtVersion.CigiMajorVersion < 3)
00088    {
00089       CnvtInfo.ProcID = CigiProcessType::ProcNone;
00090       CnvtInfo.CnvtPacketID = 0;
00091    }
00092    else
00093    {
00094       CnvtInfo.ProcID = CigiProcessType::ProcStd;
00095       CnvtInfo.CnvtPacketID = CIGI_MARITIME_SURFACE_CTRL_PACKET_ID_V3;
00096    }
00097 
00098    return(CIGI_SUCCESS);
00099 }

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

Gets the EntityRgnID value.

Returns:: the current EntityRgnID.

Definition at line 168 of file CigiBaseMaritimeSurfaceCtrl.h.

References EntityRgnID.

00168 { return(EntityRgnID); }

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

Gets the Scope value.

Returns:: the current Scope.

Definition at line 230 of file CigiBaseMaritimeSurfaceCtrl.h.

References Scope.

00230 { return(Scope); }

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

Gets the SurfaceCondEn value.

Returns:: the current SurfaceCondEn.

Definition at line 189 of file CigiBaseMaritimeSurfaceCtrl.h.

References SurfaceCondEn.

00189 { return(SurfaceCondEn); }

float CigiBaseMaritimeSurfaceCtrl::GetSurfaceHeight ( void ) const [inline]

Gets the SurfaceHeight value.

Returns:: the current SurfaceHeight.

Definition at line 251 of file CigiBaseMaritimeSurfaceCtrl.h.

References SurfaceHeight.

00251 { return(SurfaceHeight); }

float CigiBaseMaritimeSurfaceCtrl::GetWaterTemp ( void ) const [inline]

Gets the WaterTemp value.

Returns:: the current WaterTemp.

Definition at line 272 of file CigiBaseMaritimeSurfaceCtrl.h.

References WaterTemp.

00272 { return(WaterTemp); }

bool CigiBaseMaritimeSurfaceCtrl::GetWhitecapEn ( void ) const [inline]

Gets the WhitecapEn value.

Returns:: the current WhitecapEn.

Definition at line 210 of file CigiBaseMaritimeSurfaceCtrl.h.

References WhitecapEn.

00210 { return(WhitecapEn); }

virtual int CigiBaseMaritimeSurfaceCtrl::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 CigiMaritimeSurfaceCtrlV3.

int CigiBaseMaritimeSurfaceCtrl::SetClarity	(	const float	ClarityIn,
		bool	bndchk = `true`
	)

Sets the Clarity with bound checking control

Parameters:

	ClarityIn	- Sea surface clarity
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 132 of file CigiBaseMaritimeSurfaceCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Clarity.

00133 {
00134 
00135 #ifndef CIGI_NO_BND_CHK
00136    if(bndchk && ((ClarityIn < 0.0)||(ClarityIn > 100.0)))
00137    {
00138 #ifndef CIGI_NO_EXCEPT
00139       throw CigiValueOutOfRangeException("Clarity",(float)ClarityIn,0.0,100.0);
00140 #endif
00141       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00142    }
00143 #endif
00144 
00145    Clarity = ClarityIn;
00146    return(CIGI_SUCCESS);
00147 
00148 }

int CigiBaseMaritimeSurfaceCtrl::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 CigiBaseMaritimeSurfaceCtrl.h.

References CIGI_SUCCESS, and EntityRgnID.

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

int CigiBaseMaritimeSurfaceCtrl::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 110 of file CigiBaseMaritimeSurfaceCtrl.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Scope.

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

int CigiBaseMaritimeSurfaceCtrl::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 180 of file CigiBaseMaritimeSurfaceCtrl.h.

References CIGI_SUCCESS, and SurfaceCondEn.

00181    {
00182       SurfaceCondEn = SurfaceCondEnIn;
00183       return(CIGI_SUCCESS);
00184    }

int CigiBaseMaritimeSurfaceCtrl::SetSurfaceHeight	(	const float	SurfaceHeightIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the SurfaceHeight with bound checking control

Parameters:

	SurfaceHeightIn	- Sea surface height
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 242 of file CigiBaseMaritimeSurfaceCtrl.h.

References CIGI_SUCCESS, and SurfaceHeight.

00243    {
00244       SurfaceHeight = SurfaceHeightIn;
00245       return(CIGI_SUCCESS);
00246    }

int CigiBaseMaritimeSurfaceCtrl::SetWaterTemp	(	const float	WaterTempIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the WaterTemp with bound checking control

Parameters:

	WaterTempIn	- Sea surface water temperature
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 263 of file CigiBaseMaritimeSurfaceCtrl.h.

References CIGI_SUCCESS, and WaterTemp.

00264    {
00265       WaterTemp = WaterTempIn;
00266       return(CIGI_SUCCESS);
00267    }

int CigiBaseMaritimeSurfaceCtrl::SetWhitecapEn	(	const bool	WhitecapEnIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the WhitecapEn with bound checking control

Parameters:

	WhitecapEnIn	- Whitecap 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 CigiBaseMaritimeSurfaceCtrl.h.

References CIGI_SUCCESS, and WhitecapEn.

00202    {
00203       WhitecapEn = WhitecapEnIn;
00204       return(CIGI_SUCCESS);
00205    }

virtual int CigiBaseMaritimeSurfaceCtrl::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 CigiMaritimeSurfaceCtrlV3.

Friends And Related Function Documentation

friend class CigiMaritimeSurfaceCtrlV3 [friend]

Definition at line 74 of file CigiBaseMaritimeSurfaceCtrl.h.

Member Data Documentation

float CigiBaseMaritimeSurfaceCtrl::Clarity [protected]

Clarity
Sea surface water percentage clarity

Definition at line 341 of file CigiBaseMaritimeSurfaceCtrl.h.

Referenced by CigiMaritimeSurfaceCtrlV3::CigiMaritimeSurfaceCtrlV3(), GetClarity(), CigiMaritimeSurfaceCtrlV3::Pack(), SetClarity(), and CigiMaritimeSurfaceCtrlV3::Unpack().

Cigi_uint16 CigiBaseMaritimeSurfaceCtrl::EntityRgnID [protected]

EntityRgnID
Entity or Region ID

Definition at line 301 of file CigiBaseMaritimeSurfaceCtrl.h.

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

ScopeGrp CigiBaseMaritimeSurfaceCtrl::Scope [protected]

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

Definition at line 323 of file CigiBaseMaritimeSurfaceCtrl.h.

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

bool CigiBaseMaritimeSurfaceCtrl::SurfaceCondEn [protected]

SurfaceCondEn
Sea Surface Conditions enable

Definition at line 307 of file CigiBaseMaritimeSurfaceCtrl.h.

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

float CigiBaseMaritimeSurfaceCtrl::SurfaceHeight [protected]

SurfaceHeight
Sea surface height

Definition at line 329 of file CigiBaseMaritimeSurfaceCtrl.h.

Referenced by CigiMaritimeSurfaceCtrlV3::CigiMaritimeSurfaceCtrlV3(), GetSurfaceHeight(), CigiMaritimeSurfaceCtrlV3::Pack(), SetSurfaceHeight(), and CigiMaritimeSurfaceCtrlV3::Unpack().

float CigiBaseMaritimeSurfaceCtrl::WaterTemp [protected]

WaterTemp
Sea surface water temperature

Definition at line 335 of file CigiBaseMaritimeSurfaceCtrl.h.

Referenced by CigiMaritimeSurfaceCtrlV3::CigiMaritimeSurfaceCtrlV3(), GetWaterTemp(), CigiMaritimeSurfaceCtrlV3::Pack(), SetWaterTemp(), and CigiMaritimeSurfaceCtrlV3::Unpack().

bool CigiBaseMaritimeSurfaceCtrl::WhitecapEn [protected]

WhitecapEn
Whitecaps enable

Definition at line 313 of file CigiBaseMaritimeSurfaceCtrl.h.

Referenced by CigiMaritimeSurfaceCtrlV3::CigiMaritimeSurfaceCtrlV3(), GetWhitecapEn(), CigiMaritimeSurfaceCtrlV3::Pack(), SetWhitecapEn(), and CigiMaritimeSurfaceCtrlV3::Unpack().

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

ccl/include/CigiBaseMaritimeSurfaceCtrl.h
ccl/source/CigiBaseMaritimeSurfaceCtrl.cpp

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

1.4.7

CigiBaseMaritimeSurfaceCtrl 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