#include <ngcbPARAM.hpp>

Public Member Functions
bool	operator== (const ngcbPARAM &other) const
	Comparison operator ==.

bool	operator!= (const ngcbPARAM &other) const
	Comparison operator !=.

ngcbPARAM &	operator= (const ngcbPARAM &other)
	Operator =.

	ngcbPARAM (const ngcbPARAM &other)
	Copy constructor.

	ngcbPARAM ()
	Constructors for basic container.

	ngcbPARAM (const char *paramName)
	Constructor for asic container with parameter name.

	ngcbPARAM (const char *paramName, char initVal)
	Constructor for logical parameter ('T' or 'F' or 0 or 1)

	ngcbPARAM (const char *paramName, int initVal)
	Constructor for 32-bit signed integer parameter.

	ngcbPARAM (const char *paramName, float initVal)
	Constructor for 32-bit floating point parameter.

	ngcbPARAM (const char *paramName, double initVal)
	Constructor for 64-bit floating point parameter.

	ngcbPARAM (const char paramName, const char initVal)
	Constructor for string parameter.

	ngcbPARAM (const char paramName, const char initVal, int type)
	Constructor for free paramter with string value and assigned type.

virtual	~ngcbPARAM ()
	Destructor.

int	Comp (ngcbPARAM &p)
	Compare parameter values.

int	Changed ()
	Check for change since last call.

void	Alias (const char *a)
	Set alias name.

int	Type ()
	Get parameter type.

void	Type (int newType)
	Set parameter type.

int	Set (char newValue)
	Set parameter value converted to character format.

int	Set (int newValue)
	Set parameter value converted to 32-bit integer format.

int	Set (float newValue)
	Set parameter value converted to 32-bit float format.

int	Set (double newValue)
	Set parameter value converted to 64-bit float format.

int	Set (const char *newValue)
	Set parameter value converted to string format.

char	ValChar () const
	Get parameter value converted to character format.

int	ValInt () const
	Get parameter value converted to 32-bit integer format.

float	ValFloat () const
	Get parameter value converted to 32-bit floating point format.

double	ValDouble () const
	Get parameter value converted to 64-bit floating point format.

const char *	ValString ()
	Get parameter value converted to string format.

const char *	Get ()
	Get parameter value converted to string format.

void	Get (char *stringVal) const
	Get parameter value converted to string format (copy to argument)

void	Store ()
	Store to temporary buffer.

void	Restore ()
	Restore from temporary buffer.

Public Attributes
unsigned int	ctrlList
	List of controller modules where parameter is used.

unsigned int	acqList
	List of acquisition processes where parameter is used.

char	name [64]
	Parameter name.

char	alias [64]
	Parameter alias name.

char	format [16]
	Parameter format for printf etc.

int	fits
	Flag to put paramter into FITS-header.

char	comment [44]
	Optional parameter comment for FITS-header.

char	unit [8]
	Optional parameter unit.

int	attribute
	Storage space for application specific attributes.

Detailed Description

Parameter class

Constructor & Destructor Documentation

◆ ngcbPARAM() [1/9]

ngcbPARAM::ngcbPARAM ( const ngcbPARAM & other )

Copy constructor.

◆ ngcbPARAM() [2/9]

ngcbPARAM::ngcbPARAM ( )

Constructors for basic container.

◆ ngcbPARAM() [3/9]

ngcbPARAM::ngcbPARAM ( const char * paramName )

explicit

Constructor for asic container with parameter name.

◆ ngcbPARAM() [4/9]

ngcbPARAM::ngcbPARAM	(	const char *	paramName,
		char	initVal )

Constructor for logical parameter ('T' or 'F' or 0 or 1)

◆ ngcbPARAM() [5/9]

ngcbPARAM::ngcbPARAM	(	const char *	paramName,
		int	initVal )

Constructor for 32-bit signed integer parameter.

◆ ngcbPARAM() [6/9]

ngcbPARAM::ngcbPARAM	(	const char *	paramName,
		float	initVal )

Constructor for 32-bit floating point parameter.

◆ ngcbPARAM() [7/9]

