A class that holds data returned by PvaClientMonitor. More...

#include <pv/pvaClient.h>

Inheritance diagram for epics::pvaClient::PvaClientMonitorData:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientMonitorData)

	~PvaClientMonitorData ()
	Destructor.

epics::pvData::BitSetPtr	getOverrunBitSet ()
	Get the overrun BitSet for the pvStructure This shows which fields have had more than one change.

std::ostream &	showOverrun (std::ostream &out)
	Show the fields that have changed.

void	setData (epics::pvData::MonitorElementPtr const &monitorElement)

	POINTER_DEFINITIONS (PvaClientData)

void	setMessagePrefix (std::string const &value)
	Set a prefix for throw messages.

epics::pvData::StructureConstPtr	getStructure ()
	Get the structure.

epics::pvData::PVStructurePtr	getPVStructure ()
	Get the pvStructure.

epics::pvData::BitSetPtr	getChangedBitSet ()
	Get the changed BitSet for the pvStructure.

std::ostream &	showChanged (std::ostream &out)
	Show the fields that have changed value since the last get.

void	setData (epics::pvData::PVStructurePtr const &pvStructureFrom, epics::pvData::BitSetPtr const &bitSetFrom)
	New data is present.

bool	hasValue ()
	Is there a top level field named value.

bool	isValueScalar ()
	Is the value field a scalar?

bool	isValueScalarArray ()
	Is the value field a scalar array?

epics::pvData::PVFieldPtr	getValue ()
	Get the interface to the value field.

epics::pvData::PVScalarPtr	getScalarValue ()
	Return the interface to a scalar value field.

std::tr1::shared_ptr< epics::pvData::PVArray >	getArrayValue ()
	Get the interface to an array value field.

std::tr1::shared_ptr< epics::pvData::PVScalarArray >	getScalarArrayValue ()
	Get the interface to a scalar array value field.

double	getDouble ()
	Get the value as a double.

std::string	getString ()

epics::pvData::shared_vector< const double >	getDoubleArray ()
	Get the value as a double array.

epics::pvData::shared_vector< const std::string >	getStringArray ()
	Get the value as a string array.

epics::pvData::Alarm	getAlarm ()
	Get the alarm. If the pvStructure has an alarm field it's values are returned. Otherwise an exception is thrown.

epics::pvData::TimeStamp	getTimeStamp ()
	Get the timeStamp. If the pvStructure has a timeStamp field, it's values are returned. Otherwise an exception is thrown.

void	parse (const std::vector< std::string > &args)
	parse from args

void	streamJSON (std::ostream &strm, bool ignoreUnprintable=true, bool multiLine=false)
	generate JSON output from the current PVStructure and displays it on the output stream.

void	zeroArrayLength ()
	set length of all array fields to 0

Static Public Member Functions
static PvaClientMonitorDataPtr	create (epics::pvData::StructureConstPtr const &structure)

Protected Member Functions
epics::pvData::PVFieldPtr	getSinglePVField ()

void	checkValue ()

Protected Attributes
std::string	messagePrefix

Friends
class	PvaClientMonitor

Detailed Description

A class that holds data returned by PvaClientMonitor.

Definition at line 787 of file pvaClient.h.

Constructor & Destructor Documentation

◆ ~PvaClientMonitorData()

epics::pvaClient::PvaClientMonitorData::~PvaClientMonitorData ( )

inline

Destructor.

Definition at line 794 of file pvaClient.h.

Member Function Documentation

◆ checkValue()

void epics::pvaClient::PvaClientData::checkValue ( )

protectedinherited

Definition at line 84 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.

Referenced by epics::pvaClient::PvaClientData::getArrayValue(), epics::pvaClient::PvaClientData::getScalarArrayValue(), epics::pvaClient::PvaClientData::getScalarValue(), and epics::pvaClient::PvaClientData::getValue().

◆ create()

PvaClientMonitorDataPtr epics::pvaClient::PvaClientMonitorData::create ( epics::pvData::StructureConstPtr const & structure )

static

Factory method for creating an instance of PvaClientGetData. NOTE: Not normally called by clients

Parameters

structure Introspection interface

Definition at line 48 of file pvaClientMonitorData.cpp.

◆ getAlarm()

Alarm epics::pvaClient::PvaClientData::getAlarm ( )

inherited

Get the alarm. If the pvStructure has an alarm field it's values are returned. Otherwise an exception is thrown.

Returns: The alarm.

Exceptions

runtime_error if failure.

Definition at line 270 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.

◆ getArrayValue()

PVArrayPtr epics::pvaClient::PvaClientData::getArrayValue ( )

