A class that holds data returned by PvaClientGet or PvaClientPutGet. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientGetData:

Collaboration diagram for epics::pvaClient::PvaClientGetData:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientGetData)

	~PvaClientGetData ()
	Destructor. More...

Public Member Functions inherited from epics::pvaClient::PvaClientData
	POINTER_DEFINITIONS (PvaClientData)

	~PvaClientData ()
	Destructor. More...

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

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

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

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

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

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

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

bool	isValueScalar ()
	Is the value field a scalar? More...

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

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

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

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

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

double	getDouble ()
	Get the value as a double. More...

std::string	getString ()

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

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

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

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

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

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

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

Static Public Member Functions
static PvaClientGetDataPtr	create (epics::pvData::StructureConstPtr const &structure)
	Factory method for creating an instance of PvaClientGetData. More...

Static Public Member Functions inherited from epics::pvaClient::PvaClientData
static PvaClientDataPtr	create (epics::pvData::StructureConstPtr const &structure)
	Factory method for creating an instance of PvaClientData. More...

Friends
class	PvaClientGet

class	PvaClientPutGet

Additional Inherited Members
Protected Member Functions inherited from epics::pvaClient::PvaClientData
	PvaClientData (epics::pvData::StructureConstPtr const &structure)

epics::pvData::PVFieldPtr	getSinglePVField ()

void	checkValue ()

Protected Attributes inherited from epics::pvaClient::PvaClientData
std::string	messagePrefix

Detailed Description

A class that holds data returned by PvaClientGet or PvaClientPutGet.

Overview of PvaClientGetData

Definition at line 745 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientGetData::~PvaClientGetData ( )

inline

Destructor.

Definition at line 752 of file pvaClient.h.

752 {}

Member Function Documentation

PvaClientGetDataPtr epics::pvaClient::PvaClientGetData::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

Exceptions

runtime_error if failure.

Definition at line 29 of file pvaClientGetData.cpp.

 {
     if(PvaClient::getDebug()) cout << "PvaClientGetData::create\n";
     PvaClientGetDataPtr epv(new PvaClientGetData(structure));
     return epv;
 }

epics::pvaClient::PvaClientGetData::POINTER_DEFINITIONS ( PvaClientGetData )

Friends And Related Function Documentation

friend class PvaClientGet

friend

Definition at line 762 of file pvaClient.h.

friend class PvaClientPutGet

friend

Definition at line 763 of file pvaClient.h.

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

modules/pvaClient/src/pv/pvaClient.h
modules/pvaClient/src/pvaClientGetData.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation