ngcbDIC Class Reference

#include <ngcbDIC.hpp>

Public Member Functions
	ngcbDIC ()
	Constructor.
	ngcbDIC (const char *name)
	Constructor with dictionary name.
	ngcbDIC (const char *name, char *buffer)
	Constructor with dictionary name and parameter description buffer.
virtual	~ngcbDIC ()
	Destructor.
int	Initialized ()
	Return initialization flag.
char *	ErrMsg ()
	Return a pointer to the global error message buffer.
void	AttachBuffer (char *buffer)
	Attach a parameter description buffer.
int	Load (const char *name)
	Load a new dictionary.
void	Clear ()
	Clear dictionary.
int	Loaded ()
	Check if a valid set of parameters is loaded.
ngcbPARAM_LIST *	ParamList ()
	Parameter list.
ngcbPARAM *	Lookup (const char *name)
	Parameter lookup function.
char *	Info (const char *paramName, int width=0)
	Lookup parameter and return the formatted parameter description.
char *	DescrBuf ()
	Return parameter description buffer.

Public Attributes
int	numDic
	Number of dictionaries loaded.
ngcb_dicrev_t	rev [ngcbMAX_DIC]
	Checked-in dictionary names & versions.

Detailed Description

General dictionary container class

Constructor & Destructor Documentation

ngcbDIC() [1/3]

ngcbDIC::ngcbDIC

(

)

Constructor.

ngcbDIC() [2/3]

ngcbDIC::ngcbDIC ( const char * name )

explicit

Constructor with dictionary name.

ngcbDIC() [3/3]

ngcbDIC::ngcbDIC	(	const char *	name,
		char *	buffer )

Constructor with dictionary name and parameter description buffer.

~ngcbDIC()

ngcbDIC::~ngcbDIC ( )

virtual

Destructor.

Member Function Documentation

AttachBuffer()

void ngcbDIC::AttachBuffer

(

char *

buffer

)

Attach a parameter description buffer.

Clear()

void ngcbDIC::Clear

(

)

Clear dictionary.

DescrBuf()

char * ngcbDIC::DescrBuf

(

)

Return parameter description buffer.

ErrMsg()

char * ngcbDIC::ErrMsg

(

)

Return a pointer to the global error message buffer.

Info()

char * ngcbDIC::Info	(	const char *	paramName,
		int	width = 0 )

Lookup parameter and return the formatted parameter description.

Initialized()

int ngcbDIC::Initialized

(

)

Return initialization flag.

Load()

int ngcbDIC::Load

(

const char *

name

)

Load a new dictionary.

Loaded()

int ngcbDIC::Loaded

(

)

Check if a valid set of parameters is loaded.

Lookup()

ngcbPARAM * ngcbDIC::Lookup

(

const char *

name

)

Parameter lookup function.

ParamList()

ngcbPARAM_LIST * ngcbDIC::ParamList

(

)

Parameter list.

Member Data Documentation

numDic

int ngcbDIC::numDic

Number of dictionaries loaded.

rev

ngcb_dicrev_t ngcbDIC::rev[ngcbMAX_DIC]

Checked-in dictionary names & versions.

---

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

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