inherited

Get the interface to an array value field.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 182 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::checkValue(), epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.

◆ getChangedBitSet()

BitSetPtr epics::pvaClient::PvaClientData::getChangedBitSet ( )

inherited

Get the changed BitSet for the pvStructure.

This shows which fields have changed value since the last get.

Returns: The bitSet

Exceptions

runtime_error if failure

Definition at line 107 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix.

◆ getDouble()

double epics::pvaClient::PvaClientData::getDouble ( )

inherited

Get the value as a double.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 204 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().

◆ getDoubleArray()

shared_vector< const double > epics::pvaClient::PvaClientData::getDoubleArray ( )

inherited

Get the value as a double array.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 237 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().

◆ getOverrunBitSet()

BitSetPtr epics::pvaClient::PvaClientMonitorData::getOverrunBitSet ( )

Get the overrun BitSet for the pvStructure This shows which fields have had more than one change.

Returns: The bitSet

Exceptions

runtime_error if failure.

Definition at line 67 of file pvaClientMonitorData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix.

◆ getPVStructure()

PVStructurePtr epics::pvaClient::PvaClientData::getPVStructure ( )

inherited

Get the pvStructure.

Returns: the pvStructure.

Exceptions

runtime_error if failure.

Definition at line 101 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix.

Referenced by epics::pvaClient::PvaClientData::getSinglePVField(), and showOverrun().

◆ getScalarArrayValue()

PVScalarArrayPtr epics::pvaClient::PvaClientData::getScalarArrayValue ( )

inherited

Get the interface to a scalar array value field.

Returns: Return the interface.

Exceptions

runtime_error if failure.

Definition at line 193 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::checkValue(), epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.

◆ getScalarValue()

PVScalarPtr epics::pvaClient::PvaClientData::getScalarValue ( )

inherited

Return the interface to a scalar value field.

Returns: The interface for a scalar value field.

Exceptions

runtime_error if failure.

Definition at line 172 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::checkValue(), epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.

◆ getSinglePVField()

PVFieldPtr epics::pvaClient::PvaClientData::getSinglePVField ( )

protectedinherited

Definition at line 60 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getPVStructure().

Referenced by epics::pvaClient::PvaClientData::getDouble(), epics::pvaClient::PvaClientData::getDoubleArray(), epics::pvaClient::PvaClientData::getString(), epics::pvaClient::PvaClientData::getStringArray(), epics::pvaClient::PvaClientPutData::putDouble(), epics::pvaClient::PvaClientPutData::putDoubleArray(), and epics::pvaClient::PvaClientPutData::putString().

◆ getString()

string epics::pvaClient::PvaClientData::getString ( )

inherited

Get the value as a string.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 225 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().

◆ getStringArray()

shared_vector< const string > epics::pvaClient::PvaClientData::getStringArray ( )

inherited

Get the value as a string array.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 256 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().

◆ getStructure()

StructureConstPtr epics::pvaClient::PvaClientData::getStructure ( )

inherited

Get the structure.

Returns: The Structure

Exceptions

runtime_error if failure.

Definition at line 96 of file pvaClientData.cpp.

◆ getTimeStamp()

TimeStamp epics::pvaClient::PvaClientData::getTimeStamp ( )

inherited

Get the timeStamp. If the pvStructure has a timeStamp field, it's values are returned. Otherwise an exception is thrown.

Returns: The timeStamp.

Definition at line 286 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.

◆ getValue()

PVFieldPtr epics::pvaClient::PvaClientData::getValue ( )

inherited

Get the interface to the value field.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 165 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::checkValue(), and epics::pvaClient::PvaClient::getDebug().

◆ hasValue()

bool epics::pvaClient::PvaClientData::hasValue ( )

inherited

Is there a top level field named value.

Returns: The answer.

Definition at line 142 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ isValueScalar()

bool epics::pvaClient::PvaClientData::isValueScalar ( )

inherited

Is the value field a scalar?

Returns: The answer.

Definition at line 149 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ isValueScalarArray()

bool epics::pvaClient::PvaClientData::isValueScalarArray ( )

inherited

Is the value field a scalar array?

Returns: The answer.

Definition at line 157 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ parse()

void epics::pvaClient::PvaClientData::parse ( const std::vector< std::string > & args )

inherited

parse from args

Accepts arguments of the form json or field='value' where value is json syntax. field is name.name...

Parameters

args	The arguments.

Exceptions

runtime_error if failure.

Definition at line 345 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix, and epics::pvaClient::PvaClientData::parse().

