Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

SysTempCalc Class Reference

#include <sys_temp_calc.h>

List of all members.


Detailed Description

Specialised class for calculating receiver system temperature.

Author:
Simon Hoyle
Date:
Oct 2005
Version:
1.0

Definition at line 21 of file sys_temp_calc.h.

Public Types

enum  {
  E_NONE = 0, E_SDO_READ = -1, E_GTP_READ = -2, E_WFACT_READ = -3,
  E_LO_SDO = -4, E_NO_WF = -5, E_END = -6
}
 Enum constants for return error codes.

Public Member Functions

const char * get (float &f)
 Calculates system temperature using existing values.
const char * getErrMsg (int code)
 Converts a SysTempCalc error code to a message string.
int read (float &f)
 Reads MonitorPoints and calculates the system temperature.
 SysTempCalc (MonitorPoint *gtpPt, MonitorPoint *sdoPt, MonitorPoint *wfActPt, float Tcal)
 Constructor.


Constructor & Destructor Documentation

SysTempCalc::SysTempCalc MonitorPoint gtpPt,
MonitorPoint sdoPt,
MonitorPoint wfActPt,
float  Tcal
[inline]
 

Constructor.

Parameters:
gtpPt Gated Total Power MonitorPoint.
sdoPt Sync Demod Output MonitorPoint.
wfActPt Waveform Activity MonitorPoint.
Tcal Cal temperature value.

Definition at line 32 of file sys_temp_calc.h.


Member Function Documentation

const char * SysTempCalc::get float &  f  )  [inline]
 

Calculates system temperature using existing values.

Parameters:
f Output parameter for system temperature value.
Returns:
Formatted string for system temperature value.

Definition at line 90 of file sys_temp_calc.h.

References MonitorPoint::getFval(), MonitorPoint::getIval(), and MonitorPoint::getStatus().

const char * SysTempCalc::getErrMsg int  code  )  [inline]
 

Converts a SysTempCalc error code to a message string.

Parameters:
code One of the SysTempCalc error codes below.
Returns:
A message string describing the error.

Definition at line 132 of file sys_temp_calc.h.

int SysTempCalc::read float &  f  )  [inline]
 

Reads MonitorPoints and calculates the system temperature.

Parameters:
f Output parameter for system temperature value.
Returns:
Zero for success or one of the error codes below.

Definition at line 111 of file sys_temp_calc.h.

References MonitorPoint::read().


The documentation for this class was generated from the following file:
Generated on Mon Apr 30 13:32:47 2007 for Parkes M & C - PKMC C++ library API by  doxygen 1.4.4