CigiBaseMaritimeSurfaceResp Class Reference

#include <CigiBaseMaritimeSurfaceResp.h>

Inheritance diagram for CigiBaseMaritimeSurfaceResp:

CigiBasePacket CigiMaritimeSurfaceRespV3 List of all members.

Public Member Functions

 CigiBaseMaritimeSurfaceResp ()
virtual ~CigiBaseMaritimeSurfaceResp ()
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 SetRequestID (const Cigi_uint8 RequestIDIn, bool bndchk=true)
Cigi_uint8 GetRequestID (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_uint8 RequestID
float SurfaceHeight
float WaterTemp
float Clarity

Friends

class CigiMaritimeSurfaceRespV3

Detailed Description

Definition at line 68 of file CigiBaseMaritimeSurfaceResp.h.

Constructor & Destructor Documentation

CigiBaseMaritimeSurfaceResp::CigiBaseMaritimeSurfaceResp (  ) 

General Constructor

Definition at line 60 of file CigiBaseMaritimeSurfaceResp.cpp.

00061 {
00062 
00063 }

CigiBaseMaritimeSurfaceResp::~CigiBaseMaritimeSurfaceResp (  )  [virtual]

General Destructor

Definition at line 70 of file CigiBaseMaritimeSurfaceResp.cpp.

00071 {
00072 
00073 }

Member Function Documentation

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

Gets the Clarity value.

Returns:
the current Clarity.

Definition at line 211 of file CigiBaseMaritimeSurfaceResp.h.

References Clarity.

00211 { return(Clarity); }

int CigiBaseMaritimeSurfaceResp::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 CigiBaseMaritimeSurfaceResp.cpp.

References CIGI_MARITIME_SURFACE_RESP_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_RESP_PACKET_ID_V3;
00096    }
00097 
00098    return(CIGI_SUCCESS);
00099 }

Cigi_uint8 CigiBaseMaritimeSurfaceResp::GetRequestID ( void   )  const [inline]

Gets the RequestID value.

Returns:
the current RequestID.

Definition at line 152 of file CigiBaseMaritimeSurfaceResp.h.

References RequestID.

00152 { return(RequestID); }

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

Gets the SurfaceHeight value.

Returns:
the current SurfaceHeight.

Definition at line 173 of file CigiBaseMaritimeSurfaceResp.h.

References SurfaceHeight.

00173 { return(SurfaceHeight); }

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

Gets the WaterTemp value.

Returns:
the current WaterTemp.

Definition at line 194 of file CigiBaseMaritimeSurfaceResp.h.

References WaterTemp.

00194 { return(WaterTemp); }

virtual int CigiBaseMaritimeSurfaceResp::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 CigiMaritimeSurfaceRespV3.

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

Sets the Clarity with bound checking control

Parameters:
ClarityIn - 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 110 of file CigiBaseMaritimeSurfaceResp.cpp.

References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Clarity.

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

int CigiBaseMaritimeSurfaceResp::SetRequestID ( const Cigi_uint8  RequestIDIn,
bool  bndchk = true 
) [inline]

Sets the RequestID with bound checking control

Parameters:
RequestIDIn - Request 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 143 of file CigiBaseMaritimeSurfaceResp.h.

References CIGI_SUCCESS, and RequestID.

00144    {
00145       RequestID = RequestIDIn;
00146       return(CIGI_SUCCESS);
00147    }

int CigiBaseMaritimeSurfaceResp::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 164 of file CigiBaseMaritimeSurfaceResp.h.

References CIGI_SUCCESS, and SurfaceHeight.

00165    {
00166       SurfaceHeight = SurfaceHeightIn;
00167       return(CIGI_SUCCESS);
00168    }

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

Sets the WaterTemp with bound checking control

Parameters:
WaterTempIn - Surface Water Termperature
bndchk - Enables (true) or disables (false) bounds checking.
Returns:
This returns CIGI_SUCCESS or an error code defined in CigiErrorCodes.h

Definition at line 185 of file CigiBaseMaritimeSurfaceResp.h.

References CIGI_SUCCESS, and WaterTemp.

00186    {
00187       WaterTemp = WaterTempIn;
00188       return(CIGI_SUCCESS);
00189    }

virtual int CigiBaseMaritimeSurfaceResp::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 CigiMaritimeSurfaceRespV3.

Friends And Related Function Documentation

friend class CigiMaritimeSurfaceRespV3 [friend]

Definition at line 71 of file CigiBaseMaritimeSurfaceResp.h.

Member Data Documentation

float CigiBaseMaritimeSurfaceResp::Clarity [protected]

Clarity
Surface Clarity

Definition at line 241 of file CigiBaseMaritimeSurfaceResp.h.

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

Cigi_uint8 CigiBaseMaritimeSurfaceResp::RequestID [protected]

RequestID
Request ID

Definition at line 223 of file CigiBaseMaritimeSurfaceResp.h.

Referenced by CigiMaritimeSurfaceRespV3::CigiMaritimeSurfaceRespV3(), GetRequestID(), CigiMaritimeSurfaceRespV3::Pack(), SetRequestID(), and CigiMaritimeSurfaceRespV3::Unpack().

float CigiBaseMaritimeSurfaceResp::SurfaceHeight [protected]

SurfaceHeight
Sea Surface Height

Definition at line 229 of file CigiBaseMaritimeSurfaceResp.h.

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

float CigiBaseMaritimeSurfaceResp::WaterTemp [protected]

WaterTemp
Surface Water Termperature

Definition at line 235 of file CigiBaseMaritimeSurfaceResp.h.

Referenced by CigiMaritimeSurfaceRespV3::CigiMaritimeSurfaceRespV3(), GetWaterTemp(), CigiMaritimeSurfaceRespV3::Pack(), SetWaterTemp(), and CigiMaritimeSurfaceRespV3::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