Referenced by epics::pvaClient::PvaClientData::parse().

◆ POINTER_DEFINITIONS() [1/2]

epics::pvaClient::PvaClientData::POINTER_DEFINITIONS ( PvaClientData )

inherited

◆ POINTER_DEFINITIONS() [2/2]

epics::pvaClient::PvaClientMonitorData::POINTER_DEFINITIONS ( PvaClientMonitorData )

◆ setData() [1/2]

void epics::pvaClient::PvaClientData::setData	(	epics::pvData::PVStructurePtr const &	pvStructureFrom,
		epics::pvData::BitSetPtr const &	bitSetFrom )

inherited

New data is present.

This is called by other pvaClient classes, i. e. not by client.

Parameters

pvStructureFrom	The new data.
bitSetFrom	the bitSet showing which values have changed.

Definition at line 131 of file pvaClientData.cpp.

References epics::pvaClient::PvaClient::getDebug().

Referenced by setData().

◆ setData() [2/2]

void epics::pvaClient::PvaClientMonitorData::setData ( epics::pvData::MonitorElementPtr const & monitorElement )

Put data into PVStructure from monitorElement NOTE: Not normally called by clients

Parameters

monitorElement the monitorElement that has new data.

Definition at line 59 of file pvaClientMonitorData.cpp.

References epics::pvaClient::PvaClientData::setData().

◆ setMessagePrefix()

void epics::pvaClient::PvaClientData::setMessagePrefix ( std::string const & value )

inherited

Set a prefix for throw messages.

This is called by other pvaClient classes.

Parameters

value The prefix.

Definition at line 91 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix.

◆ showChanged()

std::ostream & epics::pvaClient::PvaClientData::showChanged ( std::ostream & out )

inherited

Show the fields that have changed value since the last get.

Parameters

out	The stream that shows the changed fields.

Returns: The stream that was passed as out.

Definition at line 113 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix.

◆ showOverrun()

std::ostream & epics::pvaClient::PvaClientMonitorData::showOverrun ( std::ostream & out )

Show the fields that have changed.

Parameters

out	The stream that shows the changed fields.

Returns: The stream that was passed as out.

Definition at line 73 of file pvaClientMonitorData.cpp.

References epics::pvaClient::PvaClientData::getPVStructure(), and epics::pvaClient::PvaClientData::messagePrefix.

◆ streamJSON()

void epics::pvaClient::PvaClientData::streamJSON	(	std::ostream &	strm,
		bool	ignoreUnprintable = true,
		bool	multiLine = false )

inherited

generate JSON output from the current PVStructure and displays it on the output stream.

Parameters

strm	The output stream.
ignoreUnprintable	false or true; The default is true.
multiline	false or true; The default is false.

Exceptions

runtime_error if failure.

Definition at line 392 of file pvaClientData.cpp.

◆ zeroArrayLength()

void epics::pvaClient::PvaClientData::zeroArrayLength ( )

inherited

set length of all array fields to 0

Definition at line 302 of file pvaClientData.cpp.

References epics::pvaClient::PvaClientData::messagePrefix, and epics::pvaClient::PvaClientData::zeroArrayLength().

Referenced by epics::pvaClient::PvaClientData::zeroArrayLength().

Friends And Related Symbol Documentation

◆ PvaClientMonitor

friend class PvaClientMonitor

friend

Definition at line 820 of file pvaClient.h.

Member Data Documentation

◆ messagePrefix

std::string epics::pvaClient::PvaClientData::messagePrefix

protectedinherited

Definition at line 684 of file pvaClient.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~PvaClientMonitorData()

Member Function Documentation

◆ checkValue()

◆ create()

◆ getAlarm()

◆ getArrayValue()

◆ getChangedBitSet()

◆ getDouble()

◆ getDoubleArray()

◆ getOverrunBitSet()

◆ getPVStructure()

◆ getScalarArrayValue()

◆ getScalarValue()

◆ getSinglePVField()

◆ getString()

◆ getStringArray()

◆ getStructure()

◆ getTimeStamp()

◆ getValue()

◆ hasValue()

◆ isValueScalar()

◆ isValueScalarArray()

◆ parse()

◆ POINTER_DEFINITIONS() [1/2]

◆ POINTER_DEFINITIONS() [2/2]

◆ setData() [1/2]

◆ setData() [2/2]

◆ setMessagePrefix()

◆ showChanged()

◆ showOverrun()

◆ streamJSON()

◆ zeroArrayLength()

Friends And Related Symbol Documentation

◆ PvaClientMonitor

Member Data Documentation

◆ messagePrefix