ngcbOBJ Class Reference

#include <ngcbOBJ.hpp>

Inheritance diagram for ngcbOBJ:

Public Member Functions
	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
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.

Protected Member Functions
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 object class

Constructor & Destructor Documentation

ngcbOBJ()

ngcbOBJ::ngcbOBJ

(

)

Constructor.

~ngcbOBJ()

ngcbOBJ::~ngcbOBJ ( )

virtual

Destructor.

Member Function Documentation

BailOut()

int ngcbOBJ::BailOut ( const char * pos )

protectedvirtual

Log code position of the error and bail-out with failure.

BigEndian()

int ngcbOBJ::BigEndian

(

)

Big-endian architecture.

CfgPath() [1/3]

const char * ngcbOBJ::CfgPath ( )

protected

Get external configuration path.

CfgPath() [2/3]

int ngcbOBJ::CfgPath ( char * path, const char * cfgFile )

protected

Compose path for configuratuion file.

CfgPath() [3/3]

void ngcbOBJ::CfgPath

(

const char *

path

)

Set external configuration path.

CleanupCmd()

void ngcbOBJ::CleanupCmd ( char * cmdLine, int * cmdLen )

protected

Clean command string (remove extra spaces etc.)

ErrLog()

void ngcbOBJ::ErrLog ( int severity, const char * format, ... )

protectedvirtual

Error log, severity is one of ngcbWARNING, ngcbFAILURE and ngcbERR_SEVERE.

ErrMsg()

char * ngcbOBJ::ErrMsg ( )

virtual

Error message.

Reimplemented in ngcdcsACQ.

Failure()

int ngcbOBJ::Failure ( )

virtual

Return failure.

FeedBack()

void ngcbOBJ::FeedBack ( const char * format, ... )

protected

Feed-back function.

Instance() [1/2]

int ngcbOBJ::Instance

(

)

Get instance.

Instance() [2/2]

void ngcbOBJ::Instance

(

int

n

)

Set instance.

KeyVal() [1/4]

int ngcbOBJ::KeyVal ( const char * key, double * value )

protected

Get double precision floating point value from keyword string.

KeyVal() [2/4]

int ngcbOBJ::KeyVal ( const char * key, float * value )

protected

Get single precision floating point value from keyword string.

KeyVal() [3/4]

int ngcbOBJ::KeyVal ( const char * key, int * value )

protected

Get 32-bit signed integer value from decimal keyword string.

KeyVal() [4/4]

int ngcbOBJ::KeyVal ( const char * key, unsigned int * value )

protected

Get 32-bit unsigned integer value from decimal keyword string.

KeyValFmt() [1/2]

int ngcbOBJ::KeyValFmt ( const char * key, int * value )

protected

Get 32-bit signed integer value from string.

KeyValFmt() [2/2]

int ngcbOBJ::KeyValFmt ( const char * key, unsigned int * value )

protected

Get 32-bit unsigned integer value from string.

KeyValFrac()

int ngcbOBJ::KeyValFrac ( const char * key, unsigned int n, uint64_t * v1, uint64_t * v2 )

protected

Fraction after n digits.

KeyValHex() [1/2]

int ngcbOBJ::KeyValHex ( const char * key, int * value )

protected

Get 32-bit signed integer value from hexadecimal keyword string.

KeyValHex() [2/2]

int ngcbOBJ::KeyValHex ( const char * key, unsigned int * value )

protected

Get 32-bit unsigned integer value from hexadecimal keyword string.

LittleEndian()

int ngcbOBJ::LittleEndian

(

)

Little-endian architecture.

Log() [1/2]

void ngcbOBJ::Log ( const char * format, ... )

protectedvirtual

Log message.

Log() [2/2]

void ngcbOBJ::Log ( int level, const char * format, ... )

protectedvirtual

Log message if logging level exceeds level.

Major()

const char * ngcbOBJ::Major

(

)

Instance major number.

ReplaceParam()

int ngcbOBJ::ReplaceParam ( char * string )

protected

Replace parameter in string.

SendFeedBack()

void ngcbOBJ::SendFeedBack ( const char * msg )

protectedvirtual

Feed-back sender implementation.

Reimplemented in ngcdcsEXPDRV.

Success()

int ngcbOBJ::Success ( )

virtual

Return success.

Verbose() [1/2]

void ngcbOBJ::Verbose ( const char * format, ... )

protectedvirtual

Verbose message.

Verbose() [2/2]

void ngcbOBJ::Verbose ( int level, const char * format, ... )

protectedvirtual

Verbose message if verbose level exceeds level.

Member Data Documentation

alarmSystem

ngcbALARM_SYS* ngcbOBJ::alarmSystem

Alarm system.

debugPort

int ngcbOBJ::debugPort

Debug port.

ignoreErr

int ngcbOBJ::ignoreErr

Ignore next error (do not log)

logLevel

int ngcbOBJ::logLevel

Logging level.

services

ngcbSERVICE* ngcbOBJ::services

System services.

type

int ngcbOBJ::type

Object type.

verboseLevel

int ngcbOBJ::verboseLevel

Verbose level.

watchdog

FILE* ngcbOBJ::watchdog

Watchdog stream.

xterm

int ngcbOBJ::xterm

Xterm flag.

---

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

• core/ngcbCORE/src/include/ngc/core/ngcbOBJ.hpp
• core/ngcbCORE/src/ngcbOBJ.cpp