ngcbPARAM::ngcbPARAM	(	const char *	paramName,
		double	initVal )

Constructor for 64-bit floating point parameter.

◆ ngcbPARAM() [8/9]

ngcbPARAM::ngcbPARAM	(	const char *	paramName,
		const char *	initVal )

Constructor for string parameter.

◆ ngcbPARAM() [9/9]

ngcbPARAM::ngcbPARAM	(	const char *	paramName,
		const char *	initVal,
		int	type )

Constructor for free paramter with string value and assigned type.

◆ ~ngcbPARAM()

ngcbPARAM::~ngcbPARAM ( )

virtual

Destructor.

Member Function Documentation

◆ Alias()

void ngcbPARAM::Alias ( const char * a )

Set alias name.

◆ Changed()

int ngcbPARAM::Changed ( )

Check for change since last call.

◆ Comp()

int ngcbPARAM::Comp ( ngcbPARAM & p )

Compare parameter values.

◆ Get() [1/2]

const char * ngcbPARAM::Get ( )

Get parameter value converted to string format.

◆ Get() [2/2]

void ngcbPARAM::Get ( char * stringVal ) const

Get parameter value converted to string format (copy to argument)

◆ operator!=()

bool ngcbPARAM::operator!= ( const ngcbPARAM & other ) const

Comparison operator !=.

◆ operator=()

ngcbPARAM & ngcbPARAM::operator= ( const ngcbPARAM & other )

Operator =.

◆ operator==()

bool ngcbPARAM::operator== ( const ngcbPARAM & other ) const

Comparison operator ==.

◆ Restore()

void ngcbPARAM::Restore ( )

Restore from temporary buffer.

◆ Set() [1/5]

int ngcbPARAM::Set ( char newValue )

Set parameter value converted to character format.

◆ Set() [2/5]

int ngcbPARAM::Set ( const char * newValue )

Set parameter value converted to string format.

◆ Set() [3/5]

int ngcbPARAM::Set ( double newValue )

Set parameter value converted to 64-bit float format.

◆ Set() [4/5]

int ngcbPARAM::Set ( float newValue )

Set parameter value converted to 32-bit float format.

◆ Set() [5/5]

int ngcbPARAM::Set ( int newValue )

Set parameter value converted to 32-bit integer format.

◆ Store()

void ngcbPARAM::Store ( )

Store to temporary buffer.

◆ Type() [1/2]

int ngcbPARAM::Type ( )

Get parameter type.

◆ Type() [2/2]

void ngcbPARAM::Type ( int newType )

Set parameter type.

◆ ValChar()

char ngcbPARAM::ValChar ( ) const

Get parameter value converted to character format.

◆ ValDouble()

double ngcbPARAM::ValDouble ( ) const

Get parameter value converted to 64-bit floating point format.

◆ ValFloat()

float ngcbPARAM::ValFloat ( ) const

Get parameter value converted to 32-bit floating point format.

◆ ValInt()

int ngcbPARAM::ValInt ( ) const

Get parameter value converted to 32-bit integer format.

◆ ValString()

const char * ngcbPARAM::ValString ( )

Get parameter value converted to string format.

Member Data Documentation

◆ acqList

unsigned int ngcbPARAM::acqList

List of acquisition processes where parameter is used.

◆ alias

char ngcbPARAM::alias[64]

Parameter alias name.

◆ attribute

int ngcbPARAM::attribute

Storage space for application specific attributes.

◆ comment

char ngcbPARAM::comment[44]

Optional parameter comment for FITS-header.

◆ ctrlList

unsigned int ngcbPARAM::ctrlList

List of controller modules where parameter is used.

◆ fits

int ngcbPARAM::fits

Flag to put paramter into FITS-header.

◆ format

char ngcbPARAM::format[16]

Parameter format for printf etc.

◆ name

char ngcbPARAM::name[64]

Parameter name.

◆ unit

char ngcbPARAM::unit[8]

Optional parameter unit.

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

core/ngcbCORE/src/include/ngc/core/ngcbPARAM.hpp
core/ngcbCORE/src/ngcbPARAM.cpp

Public Member Functions

Public Attributes