ngcbPARAM_LIST Class Reference

#include <ngcbPARAM.hpp>

Public Member Functions
	ngcbPARAM_LIST ()
	Constructor.
	ngcbPARAM_LIST (ngcbPARAM *newParam, int noDelete)
	Constructor with initial parameter and no-delete flag.
virtual	~ngcbPARAM_LIST ()
	Destructor.
ngcbPARAM_LIST *	First ()
	Get list entry point.
ngcbPARAM *	Add (ngcbPARAM *newParam, int noDelete=1)
	Add external parameter object to list.
ngcbPARAM *	Add (const char *paramName)
	Add new parameter.
ngcbPARAM *	Add (const char *paramName, char initVal)
	Add new character parameter.
ngcbPARAM *	Add (const char *paramName, int initVal)
	Add new 32-bit integer parameter.
ngcbPARAM *	Add (const char *paramName, float initVal)
	Add new 32-bit floating point parameter.
ngcbPARAM *	Add (const char *paramName, double initVal)
	Add new 64-bit floating point parameter.
ngcbPARAM *	Add (const char *paramName, const char *initVal)
	Add new string parameter.
ngcbPARAM *	Add (const char *paramName, const char *initVal, int type)
	Add new parameter with string value and type.
void	Remove (ngcbPARAM *item)
	Remove parameter by object pointer.
void	Remove (const char *paramName)
	Remove parameter by name.
void	Clear ()
	Remove all parameters.
void	Insert (ngcbPARAM_LIST &other)
	Insert content from other list.
ngcbPARAM *	Get (const char *paramName)
	Get parameter object by name.
int	Set (const char *paramName, char paramValue)
	Set character value by name.
int	Set (const char *paramName, int paramValue)
	Set 32-bit integer value by name.
int	Set (const char *paramName, float paramValue)
	Set 32-bit floating point value by name.
int	Set (const char *paramName, double paramValue)
	Set 64-bit floating point value by name.
int	Set (const char *paramName, const char *paramValue)
	Set string value by name.
int	ValChar (const char *paramName, char *paramValue)
	Get character value by name.
int	ValInt (const char *paramName, int *paramValue)
	Get 32-bit integer value by name.
int	ValFloat (const char *paramName, float *paramValue)
	Get 32-bit floating point value by name.
int	ValDouble (const char *paramName, double *paramValue)
	Get 64-bit floating point value by name.
int	ValString (const char *paramName, char *paramValue)
	Get string value by name.
void	ClrAcqList (int instance)
	Detach acquisition module from parameter list.
void	ClrCtrlList (int instance)
	Detach controller module from parameter list.
int	Load (char **paramBuf, size_t size, char *erms)
	Load parameter list from string array.
int	Load (const char *paramBuf, char *erms)
	Load parameter list from string.
int	Load (const char *fileName, const char *mask, char *erms)
	Load parameter list from file.
void	Options (int argc, char *argv[])
	Load parameter list from command line options.
void	Print (FILE *s=NULL)
	Print parameter list to stream.
void	Print (char *s)
	Print parameter list to string.

Public Attributes
ngcbPARAM *	param
	Parameter in the list.
ngcbPARAM_LIST *	next
	Next list.

Detailed Description

Dynamic parameter list

Constructor & Destructor Documentation

ngcbPARAM_LIST() [1/2]

ngcbPARAM_LIST::ngcbPARAM_LIST

(

)

Constructor.

ngcbPARAM_LIST() [2/2]

ngcbPARAM_LIST::ngcbPARAM_LIST	(	ngcbPARAM *	newParam,
		int	noDelete )

Constructor with initial parameter and no-delete flag.

~ngcbPARAM_LIST()

ngcbPARAM_LIST::~ngcbPARAM_LIST ( )

virtual

Destructor.

Member Function Documentation

Add() [1/8]

ngcbPARAM * ngcbPARAM_LIST::Add

(

const char *

paramName

)

Add new parameter.

Add() [2/8]

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

Add new character parameter.

Add() [3/8]

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

