ngcdcsTEC Class Reference

#include <ngcdcsTEC.hpp>

Inheritance diagram for ngcdcsTEC:

Public Member Functions
	ngcdcsTEC (const ngcb_route_t &r)
	Constructor with route.
	ngcdcsTEC (ngcbIFC *ifc, const ngcb_route_t &r)
	Constructor with interface device and route.
virtual	~ngcdcsTEC ()
	Destructor.
void	Reset ()
	Align software state after reset.
int	Enable (int check=1)
	Call-back at transition to operational state.
int	Disable ()
	Call-back at transition to not operational state.
int	Selftest ()
	Execute selftest.
void	ResetSeqNr ()
	Reset protocol sequence number.
void	CoolingState (int state)
	Set cooling state.
int	Info (ngcdcs_tec_info *info)
	Get device info.
int	SetTemp (double temp)
	Set target object temperature set point.
int	Action (const char *action, char *reply=NULL)
	Execute TEC action.
int	Update ()
	Run update cycle.
int	SetParam (int paramId, int value, int inst=1)
	Set parameter (32-bit integer)
int	SetParam (int paramId, double value, int inst=1)
	Set parameter (floating point)
int	GetParam (int paramId, int *value, int inst=1)
	Get parameter (32-bit integer)
int	GetParam (int paramId, double *value, int inst=1)
	Get parameter (floating point)
int	Command (const char *cmd, char *reply=NULL)
	Send frame buffer.
int	SetupKey (const char *key, const int *idx, const char *value, int *s=NULL)
	Setup.
int	StatusKey (const char *key, const int *idx, char *value, int *s=NULL)
	Status.
char *	StatusString ()
	Get status string.
void	Err2String (char *s, unsigned int errorNumber)
	Convert error number to error-string.
Public Member Functions inherited from ngcbMOD
ngcbMOD &	operator= (const ngcbMOD &other)
	Operator =.
	ngcbMOD (const ngcbMOD &other)
	Copy constructor.
	ngcbMOD (const ngcb_route_t &modRoute)
	Constructor with route.
	ngcbMOD (ngcbIFC *modDev, const ngcb_route_t &modRoute)
	Constructor with interface device and route.
virtual	~ngcbMOD ()
	Destructor.
ngcbIFC *	Dev ()
	Return current interface device.
void	Dev (ngcbIFC *newDev)
	Set new interface device.
int	Connected ()
	Return 1 if device is connected, zero otherwise.
int	Sim ()
int	Initialize ()
	Initialize module.
void	ErrState (const char *msg, int errorId=0)
	Go to error state.
virtual int	CkAddrCB (int addr, const int *buffer, int size)
	Check-address call-back for alignment.
virtual void	WrAddrCB (int addr, const int *buffer, int size)
	Write-to-address call-back for alignment.
virtual int	Load (const char *fileName)
	Load register instruction file.
int	Board ()
	Return the board number of the module (starts with zero)
void	RpcCopy (void *dest, const void *src, size_t size, size_t items=1)
	Copy RPC payload.
int	RPC (int target, int req, void *payload, unsigned int size, unsigned int *status=NULL)
	Execute RPC.
int	ReadAddr (int addr, int *buffer, int size)
	Read from address (32-bit)
int	WriteAddr (int addr, const int *buffer, int size)
	Write to address (32-bit)
int	ReadAddr64 (int addr, uint64_t *buffer, int size)
	Read from address (64-bit)
int	WriteAddr64 (int addr, const uint64_t *buffer, int size)
	Write to address (64-bit)
int	Temperature (double *t)
	Read board temperature (degree C)
int	BackPlane ()
	Return back-plane ID.
virtual void	CV (int chan, double volt)
	Voltage conversion call-back.
Public Member Functions inherited from ngcbOBJ
	ngcbOBJ ()
	Constructor.
virtual	~ngcbOBJ ()
	Destructor.
void	Instance (int n)
	Set instance.
int	Instance ()
	Get instance.
