epics::pvaClient::PvaClientData Class Reference

A base class for PvaClientGetData, PvaClientPutData, and PvaClientMonitorData. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientData:

Collaboration diagram for epics::pvaClient::PvaClientData:

Public Member Functions
	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 PvaClientDataPtr	create (epics::pvData::StructureConstPtr const &structure)
	Factory method for creating an instance of PvaClientData. More...

Protected Member Functions
	PvaClientData (epics::pvData::StructureConstPtr const &structure)
epics::pvData::PVFieldPtr	getSinglePVField ()
void	checkValue ()

Protected Attributes
std::string	messagePrefix

Friends
class	PvaClientGet
class	PvaClientPutGet

Detailed Description

A base class for PvaClientGetData, PvaClientPutData, and PvaClientMonitorData.

Overview of PvaClientData

Definition at line 569 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientData::~PvaClientData ( )

inline

Destructor.

Definition at line 576 of file pvaClient.h.

{}

epics::pvaClient::PvaClientData::PvaClientData ( epics::pvData::StructureConstPtr const &  structure )

protected

Definition at line 55 of file pvaClientData.cpp.

: structure(structure)
{
}

Member Function Documentation

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

protected

Definition at line 84 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::checkValue\n";
    if(pvValue) return;
    throw std::runtime_error(messagePrefix + noValue);
}

PvaClientDataPtr epics::pvaClient::PvaClientData::create ( epics::pvData::StructureConstPtr const &  structure )

static

Factory method for creating an instance of PvaClientData.

NOTE: Not normally called by clients

Parameters

structure

Introspection interface

Exceptions

runtime_error

if failure.

Definition at line 48 of file pvaClientData.cpp.

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

Alarm epics::pvaClient::PvaClientData::getAlarm

(

)

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.

{
   if(PvaClient::getDebug()) cout << "PvaClientData::getAlarm\n";
   if(!pvStructure) throw new std::runtime_error(messagePrefix + noStructure);
   PVStructurePtr pvs = pvStructure->getSubField<PVStructure>("alarm");
   if(!pvs) throw std::runtime_error(messagePrefix + noAlarm);
   pvAlarm.attach(pvs);
   if(pvAlarm.isAttached()) {
       Alarm alarm;
       pvAlarm.get(alarm);
       pvAlarm.detach();
       return alarm;
   }
   throw std::runtime_error(messagePrefix + noAlarm);
}

PVArrayPtr epics::pvaClient::PvaClientData::getArrayValue

(

)

Get the interface to an array value field.

Returns

The interface.

Exceptions

runtime_error

if failure.

Definition at line 182 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::getArrayValue\n";
    checkValue();
    Type type = pvValue->getField()->getType();
    if(type!=scalarArray && type!=structureArray && type!=unionArray) {
        throw std::runtime_error(messagePrefix + noArray);
    }
    return pvStructure->getSubField<PVArray>("value");
}

BitSetPtr epics::pvaClient::PvaClientData::getChangedBitSet

(

)

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.

{
    if(bitSet)return bitSet;
    throw std::runtime_error(messagePrefix + noStructure);
}

double epics::pvaClient::PvaClientData::getDouble

(

)

Get the value as a double.

Returns

The value.

Exceptions

runtime_error

if failure.

Definition at line 204 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::getDouble\n";
    PVFieldPtr pvField = getSinglePVField();
    Type type = pvField->getField()->getType();
    if(type!=scalar) {
        throw std::logic_error("PvaClientData::getDouble() 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);
        return pvDouble->get();
    }
    if(!ScalarTypeFunc::isNumeric(scalarType)) {
        throw std::logic_error(
            "PvaClientData::getDouble() did not find a numeric scalar field");
    }
    return convert->toDouble(pvScalar);
}

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

(

)

Get the value as a double array.

Returns

The value.

Exceptions

runtime_error

if failure.

Definition at line 237 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::getDoubleArray\n";
    PVFieldPtr pvField = getSinglePVField();
    Type type = pvField->getField()->getType();
    if(type!=scalarArray) {
        throw std::logic_error("PvaClientData::getDoubleArray() 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::getDoubleArray() did not find a numeric scalarArray field");
    }
    shared_vector<const double> retValue;
    pvScalarArray->getAs<const double>(retValue);
    return retValue;
}