Add new string parameter.

Add() [4/8]

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

Add new parameter with string value and type.

Add() [5/8]

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

Add new 64-bit floating point parameter.

Add() [6/8]

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

Add new 32-bit floating point parameter.

Add() [7/8]

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

Add new 32-bit integer parameter.

Add() [8/8]

ngcbPARAM * ngcbPARAM_LIST::Add	(	ngcbPARAM *	newParam,
		int	noDelete = 1 )

Add external parameter object to list.

Clear()

void ngcbPARAM_LIST::Clear

(

)

Remove all parameters.

ClrAcqList()

void ngcbPARAM_LIST::ClrAcqList

(

int

instance

)

Detach acquisition module from parameter list.

ClrCtrlList()

void ngcbPARAM_LIST::ClrCtrlList

(

int

instance

)

Detach controller module from parameter list.

First()

ngcbPARAM_LIST * ngcbPARAM_LIST::First

(

)

Get list entry point.

Get()

ngcbPARAM * ngcbPARAM_LIST::Get

(

const char *

paramName

)

Get parameter object by name.

Insert()

void ngcbPARAM_LIST::Insert

(

ngcbPARAM_LIST &

other

)

Insert content from other list.

Load() [1/3]

int ngcbPARAM_LIST::Load	(	char **	paramBuf,
		size_t	size,
		char *	erms )

Load parameter list from string array.

Load() [2/3]

int ngcbPARAM_LIST::Load	(	const char *	fileName,
		const char *	mask,
		char *	erms )

Load parameter list from file.

Load() [3/3]

int ngcbPARAM_LIST::Load	(	const char *	paramBuf,
		char *	erms )

Load parameter list from string.

Options()

void ngcbPARAM_LIST::Options	(	int	argc,
		char *	argv[] )

Load parameter list from command line options.

Print() [1/2]

void ngcbPARAM_LIST::Print

(

char *

s

)

Print parameter list to string.

Print() [2/2]

void ngcbPARAM_LIST::Print

(

FILE *

s = NULL

)

Print parameter list to stream.

Remove() [1/2]

void ngcbPARAM_LIST::Remove

(

const char *

paramName

)

Remove parameter by name.

Remove() [2/2]

void ngcbPARAM_LIST::Remove

(

ngcbPARAM *

item

)

Remove parameter by object pointer.

Set() [1/5]

int ngcbPARAM_LIST::Set	(	const char *	paramName,
		char	paramValue )

Set character value by name.

Set() [2/5]

int ngcbPARAM_LIST::Set	(	const char *	paramName,
		const char *	paramValue )

Set string value by name.

Set() [3/5]

int ngcbPARAM_LIST::Set	(	const char *	paramName,
		double	paramValue )

Set 64-bit floating point value by name.

Set() [4/5]

int ngcbPARAM_LIST::Set	(	const char *	paramName,
		float	paramValue )

Set 32-bit floating point value by name.

Set() [5/5]

int ngcbPARAM_LIST::Set	(	const char *	paramName,
		int	paramValue )

Set 32-bit integer value by name.

ValChar()

int ngcbPARAM_LIST::ValChar	(	const char *	paramName,
		char *	paramValue )

Get character value by name.

ValDouble()

int ngcbPARAM_LIST::ValDouble	(	const char *	paramName,
		double *	paramValue )

Get 64-bit floating point value by name.

ValFloat()

int ngcbPARAM_LIST::ValFloat	(	const char *	paramName,
		float *	paramValue )

Get 32-bit floating point value by name.

ValInt()

int ngcbPARAM_LIST::ValInt	(	const char *	paramName,
		int *	paramValue )

Get 32-bit integer value by name.

ValString()

int ngcbPARAM_LIST::ValString	(	const char *	paramName,
		char *	paramValue )

Get string value by name.

Member Data Documentation

next

ngcbPARAM_LIST* ngcbPARAM_LIST::next

Next list.

param

ngcbPARAM* ngcbPARAM_LIST::param

Parameter in the list.

---

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

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