Structure for storing parameter value in parameter library. More...

#include <paramVal.h>

Public Member Functions
	paramVal (const char *name)

	paramVal (const char *name, asynParamType type)

	~paramVal ()

bool	isDefined ()

void	setDefined (bool defined)

bool	hasValueChanged ()

void	setValueChanged ()

void	resetValueChanged ()

void	setStatus (asynStatus status)

asynStatus	getStatus ()

void	setAlarmStatus (int status)

int	getAlarmStatus ()

void	setAlarmSeverity (int severity)

int	getAlarmSeverity ()

char *	getName ()

bool	nameEquals (const char *name)

void	setInteger (epicsInt32 value)
	Sets the value for an integer.

epicsInt32	getInteger ()
	Gets the value for an integer in the parameter library.

void	setInteger64 (epicsInt64 value)
	Sets the value for a 64-bit integer.

epicsInt64	getInteger64 ()
	Gets the value for a 64-bit integer in the parameter library.

void	setUInt32 (epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask)
	Sets the value for a UInt32 in the parameter library.

epicsUInt32	getUInt32 (epicsUInt32 valueMask)
	Gets the value for a UInt32 in the parameter library.

void	setDouble (epicsFloat64 value)
	Sets the value for a double in the parameter library.

epicsFloat64	getDouble ()
	Gets the value for an double in the parameter library.

void	setString (const std::string &value)
	Sets the value for a string in the parameter library.

const std::string &	getString ()
	Gets the value for a string in the parameter library.

void	report (int id, FILE *fp, int details)

const char *	getTypeName ()

Public Attributes
asynParamType	type
	Parameter data type.

epicsUInt32	uInt32RisingMask

epicsUInt32	uInt32FallingMask

epicsUInt32	uInt32CallbackMask

Static Public Attributes
static const char *	typeNames []

Protected Attributes
asynStatus	status_

int	alarmStatus_

int	alarmSeverity_

bool	valueDefined

bool	valueChanged

char *	name
	Parameter name.

std::string	sval

union {

epicsInt32 ival

epicsInt64 i64val

epicsUInt32 uival

epicsFloat64 dval

epicsInt8 * pi8

epicsInt16 * pi16

epicsInt32 * pi32

epicsInt64 * pi64

epicsFloat32 * pf32

epicsFloat64 * pf64

void * pgp

}	data
	Union for parameter value.

Detailed Description

Structure for storing parameter value in parameter library.

Constructor & Destructor Documentation

◆ paramVal() [1/2]

paramVal::paramVal ( const char * name )

◆ paramVal() [2/2]

paramVal::paramVal	(	const char *	name,
		asynParamType	type
	)

◆ ~paramVal()

paramVal::~paramVal ( )

Member Function Documentation

◆ getAlarmSeverity()

int paramVal::getAlarmSeverity ( )

◆ getAlarmStatus()

int paramVal::getAlarmStatus ( )

◆ getDouble()

double paramVal::getDouble ( )

Gets the value for an double in the parameter library.

Exceptions

ParamValWrongType	if type is not asynParamFloat64
paramValNotDefined	if the value is not defined

◆ getInteger()

epicsInt32 paramVal::getInteger ( )

Gets the value for an integer in the parameter library.

Exceptions

ParamValWrongType	if type is not asynParamInt32
paramValNotDefined	if the value is not defined

◆ getInteger64()

epicsInt64 paramVal::getInteger64 ( )

Gets the value for a 64-bit integer in the parameter library.

Exceptions

ParamValWrongType	if type is not asynParamInt64
paramValNotDefined	if the value is not defined

◆ getName()

char * paramVal::getName ( )

◆ getStatus()

asynStatus paramVal::getStatus ( )

◆ getString()

const std::string & paramVal::getString ( )

Gets the value for a string in the parameter library.

Exceptions

ParamValWrongType	if type is not asynParamOctet
paramValNotDefined	if the value is not defined

◆ getTypeName()

const char * paramVal::getTypeName ( )

◆ getUInt32()

epicsUInt32 paramVal::getUInt32 ( epicsUInt32 valueMask )

Gets the value for a UInt32 in the parameter library.

Parameters

[in] valueMask Mask to use when getting the value.

Returns: Returns asynParamBadIndex if the index is not valid or asynParamWrongType if the parameter type is not asynParamUInt32Digital.

◆ hasValueChanged()

bool paramVal::hasValueChanged ( )

◆ isDefined()

bool paramVal::isDefined ( )

◆ nameEquals()

bool paramVal::nameEquals ( const char * name )

◆ report()

void paramVal::report	(	int	id,
		FILE *	fp,
		int	details
	)

◆ resetValueChanged()

void paramVal::resetValueChanged ( )

◆ setAlarmSeverity()

void paramVal::setAlarmSeverity ( int severity )

◆ setAlarmStatus()

void paramVal::setAlarmStatus ( int status )

◆ setDefined()

void paramVal::setDefined ( bool defined )

◆ setDouble()

void paramVal::setDouble ( epicsFloat64 value )