PVStructurePtr epics::pvaClient::PvaClientData::getPVStructure

(

)

Get the pvStructure.

Returns

the pvStructure.

Exceptions

runtime_error

if failure.

Definition at line 101 of file pvaClientData.cpp.

{
    if(pvStructure) return pvStructure;
    throw std::runtime_error(messagePrefix + noStructure);
}

PVScalarArrayPtr epics::pvaClient::PvaClientData::getScalarArrayValue

(

)

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.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::getScalarArrayValue\n";
    checkValue();
    Type type = pvValue->getField()->getType();
    if(type!=scalarArray) {
        throw std::runtime_error(messagePrefix + noScalarArray);
    }
    return pvStructure->getSubField<PVScalarArray>("value");
}

PVScalarPtr epics::pvaClient::PvaClientData::getScalarValue

(

)

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.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::getScalarValue\n";
    checkValue();
    if(pvValue->getField()->getType()!=scalar) {
       throw std::runtime_error(messagePrefix + noScalar);
    }
    return pvStructure->getSubField<PVScalar>("value");
}

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

protected

Definition at line 60 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::getSinglePVField\n";
    PVStructurePtr pvStructure = getPVStructure();
    while(true) {
         const PVFieldPtrArray fieldPtrArray(pvStructure->getPVFields());
         if(fieldPtrArray.size()==0) {
              throw std::logic_error("PvaClientData::getSinglePVField() pvRequest for empty structure");
         }
         if(fieldPtrArray.size()!=1) {
              PVFieldPtr pvValue  = pvStructure->getSubField("value");
              if(pvValue) {
                  Type type = pvValue->getField()->getType();
                  if(type!=epics::pvData::structure) return pvValue;
              }
              throw std::logic_error("PvaClientData::getSinglePVField() pvRequest for multiple fields");
         }
         PVFieldPtr pvField(fieldPtrArray[0]);
         Type type = pvField->getField()->getType();
         if(type!=epics::pvData::structure) return pvField;
         pvStructure = static_pointer_cast<PVStructure>(pvField);
    }
}

string epics::pvaClient::PvaClientData::getString

(

)

Get the value as a string.

Returns

The value.

Exceptions

runtime_error

if failure.

Definition at line 225 of file pvaClientData.cpp.

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

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

(

)

Get the value as a string array.

Returns

The value.

Exceptions

runtime_error

if failure.

Definition at line 256 of file pvaClientData.cpp.

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

StructureConstPtr epics::pvaClient::PvaClientData::getStructure

(

)

Get the structure.

Returns

The Structure

Exceptions

runtime_error

if failure.

Definition at line 96 of file pvaClientData.cpp.

{
    return structure;
}

TimeStamp epics::pvaClient::PvaClientData::getTimeStamp

(

)

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.

{
   if(PvaClient::getDebug()) cout << "PvaClientData::getTimeStamp\n";
   if(!pvStructure) throw new std::runtime_error(messagePrefix + noStructure);
   PVStructurePtr pvs = pvStructure->getSubField<PVStructure>("timeStamp");
   if(!pvs) throw std::runtime_error(messagePrefix + noTimeStamp);
   pvTimeStamp.attach(pvs);
   if(pvTimeStamp.isAttached()) {
       TimeStamp timeStamp;
       pvTimeStamp.get(timeStamp);
       pvTimeStamp.detach();
       return timeStamp;
   }
   throw std::runtime_error(messagePrefix + noTimeStamp);
}

PVFieldPtr epics::pvaClient::PvaClientData::getValue

(

)

Get the interface to the value field.

Returns

The interface.

Exceptions

runtime_error

if failure.

Definition at line 165 of file pvaClientData.cpp.

{
   if(PvaClient::getDebug()) cout << "PvaClientData::getValue\n";
   checkValue();
   return pvValue;
}

bool epics::pvaClient::PvaClientData::hasValue

(

)

Is there a top level field named value.

Returns

The answer.

Definition at line 142 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::hasValue\n";
    if(!pvValue) return false;
    return true;
}

bool epics::pvaClient::PvaClientData::isValueScalar

(

)

Is the value field a scalar?

Returns

The answer.