const char *	Major ()
	Instance major number.
int	BigEndian ()
	Big-endian architecture.
int	LittleEndian ()
	Little-endian architecture.
virtual char *	ErrMsg ()
	Error message.
virtual int	Success ()
	Return success.
virtual int	Failure ()
	Return failure.
void	CfgPath (const char *path)
	Set external configuration path.

Public Attributes
ngcdcs_tec_stat	status
	TEC status.
double	tempSetPoint
	Target object temperature set point.
double	coldTemp
	Target object pre-defined cold temperature.
double	warmTemp
	Target object pre-defined warm temperature.
int	autoCooldown
	Automatic cooldown at ONLINE.
int	coolingState
	Cooling state.
Public Attributes inherited from ngcbMOD
ngcbIFC *	dev
	Interface device.
ngcb_route_t	route
	Local route to module (header)
char	moduleName [64]
	Module name.
int	id
	ID-register content.
int	productCode
	Product code.
int	revision
	HW revision number.
int	firmware
	Firmware revision.
int	boardId
	Physical board id.
int	fitsHdr
	Enable FITS-header for this module.
Public Attributes inherited from ngcbOBJ
FILE *	watchdog
	Watchdog stream.
ngcbALARM_SYS *	alarmSystem
	Alarm system.
ngcbSERVICE *	services
	System services.
int	verboseLevel
	Verbose level.
int	logLevel
	Logging level.
int	xterm
	Xterm flag.
int	debugPort
	Debug port.
int	ignoreErr
	Ignore next error (do not log)
int	type
	Object type.

Additional Inherited Members
Protected Member Functions inherited from ngcbOBJ
virtual int	BailOut (const char *pos)
	Log code position of the error and bail-out with failure.
