pvaClientCPP
4.8.1-dev
|
A class that holds data returned by PvaClientGet or PvaClientPutGet. More...
#include <pv/pvaClient.h>
Public Member Functions | |
POINTER_DEFINITIONS (PvaClientGetData) | |
~PvaClientGetData () | |
Destructor. More... | |
POINTER_DEFINITIONS (PvaClientData) | |
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 and displays it on the output stream. 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... | |
Protected Member Functions | |
epics::pvData::PVFieldPtr | getSinglePVField () |
void | checkValue () |
Protected Attributes | |
std::string | messagePrefix |
Friends | |
class | PvaClientGet |
class | PvaClientPutGet |
A class that holds data returned by PvaClientGet or PvaClientPutGet.
Definition at line 710 of file pvaClient.h.
|
inline |
Destructor.
Definition at line 717 of file pvaClient.h.
|
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().
|
static |
Factory method for creating an instance of PvaClientGetData.
NOTE: Not normally called by clients
structure | Introspection interface |
runtime_error | if failure. |
Definition at line 29 of file pvaClientGetData.cpp.
|
inherited |
Get the alarm. If the pvStructure has an alarm field it's values are returned. Otherwise an exception is thrown.
runtime_error | if failure. |
Definition at line 270 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.
|
inherited |
Get the interface to an array value field.
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.
|
inherited |
Get the changed BitSet for the pvStructure.
This shows which fields have changed value since the last get.
runtime_error | if failure |
Definition at line 107 of file pvaClientData.cpp.
References epics::pvaClient::PvaClientData::messagePrefix.
|
inherited |
Get the value as a double.
runtime_error | if failure. |
Definition at line 204 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().
|
inherited |
Get the value as a double array.
runtime_error | if failure. |
Definition at line 237 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().
|
inherited |
Get the pvStructure.
runtime_error | if failure. |
Definition at line 101 of file pvaClientData.cpp.
References epics::pvaClient::PvaClientData::messagePrefix.
Referenced by epics::pvaClient::PvaClientData::getSinglePVField().
|
inherited |
Get the interface to a scalar array value field.
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.
|
inherited |
Return the interface to a scalar value field.
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.
|
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(), and epics::pvaClient::PvaClientData::getStringArray().
|
inherited |
Get the value as a string.
runtime_error | if failure. |
Definition at line 225 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().
|
inherited |
Get the value as a string array.
runtime_error | if failure. |
Definition at line 256 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::getSinglePVField().
|
inherited |
Get the structure.
runtime_error | if failure. |
Definition at line 96 of file pvaClientData.cpp.
|
inherited |
Get the timeStamp. If the pvStructure has a timeStamp field, it's values are returned. Otherwise an exception is thrown.
Definition at line 286 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug(), and epics::pvaClient::PvaClientData::messagePrefix.
|
inherited |
Get the interface to the value field.
runtime_error | if failure. |
Definition at line 165 of file pvaClientData.cpp.
References epics::pvaClient::PvaClientData::checkValue(), and epics::pvaClient::PvaClient::getDebug().
|
inherited |
Is there a top level field named value.
Definition at line 142 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug().
|
inherited |
Is the value field a scalar?
Definition at line 149 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug().
|
inherited |
Is the value field a scalar array?
Definition at line 157 of file pvaClientData.cpp.
References epics::pvaClient::PvaClient::getDebug().
|
inherited |
parse from args
Accepts arguments of the form json or field='value' where value is json syntax. field is name.name...
args | The arguments. |
runtime_error | if failure. |
Definition at line 345 of file pvaClientData.cpp.
References epics::pvaClient::PvaClientData::messagePrefix.
Referenced by epics::pvaClient::PvaClientData::zeroArrayLength().
|
inherited |
epics::pvaClient::PvaClientGetData::POINTER_DEFINITIONS | ( | PvaClientGetData | ) |
|
inherited |
New data is present.
This is called by other pvaClient classes, i. e. not by client.
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().
|
inherited |
Set a prefix for throw messages.
This is called by other pvaClient classes.
value | The prefix. |
Definition at line 91 of file pvaClientData.cpp.
References epics::pvaClient::PvaClientData::messagePrefix.
|
inherited |
Show the fields that have changed value since the last get.
out | The stream that shows the changed fields. |
Definition at line 113 of file pvaClientData.cpp.
References epics::pvaClient::PvaClientData::messagePrefix.
|
inherited |
generate JSON output from the current PVStructure and displays it on the output stream.
strm | The output stream. |
ignoreUnprintable | false or true; The default is true. |
multiline | false or true; The default is false. |
runtime_error | if failure. |
Definition at line 392 of file pvaClientData.cpp.
References 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::parse().
Referenced by epics::pvaClient::PvaClientData::streamJSON().
|
friend |
Definition at line 727 of file pvaClient.h.
|
friend |
Definition at line 728 of file pvaClient.h.
|
protectedinherited |
Definition at line 684 of file pvaClient.h.
Referenced by epics::pvaClient::PvaClientData::checkValue(), epics::pvaClient::PvaClientData::getAlarm(), epics::pvaClient::PvaClientData::getArrayValue(), epics::pvaClient::PvaClientData::getChangedBitSet(), epics::pvaClient::PvaClientData::getPVStructure(), epics::pvaClient::PvaClientData::getScalarArrayValue(), epics::pvaClient::PvaClientData::getScalarValue(), epics::pvaClient::PvaClientData::getTimeStamp(), epics::pvaClient::PvaClientData::parse(), epics::pvaClient::PvaClientData::setMessagePrefix(), epics::pvaClient::PvaClientData::showChanged(), and epics::pvaClient::PvaClientData::zeroArrayLength().