CigiBaseAerosolResp Class Reference

#include <CigiBaseAerosolResp.h>

Inheritance diagram for CigiBaseAerosolResp:


Public Member Functions
	CigiBaseAerosolResp ()
virtual	~CigiBaseAerosolResp ()
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	SetLayerID (const Cigi_uint8 LayerIDIn, bool bndchk=true)
Cigi_uint8	GetLayerID (void) const
int	SetAerosolConcentration (const float AerosolConcentrationIn, bool bndchk=true)
float	GetAerosolConcentration (void) const
Protected Attributes
Cigi_uint8	RequestID
Cigi_uint8	LayerID
float	AerosolConcentration
Friends
class	CigiAerosolRespV3

Detailed Description

Definition at line 69 of file CigiBaseAerosolResp.h.

Constructor & Destructor Documentation

CigiBaseAerosolResp::CigiBaseAerosolResp ( )

General Constructor

Definition at line 60 of file CigiBaseAerosolResp.cpp.

00061 {
00062 
00063 }

CigiBaseAerosolResp::~CigiBaseAerosolResp ( ) [virtual]

General Destructor

Definition at line 70 of file CigiBaseAerosolResp.cpp.

00071 {
00072 
00073 }

Member Function Documentation

float CigiBaseAerosolResp::GetAerosolConcentration ( void ) const [inline]

Gets the AerosolConcentration value.

Returns:: the current AerosolConcentration.

Definition at line 191 of file CigiBaseAerosolResp.h.

References AerosolConcentration.

00191 { return(AerosolConcentration); }

int CigiBaseAerosolResp::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 83 of file CigiBaseAerosolResp.cpp.

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

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

Cigi_uint8 CigiBaseAerosolResp::GetLayerID ( void ) const [inline]

Gets the LayerID value.

Returns:: the current LayerID.

Definition at line 174 of file CigiBaseAerosolResp.h.

References LayerID.

00174 { return(LayerID); }

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

Gets the RequestID value.

Returns:: the current RequestID.

Definition at line 153 of file CigiBaseAerosolResp.h.

References RequestID.

00153 { return(RequestID); }

virtual int CigiBaseAerosolResp::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 CigiAerosolRespV3.

int CigiBaseAerosolResp::SetAerosolConcentration	(	const float	AerosolConcentrationIn,
		bool	bndchk = `true`
	)

Sets the AerosolConcentration with bound checking control

Parameters:

	AerosolConcentrationIn	- Aerosol Concentration
	bndchk	- Enables (true) or disables (false) bounds checking.

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

Definition at line 108 of file CigiBaseAerosolResp.cpp.

References AerosolConcentration, CIGI_ERROR_VALUE_OUT_OF_RANGE, and CIGI_SUCCESS.

00109 {
00110 
00111 #ifndef CIGI_NO_BND_CHK
00112    if(bndchk && (AerosolConcentrationIn < 0.0))
00113    {
00114 #ifndef CIGI_NO_EXCEPT
00115       throw CigiValueOutOfRangeException("AerosolConcentration",(float)AerosolConcentrationIn,">",0.0);
00116 #endif
00117       return(CIGI_ERROR_VALUE_OUT_OF_RANGE);
00118    }
00119 #endif
00120 
00121    AerosolConcentration = AerosolConcentrationIn;
00122    return(CIGI_SUCCESS);
00123 
00124 }

int CigiBaseAerosolResp::SetLayerID	(	const Cigi_uint8	LayerIDIn,
		bool	bndchk = `true`
	)			`[inline]`

Sets the LayerID with bound checking control

Parameters:

	LayerIDIn	- Layer 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 165 of file CigiBaseAerosolResp.h.

References CIGI_SUCCESS, and LayerID.

00166    {
00167       LayerID = LayerIDIn;
00168       return(CIGI_SUCCESS);
00169    }

int CigiBaseAerosolResp::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 144 of file CigiBaseAerosolResp.h.

References CIGI_SUCCESS, and RequestID.

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

virtual int CigiBaseAerosolResp::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 CigiAerosolRespV3.

Friends And Related Function Documentation

friend class CigiAerosolRespV3 [friend]

Definition at line 72 of file CigiBaseAerosolResp.h.

Member Data Documentation

float CigiBaseAerosolResp::AerosolConcentration [protected]

AerosolConcentration

Definition at line 214 of file CigiBaseAerosolResp.h.

Referenced by CigiAerosolRespV3::CigiAerosolRespV3(), GetAerosolConcentration(), CigiAerosolRespV3::Pack(), SetAerosolConcentration(), and CigiAerosolRespV3::Unpack().

Cigi_uint8 CigiBaseAerosolResp::LayerID [protected]

LayerID
Layer ID

Definition at line 209 of file CigiBaseAerosolResp.h.

Referenced by CigiAerosolRespV3::CigiAerosolRespV3(), GetLayerID(), CigiAerosolRespV3::Pack(), SetLayerID(), and CigiAerosolRespV3::Unpack().

Cigi_uint8 CigiBaseAerosolResp::RequestID [protected]

RequestID
Request ID

Definition at line 203 of file CigiBaseAerosolResp.h.

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

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

ccl/include/CigiBaseAerosolResp.h
ccl/source/CigiBaseAerosolResp.cpp

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

1.4.7

CigiBaseAerosolResp Class Reference

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation