ngcbALARM Class Reference

#include <ngcbALARM.hpp>

Public Member Functions
ngcbALARM &	operator= (const ngcbALARM &other)
	Operator =.
	ngcbALARM (const ngcbALARM &other)
	Copy constructor.
	ngcbALARM ()
	Constructor.
	ngcbALARM (ngcbALARM_SYS *sys, const char *name, int level, const char *msg)
	Constructor for logical alarm.
	ngcbALARM (ngcbALARM_SYS *sys, const char *name, int level, const char *msg, int value, const char *unit=NULL)
	Constructor for alarm with integer value.
	ngcbALARM (ngcbALARM_SYS *sys, const char *name, int level, const char *msg, double value, const char *unit=NULL)
	Constructor for alarm with double precision floating point value.
virtual	~ngcbALARM ()
	Destructor.
ngcb_alarm_id	Id ()
	Return alarm id.
const char *	Name ()
	Return alarm name.
int	Level ()
	Return actual alarm severity level.
const char *	Msg ()
	Return alarm message.
const char *	Format ()
	Return format string to be used for printf-style formatted output.
const char *	Unit ()
	Return the unit of the alarm value.
const char *	Value (int showUnit)
	Return formatted value string.
int	AckPending ()
	Check if alarm has acknowledge pending.
void	Ack ()
	Acknowledge alarm.

Detailed Description

Alarm class

Constructor & Destructor Documentation

ngcbALARM() [1/5]

ngcbALARM::ngcbALARM

(

const ngcbALARM &

other

)

Copy constructor.

ngcbALARM() [2/5]

ngcbALARM::ngcbALARM

(

)

Constructor.

ngcbALARM() [3/5]

ngcbALARM::ngcbALARM	(	ngcbALARM_SYS *	sys,
		const char *	name,
		int	level,
		const char *	msg )

Constructor for logical alarm.

ngcbALARM() [4/5]

ngcbALARM::ngcbALARM	(	ngcbALARM_SYS *	sys,
		const char *	name,
		int	level,
		const char *	msg,
		int	value,
		const char *	unit = NULL )

Constructor for alarm with integer value.

ngcbALARM() [5/5]

ngcbALARM::ngcbALARM	(	ngcbALARM_SYS *	sys,
		const char *	name,
		int	level,
		const char *	msg,
		double	value,
		const char *	unit = NULL )

Constructor for alarm with double precision floating point value.

~ngcbALARM()

ngcbALARM::~ngcbALARM ( )

virtual

Destructor.

Member Function Documentation

Ack()

void ngcbALARM::Ack

(

)

Acknowledge alarm.

AckPending()

int ngcbALARM::AckPending

(

)

Check if alarm has acknowledge pending.

Format()

const char * ngcbALARM::Format

(

)

Return format string to be used for printf-style formatted output.

Id()

ngcb_alarm_id ngcbALARM::Id

(

)

Return alarm id.

Level()

int ngcbALARM::Level

(

)

Return actual alarm severity level.

Msg()

const char * ngcbALARM::Msg

(

)

Return alarm message.

Name()

const char * ngcbALARM::Name

(

)

Return alarm name.

operator=()

ngcbALARM & ngcbALARM::operator=

(

const ngcbALARM &

other

)

Operator =.

Unit()

const char * ngcbALARM::Unit

(

)

Return the unit of the alarm value.

Value()

const char * ngcbALARM::Value

(

int

showUnit

)

Return formatted value string.

---

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

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