epics::pvaClient::PvaClientPutData Class Reference

A class that holds data given to by PvaClientPut or PvaClientPutGet. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientPutData:

Collaboration diagram for epics::pvaClient::PvaClientPutData:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientPutData)
	~PvaClientPutData ()
	Destructor. More...
void	putDouble (double value)
	Put the value as a double. More...
void	putString (std::string const &value)
	Put the value as a string. More...
void	putDoubleArray (epics::pvData::shared_vector< const double > const &value)
	Copy the array to the value field. More...
void	putStringArray (epics::pvData::shared_vector< const std::string > const &value)
	Copy array to the value field. More...
void	putStringArray (std::vector< std::string > const &value)
	Copy array to the value field. 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 PvaClientPutDataPtr	create (epics::pvData::StructureConstPtr const &structure)
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	PvaClientPostHandlerPvt
class	PvaClientPut
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 given to by PvaClientPut or PvaClientPutGet.

Overview of PvaClientPutData

Definition at line 772 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientPutData::~PvaClientPutData ( )

inline

Destructor.

Definition at line 779 of file pvaClient.h.

{}

Member Function Documentation

PvaClientPutDataPtr epics::pvaClient::PvaClientPutData::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 44 of file pvaClientPutData.cpp.

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

epics::pvaClient::PvaClientPutData::POINTER_DEFINITIONS

(

PvaClientPutData

)

void epics::pvaClient::PvaClientPutData::putDouble

(

double

value

)

Put the value as a double.

Parameters

value

The new value. An exception is also thrown if the actualy type can cause an overflow.

Exceptions

runtime_error

if failure.

Definition at line 74 of file pvaClientPutData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientPutData::putDouble\n";
    PVFieldPtr pvField = getSinglePVField();
    Type type = pvField->getField()->getType();
    if(type!=scalar) {
        throw std::logic_error("PvaClientData::putDouble() did not find a scalar field");
    }
    PVScalarPtr pvScalar = static_pointer_cast<PVScalar>(pvField);
    ScalarType scalarType = pvScalar->getScalar()->getScalarType();
    if(scalarType==pvDouble) {
        PVDoublePtr pvDouble = static_pointer_cast<PVDouble>(pvScalar);
         pvDouble->put(value);
         return;
    }
    if(!ScalarTypeFunc::isNumeric(scalarType)) {
        throw std::logic_error(
            "PvaClientData::putDouble() did not find a numeric scalar field");
    }
    convert->fromDouble(pvScalar,value);
}

void epics::pvaClient::PvaClientPutData::putDoubleArray

(

epics::pvData::shared_vector< const double > const &

value

)

Copy the array to the value field.

Parameters

value

The place where data is copied.

Exceptions

runtime_error

if failure.

Definition at line 108 of file pvaClientPutData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientPutData::putDoubleArray\n";
    PVFieldPtr pvField = getSinglePVField();
    Type type = pvField->getField()->getType();
    if(type!=scalarArray) {
        throw std::logic_error("PvaClientData::putDoubleArray() did not find a scalarArray field");
    }
    PVScalarArrayPtr pvScalarArray = static_pointer_cast<PVScalarArray>(pvField);
    ScalarType scalarType = pvScalarArray->getScalarArray()->getElementType();
    if(!ScalarTypeFunc::isNumeric(scalarType)) {
        throw std::logic_error(
            "PvaClientData::putDoubleArray() did not find a numeric scalarArray field");
    }
    pvScalarArray->putFrom<const double>(value);
}

void epics::pvaClient::PvaClientPutData::putString

(

std::string const &

value

)

Put the value as a string.

If value is not a scalar an exception is thrown.

Definition at line 96 of file pvaClientPutData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientPutData::putString\n";
    PVFieldPtr pvField = getSinglePVField();
    Type type = pvField->getField()->getType();
    if(type!=scalar) {
        throw std::logic_error("PvaClientData::putString() did not find a scalar field");
    }
    PVScalarPtr pvScalar = static_pointer_cast<PVScalar>(pvField);
    convert->fromString(pvScalar,value);
}

void epics::pvaClient::PvaClientPutData::putStringArray

(

epics::pvData::shared_vector< const std::string > const &

value

)

Copy array to the value field.

Parameters

value

data source

Exceptions

runtime_error

if failure.

Definition at line 125 of file pvaClientPutData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientPutData::putStringArray\n";
    PVFieldPtr pvField = getSinglePVField();
    Type type = pvField->getField()->getType();
    if(type!=scalarArray) {
        throw std::logic_error("PvaClientData::putStringArray() did not find a scalarArray field");
    }
    PVScalarArrayPtr pvScalarArray = static_pointer_cast<PVScalarArray>(pvField);
    pvScalarArray->putFrom<const string>(value);
    return;
}

void epics::pvaClient::PvaClientPutData::putStringArray

(

std::vector< std::string > const &

value

)

Copy array to the value field.

Parameters

value

data source

Exceptions

runtime_error

if failure.

Friends And Related Function Documentation

friend class PvaClientPostHandlerPvt

friend

Definition at line 815 of file pvaClient.h.

friend class PvaClientPut

friend

Definition at line 816 of file pvaClient.h.

friend class PvaClientPutGet

friend

Definition at line 817 of file pvaClient.h.

---

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

• modules/pvaClient/src/pv/pvaClient.h
• modules/pvaClient/src/pvaClientPutData.cpp