Definition at line 149 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::isValueScalar\n";
    if(!pvValue) return false;
    if(pvValue->getField()->getType()==scalar) return true;
    return false;
}

bool epics::pvaClient::PvaClientData::isValueScalarArray

(

)

Is the value field a scalar array?

Returns

The answer.

Definition at line 157 of file pvaClientData.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientData::isValueScalarArray\n";
    if(!pvValue) return false;
    if(pvValue->getField()->getType()==scalarArray) return true;
    return false;
}

void epics::pvaClient::PvaClientData::parse

(

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

args

)

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.

{
    if(!pvStructure) throw std::runtime_error(messagePrefix + noStructure);
    if(!bitSet) throw std::runtime_error(messagePrefix + noStructure);
    size_t num = args.size();
    if(num<1) throw std::runtime_error(messagePrefix + " no arguments");
    for(size_t i=0; i<num; ++i)
    {
        string val = args[i];
        size_t iequals = val.find_first_of('=');
        string field;
        string rest(val);
        if(iequals==std::string::npos) {
           parse(rest,pvStructure,bitSet);
           continue;
        }
        field = val.substr(0,iequals);
        rest = val.substr(iequals+1);
        if(field.size()==std::string::npos) {
           parse(rest,pvStructure,bitSet);
           continue;
        }
        PVFieldPtr pvField(pvStructure->getSubField(field));
        if(!pvField) throw std::runtime_error(messagePrefix + field +" does not exist");
        // look for enumerated structure
        PVEnumerated pvEnumerated;
        bool result = pvEnumerated.attach(pvField);
        if(result) {
             PVStringArray::const_svector choices(pvEnumerated.getChoices());
             for(size_t i=0; i<choices.size(); ++i) {
                  if(choices[i]==rest) {
                     pvEnumerated.setIndex(i);
                     return;
                  }
             }
        }
        // look for union
        PVUnionPtr pvUnion(pvStructure->getSubField<PVUnion>(field));
        if(pvUnion) {
            parse(rest,pvUnion);
            bitSet->set(pvUnion->getFieldOffset());
            return;
        }
        parse(rest,pvField,bitSet);
    }
}

epics::pvaClient::PvaClientData::POINTER_DEFINITIONS

(

PvaClientData

)

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

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.

{
   if(PvaClient::getDebug()) cout << "PvaClientData::setData\n";
   pvStructure = pvStructureFrom;
   bitSet = bitSetFrom;
   pvValue = pvStructure->getSubField("value");
}

void epics::pvaClient::PvaClientData::setMessagePrefix

(

std::string const &

value

)

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.

{
    messagePrefix = value + " ";
}

std::ostream & epics::pvaClient::PvaClientData::showChanged

(

std::ostream &

out

)

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.

{
    if(!bitSet) throw std::runtime_error(messagePrefix + noStructure);
    size_t nextSet = bitSet->nextSetBit(0);
    PVFieldPtr pvField;
    while(nextSet!=string::npos) {
        if(nextSet==0) {
             pvField = pvStructure;
        } else {
              pvField = pvStructure->getSubField(nextSet);
        }
        string name = pvField->getFullName();
        out << name << " = " << pvField << endl;
        nextSet = bitSet->nextSetBit(nextSet+1);
    }
    return out;
}

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

generate JSON output from the current PVStructure

Parameters

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

Exceptions

runtime_error

if failure.

Definition at line 392 of file pvaClientData.cpp.

{
#ifdef USE_JSON
    JSONPrintOptions opts;
    opts.ignoreUnprintable = ignoreUnprintable;
    opts.multiLine = multiLine;
    printJSON(strm,*pvStructure,*bitSet,opts);
#else
    throw std::runtime_error("JSON support not built");
#endif
}

void epics::pvaClient::PvaClientData::zeroArrayLength

(

)

set length of all array fields to 0

Definition at line 302 of file pvaClientData.cpp.

{
    if(!pvStructure) throw new std::runtime_error(messagePrefix + noStructure);
    zeroArrayLength(pvStructure);
}

Friends And Related Function Documentation

friend class PvaClientGet

friend

Definition at line 736 of file pvaClient.h.

friend class PvaClientPutGet

friend

Definition at line 737 of file pvaClient.h.

Member Data Documentation

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

protected

Definition at line 718 of file pvaClient.h.

---

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

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