Sets the value for a double in the parameter library.

Parameters

[in] value Value to set.

Returns: Returns asynParamBadIndex if the index is not valid or asynParamWrongType if the parameter type is not asynParamFloat64.

◆ setInteger()

void paramVal::setInteger ( epicsInt32 value )

Sets the value for an integer.

Parameters

[in] value Value to set.

Exceptions

ParamValWrongType if type is not asynParamInt32

◆ setInteger64()

void paramVal::setInteger64 ( epicsInt64 value )

Sets the value for a 64-bit integer.

Parameters

[in] value Value to set.

Exceptions

ParamValWrongType if type is not asynParamInt64

◆ setStatus()

void paramVal::setStatus ( asynStatus status )

◆ setString()

void paramVal::setString ( const std::string & value )

Sets the value for a string in the parameter library.

Parameters

[out] value Address of value to set.

Returns: Returns asynParamBadIndex if the index is not valid or asynParamWrongType if the parameter type is not asynParamOctet.

◆ setUInt32()

void paramVal::setUInt32	(	epicsUInt32	value,
		epicsUInt32	valueMask,
		epicsUInt32	interruptMask
	)

Sets the value for a UInt32 in the parameter library.

Parameters

[in]	value	Value to set.
[in]	valueMask	Mask to use when setting the value.
[in]	interruptMask	Mask of bits that have changed even if the value has not changed

Returns: Returns asynParamBadIndex if the index is not valid or asynParamWrongType if the parameter type is not asynParamUInt32Digital.

◆ setValueChanged()

void paramVal::setValueChanged ( )

Member Data Documentation

◆ alarmSeverity_

int paramVal::alarmSeverity_

protected

◆ alarmStatus_

int paramVal::alarmStatus_

protected

◆ [union]

union { ... } paramVal::data

Union for parameter value.

◆ dval

epicsFloat64 paramVal::dval

◆ i64val

epicsInt64 paramVal::i64val

◆ ival

epicsInt32 paramVal::ival

◆ name

char* paramVal::name

protected

Parameter name.

◆ pf32

epicsFloat32* paramVal::pf32

◆ pf64

epicsFloat64* paramVal::pf64

◆ pgp

void* paramVal::pgp

◆ pi16

epicsInt16* paramVal::pi16

◆ pi32

epicsInt32* paramVal::pi32

◆ pi64

epicsInt64* paramVal::pi64

◆ pi8

epicsInt8* paramVal::pi8

◆ status_

asynStatus paramVal::status_

protected

◆ sval

std::string paramVal::sval

protected

◆ type

asynParamType paramVal::type

Parameter data type.

◆ typeNames

const char * paramVal::typeNames

static

Initial value:

= {
    "asynParamTypeUndefined",
    "asynParamInt32",
    "asynParamInt64",
    "asynParamUInt32Digital",
    "asynParamFloat64",
    "asynParamOctet",
    "asynParamInt8Array",
    "asynParamInt16Array",
    "asynParamInt32Array",
    "asynParamInt64Array",
    "asynParamFloat32Array",
    "asynParamFloat64Array",
    "asynParamGenericPointer"
}

◆ uInt32CallbackMask

epicsUInt32 paramVal::uInt32CallbackMask

◆ uInt32FallingMask

epicsUInt32 paramVal::uInt32FallingMask

◆ uInt32RisingMask

epicsUInt32 paramVal::uInt32RisingMask

◆ uival

epicsUInt32 paramVal::uival

◆ valueChanged

bool paramVal::valueChanged

protected

◆ valueDefined

bool paramVal::valueDefined

protected

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

/home/runner/work/asyn/asyn/asyn/asynPortDriver/paramVal.h
/home/runner/work/asyn/asyn/asyn/asynPortDriver/paramVal.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ paramVal() [1/2]

◆ paramVal() [2/2]

◆ ~paramVal()

Member Function Documentation

◆ getAlarmSeverity()

◆ getAlarmStatus()

◆ getDouble()

◆ getInteger()

◆ getInteger64()

◆ getName()

◆ getStatus()

◆ getString()

◆ getTypeName()

◆ getUInt32()

◆ hasValueChanged()

◆ isDefined()

◆ nameEquals()

◆ report()

◆ resetValueChanged()

◆ setAlarmSeverity()

◆ setAlarmStatus()

◆ setDefined()

◆ setDouble()

◆ setInteger()

◆ setInteger64()

◆ setStatus()

◆ setString()

◆ setUInt32()

◆ setValueChanged()

Member Data Documentation

◆ alarmSeverity_

◆ alarmStatus_

◆ [union]

◆ dval

◆ i64val

◆ ival

◆ name

◆ pf32

◆ pf64

◆ pgp

◆ pi16

◆ pi32

◆ pi64

◆ pi8

◆ status_

◆ sval

◆ type

◆ typeNames

◆ uInt32CallbackMask

◆ uInt32FallingMask

◆ uInt32RisingMask

◆ uival

◆ valueChanged

◆ valueDefined