virtual void	Verbose (int level, const char *format,...) __attribute__((format(printf
	Verbose message if verbose level exceeds level.
virtual void virtual void	Verbose (const char *format,...) __attribute__((format(printf
	Verbose message.
virtual void virtual void virtual void	Log (int level, const char *format,...) __attribute__((format(printf
	Log message if logging level exceeds level.
virtual void virtual void virtual void virtual void	Log (const char *format,...) __attribute__((format(printf
	Log message.
virtual void virtual void virtual void virtual void virtual void	ErrLog (int severity, const char *format,...) __attribute__((format(printf
	Error log, severity is one of ngcbWARNING, ngcbFAILURE and ngcbERR_SEVERE.
virtual void virtual void virtual void virtual void virtual void void	FeedBack (const char *format,...) __attribute__((format(printf
	Feed-back function.
virtual void virtual void virtual void virtual void virtual void void virtual void	SendFeedBack (const char *msg)
	Feed-back sender implementation.
const char *	CfgPath ()
	Get external configuration path.
int	CfgPath (char *path, const char *cfgFile)
	Compose path for configuratuion file.
int	KeyVal (const char *key, float *value)
	Get single precision floating point value from keyword string.
int	KeyVal (const char *key, double *value)
	Get double precision floating point value from keyword string.
int	KeyVal (const char *key, int *value)
	Get 32-bit signed integer value from decimal keyword string.
int	KeyVal (const char *key, unsigned int *value)
	Get 32-bit unsigned integer value from decimal keyword string.
int	KeyValHex (const char *key, int *value)
	Get 32-bit signed integer value from hexadecimal keyword string.
int	KeyValHex (const char *key, unsigned int *value)
	Get 32-bit unsigned integer value from hexadecimal keyword string.
int	KeyValFmt (const char *key, int *value)
	Get 32-bit signed integer value from string.
int	KeyValFmt (const char *key, unsigned int *value)
	Get 32-bit unsigned integer value from string.
int	KeyValFrac (const char *key, unsigned int n, uint64_t *v1, uint64_t *v2)
	Fraction after n digits.
void	CleanupCmd (char *cmdLine, int *cmdLen)
	Clean command string (remove extra spaces etc.)
int	ReplaceParam (char *string)
	Replace parameter in string.

Detailed Description

NGC temperature electronic control module class

Constructor & Destructor Documentation

ngcdcsTEC() [1/2]

ngcdcsTEC::ngcdcsTEC ( const ngcb_route_t & r )

explicit

Constructor with route.

ngcdcsTEC() [2/2]

ngcdcsTEC::ngcdcsTEC	(	ngcbIFC *	ifc,
		const ngcb_route_t &	r )

Constructor with interface device and route.

~ngcdcsTEC()

ngcdcsTEC::~ngcdcsTEC ( )

virtual

Destructor.

Member Function Documentation

Action()

int ngcdcsTEC::Action	(	const char *	action,
		char *	reply = NULL )

Execute TEC action.

Command()

int ngcdcsTEC::Command	(	const char *	cmd,
		char *	reply = NULL )

Send frame buffer.

CoolingState()

void ngcdcsTEC::CoolingState

(

int

state

)

Set cooling state.

Disable()

int ngcdcsTEC::Disable ( )

virtual

Call-back at transition to not operational state.

Reimplemented from ngcbMOD.

Enable()

int ngcdcsTEC::Enable ( int check = 1 )

virtual

Call-back at transition to operational state.

Reimplemented from ngcbMOD.

Err2String()

void ngcdcsTEC::Err2String	(	char *	s,
		unsigned int	errorNumber )

Convert error number to error-string.

GetParam() [1/2]

int ngcdcsTEC::GetParam	(	int	paramId,
		double *	value,
		int	inst = 1 )

Get parameter (floating point)

GetParam() [2/2]

int ngcdcsTEC::GetParam	(	int	paramId,
		int *	value,
		int	inst = 1 )

Get parameter (32-bit integer)

Info()

int ngcdcsTEC::Info

(

ngcdcs_tec_info *

info

)

Get device info.

Reset()

void ngcdcsTEC::Reset ( )

virtual

Align software state after reset.

Reimplemented from ngcbMOD.

ResetSeqNr()

void ngcdcsTEC::ResetSeqNr

(

)

Reset protocol sequence number.

Selftest()

int ngcdcsTEC::Selftest

(

)

Execute selftest.

SetParam() [1/2]

int ngcdcsTEC::SetParam	(	int	paramId,
		double	value,
		int	inst = 1 )

Set parameter (floating point)

SetParam() [2/2]

int ngcdcsTEC::SetParam	(	int	paramId,
		int	value,
		int	inst = 1 )

Set parameter (32-bit integer)

SetTemp()

int ngcdcsTEC::SetTemp

(

double

temp

)

Set target object temperature set point.

SetupKey()

int ngcdcsTEC::SetupKey	(	const char *	key,
		const int *	idx,
		const char *	value,
		int *	s = NULL )

Setup.

StatusKey()

int ngcdcsTEC::StatusKey	(	const char *	key,
		const int *	idx,
		char *	value,
		int *	s = NULL )

Status.

StatusString()

char * ngcdcsTEC::StatusString

(

)

Get status string.

Update()

int ngcdcsTEC::Update

(

)

Run update cycle.

Member Data Documentation

autoCooldown

int ngcdcsTEC::autoCooldown

Automatic cooldown at ONLINE.

coldTemp

double ngcdcsTEC::coldTemp

Target object pre-defined cold temperature.

coolingState

int ngcdcsTEC::coolingState

Cooling state.

status

ngcdcs_tec_stat ngcdcsTEC::status

TEC status.

tempSetPoint

double ngcdcsTEC::tempSetPoint

Target object temperature set point.

warmTemp

double ngcdcsTEC::warmTemp

Target object pre-defined warm temperature.

---

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

• core/ngcdcs/src/include/ngc/core/ngcdcsTEC.hpp
• core/ngcdcs/src/ngcdcsTEC.cpp
• core/ngcdcs/src/ngcdcsTecSetup.cpp
• core/ngcdcs/src/ngcdcsTecStatus.cpp