epics::pvData::Convert Class Reference

Conversion and Copy facility for pvData. More...

#include "convert.h"

Public Member Functions
void	copy (PVFieldPtr const &from, PVFieldPtr const &to)
void	getString (std::string *buf, PVFieldPtr const &pvField)
void	getString (std::string *buf, PVField const *pvField, int indentLevel)
std::size_t	fromString (PVStructurePtr const &pv, StringArray const &from, std::size_t fromStartIndex=0)
void	fromString (PVScalarPtr const &pv, std::string const &from)
std::size_t	fromString (PVScalarArrayPtr const &pv, std::string from)
std::size_t	fromStringArray (PVScalarArrayPtr const &pv, std::size_t offset, std::size_t length, StringArray const &from, std::size_t fromOffset)
std::size_t	toStringArray (PVScalarArrayPtr const &pv, std::size_t offset, std::size_t length, StringArray &to, std::size_t toOffset)
int8	toByte (PVScalarPtr const &pv)
int16	toShort (PVScalarPtr const &pv)
int32	toInt (PVScalarPtr const &pv)
int64	toLong (PVScalarPtr const &pv)
uint8	toUByte (PVScalarPtr const &pv)
uint16	toUShort (PVScalarPtr const &pv)
uint32	toUInt (PVScalarPtr const &pv)
uint64	toULong (PVScalarPtr const &pv)
float	toFloat (PVScalarPtr const &pv)
double	toDouble (PVScalarPtr const &pv)
std::string	toString (PVScalarPtr const &pv)
void	fromByte (PVScalarPtr const &pv, int8 from)
void	fromShort (PVScalarPtr const &pv, int16 from)
void	fromInt (PVScalarPtr const &pv, int32 from)
void	fromLong (PVScalarPtr const &pv, int64 from)
void	fromUByte (PVScalarPtr const &pv, uint8 from)
void	fromUShort (PVScalarPtr const &pv, uint16 from)
void	fromUInt (PVScalarPtr const &pv, uint32 from)
void	fromULong (PVScalarPtr const &pv, uint64 from)
void	fromFloat (PVScalarPtr const &pv, float from)
void	fromDouble (PVScalarPtr const &pv, double from)

Static Public Member Functions
static ConvertPtr	getConvert ()

Detailed Description

Conversion and Copy facility for pvData.

Convert between numeric types, convert any field to a string, or convert from a string to a scalar field.

Numeric conversions are between scalar numeric types or between arrays of numeric types. It is not possible to convert between a scalar and an array. Numeric conversions are between types: pvByte, pvShort, pvInt, pvLong, pvUByte, pvUShort, pvUInt, pvULong, pvFloat, or pvDouble.

getString converts any supported type to a std::string.

fromString converts a std::string to a scalar. fromStringArray converts an array of std::strings to a pvArray, which must have a scaler element type. A scalar field is a numeric field or pvBoolean or pvString.

All from methods put data into a PVField, e.g. from means where the PVField gets it's data.

Definition at line 47 of file convert.h.

Member Function Documentation

void epics::pvData::Convert::copy ( PVFieldPtr const &  from, PVFieldPtr const &  to  )

inline

Copy from a PVField to another PVField. This calls one on copyScalar, copyArray, copyStructure. The two arguments must be compatible.

Parameters

from	The source.
to	The destination

Exceptions

std::invalid_argument

if the arguments are not compatible.

Deprecated:

use "to->copy[Unchecked](*from)" instead

Definition at line 60 of file convert.h.

                                                              {
        to->copy(*from);
    }

void epics::pvData::Convert::fromByte ( PVScalarPtr const &  pv, int8  from  )

inline

Convert a PV from a byte

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 224 of file convert.h.

{ pv->putFrom<int8>(from); }

void epics::pvData::Convert::fromDouble ( PVScalarPtr const &  pv, double  from  )

inline

Convert a PV from a double

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 287 of file convert.h.

{ pv->putFrom<double>(from); }

void epics::pvData::Convert::fromFloat ( PVScalarPtr const &  pv, float  from  )

inline

Convert a PV from a float

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 280 of file convert.h.

{ pv->putFrom<float>(from); }

void epics::pvData::Convert::fromInt ( PVScalarPtr const &  pv, int32  from  )

inline

Convert a PV from an int

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 238 of file convert.h.

{ pv->putFrom<int32>(from); }

void epics::pvData::Convert::fromLong ( PVScalarPtr const &  pv, int64  from  )

inline

Convert a PV from a long

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 245 of file convert.h.

{ pv->putFrom<int64>(from); }

void epics::pvData::Convert::fromShort ( PVScalarPtr const &  pv, int16  from  )

inline

Convert a PV from a short

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 231 of file convert.h.

{ pv->putFrom<int16>(from); }

std::size_t epics::pvData::Convert::fromString	(	PVStructurePtr const &	pv,
		StringArray const &	from,
		std::size_t	fromStartIndex = 0
	)

Convert from an array of std::string to a PVStructure

Parameters

pv	The PV.
from	The array of std::string value to convert and put into a PV.
fromStartIndex	The first element if the array of strings.

Returns

The total number of fields that have been changed.

Exceptions

std::logic_error

if the array of std::string does not have a valid values.

void epics::pvData::Convert::fromString ( PVScalarPtr const &  pv, std::string const &  from  )

inline

Convert from a std::string to a PVScalar

Parameters

pv	The PV.
from	The std::string value to convert and put into a PV.

Exceptions

std::logic_error

if the std::string does not have a valid value.

Definition at line 98 of file convert.h.

    {
        pv->putFrom<std::string>(from);
    }

std::size_t epics::pvData::Convert::fromString	(	PVScalarArrayPtr const &	pv,
		std::string	from
	)

Convert from a std::string to a PVScalarArray. The std::string must be a comma separated set of values optionally enclosed in []

Parameters

pv	The PV.
from	The std::string value to convert and put into a PV.

Returns

The number of elements converted.

Exceptions

std::invalid_argument	if the element Type is not a scalar.
std::logic_error	if the std::string does not have a valid array values.

size_t epics::pvData::Convert::fromStringArray	(	PVScalarArrayPtr const &	pv,
		std::size_t	offset,
		std::size_t	length,
		StringArray const &	from,
		std::size_t	fromOffset
	)

Convert a PVScalarArray from a std::string array. The array element type must be a scalar.

Parameters

pv	The PV.
offset	Starting element in a PV.
length	The number of elements to transfer.
from	The array of values to put into the PV.
fromOffset	Starting element in the source array.

Returns

The number of elements converted.

Exceptions

std::invalid_argument	if the element Type is not a scalar.
std::logic_error	if the std::string does not have a valid value.

Definition at line 114 of file Convert.cpp.

{
    size_t alen = pv->getLength();

    if(offset==0 && length>=alen) {
        // replace all existing elements
        assert(from.size()>=fromOffset+length);

        PVStringArray::svector data(length);
        std::copy(from.begin()+fromOffset,
                  from.begin()+fromOffset+length,
                  data.begin());

        PVStringArray::const_svector temp(freeze(data));
        pv->putFrom<string>(temp);
        return length;

    } else {
        // partial update.
        throw std::runtime_error("fromStringArray: partial update not implemented");
    }
}

void epics::pvData::Convert::fromUByte ( PVScalarPtr const &  pv, uint8  from  )

inline

Convert a PV from a ubyte

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 252 of file convert.h.

{ pv->putFrom<uint8>(from); }

void epics::pvData::Convert::fromUInt ( PVScalarPtr const &  pv, uint32  from  )

inline

Convert a PV from an uint

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 266 of file convert.h.

{ pv->putFrom<uint32>(from); }

void epics::pvData::Convert::fromULong ( PVScalarPtr const &  pv, uint64  from  )

inline

Convert a PV from a ulong

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 273 of file convert.h.

{ pv->putFrom<uint64>(from); }

void epics::pvData::Convert::fromUShort ( PVScalarPtr const &  pv, uint16  from  )

inline

Convert a PV from a ushort

Parameters

pv	a PV
from	value to put into PV

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 259 of file convert.h.

{ pv->putFrom<uint16>(from); }

ConvertPtr epics::pvData::Convert::getConvert ( )

static

Definition at line 153 of file Convert.cpp.

{
    static ConvertPtr convert;
    static Mutex mutex;
    Lock xx(mutex);

    if(convert.get()==0) {
        convert = ConvertPtr(new Convert());
    }
    return convert;
}

void epics::pvData::Convert::getString ( std::string *  buf, PVFieldPtr const &  pvField  )

inline

Convert a PVField to a string. If a PVField is a structure or array be prepared for a very long string.

Parameters

buf	string that will hold pvField converted to a string,
pvField	The PVField to convert to a string.

Definition at line 70 of file convert.h.

    {getString(buf, pvField.get(), 0);}

void epics::pvData::Convert::getString	(	std::string *	buf,
		PVField const *	pvField,
		int	indentLevel
	)

Convert a PVField to a string. If a PVField is a structure or array be prepared for a very long string.

Parameters

buf	string that will hold pvField converted to a string,
pvField	The PVField to convert to a string.
indentLevel	indentation level

int8 epics::pvData::Convert::toByte ( PVScalarPtr const &  pv )

inline

Convert a PV to a byte.

Parameters

pv

a PV

Returns

converted value

Definition at line 149 of file convert.h.

{ return pv->getAs<int8>();}

double epics::pvData::Convert::toDouble ( PVScalarPtr const &  pv )

inline

Convert a PV to a double

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 211 of file convert.h.

{ return pv->getAs<double>();}

float epics::pvData::Convert::toFloat ( PVScalarPtr const &  pv )

inline

Convert a PV to a float

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 204 of file convert.h.

{ return pv->getAs<float>();}

int32 epics::pvData::Convert::toInt ( PVScalarPtr const &  pv )

inline

Convert a PV to a int.

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 163 of file convert.h.

{ return pv->getAs<int32>();}

int64 epics::pvData::Convert::toLong ( PVScalarPtr const &  pv )

inline

Convert a PV to an long

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 170 of file convert.h.

{ return pv->getAs<int32>();}

int16 epics::pvData::Convert::toShort ( PVScalarPtr const &  pv )

inline

Convert a PV to a short.

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 156 of file convert.h.

{ return pv->getAs<int16>();}

std::string epics::pvData::Convert::toString ( PVScalarPtr const &  pv )

inline

Convert a PV to a std::string

Parameters

pv

a PV

Returns

converted value

Definition at line 217 of file convert.h.

{ return pv->getAs<std::string>();}

size_t epics::pvData::Convert::toStringArray	(	PVScalarArrayPtr const &	pv,
		std::size_t	offset,
		std::size_t	length,
		StringArray &	to,
		std::size_t	toOffset
	)

Convert a PVScalarArray to a std::string array.

Parameters

pv	The PV.
offset	Starting element in the PV array.
length	Number of elements to convert to the string array.
to	std::string array to receive the converted PV data.
toOffset	Starting element in the string array.

Returns

Number of elements converted.

Definition at line 140 of file Convert.cpp.

{
    PVStringArray::const_svector data;
    pv->getAs<string>(data);
    data.slice(offset, length);
    if(toOffset+data.size() > to.size())
        to.resize(toOffset+data.size());
    std::copy(data.begin()+toOffset, data.end(), to.begin());
    return data.size();
}

uint8 epics::pvData::Convert::toUByte ( PVScalarPtr const &  pv )

inline

Convert a PV to a ubyte.

Parameters

pv

a PV

Returns

converted value

Definition at line 176 of file convert.h.

{ return pv->getAs<uint8>();}

uint32 epics::pvData::Convert::toUInt ( PVScalarPtr const &  pv )

inline

Convert a PV to a uint.

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 190 of file convert.h.

{ return pv->getAs<uint32>();}

uint64 epics::pvData::Convert::toULong ( PVScalarPtr const &  pv )

inline

Convert a PV to an ulong

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 197 of file convert.h.

{ return pv->getAs<uint64>();}

uint16 epics::pvData::Convert::toUShort ( PVScalarPtr const &  pv )

inline

Convert a PV to a ushort.

Parameters

pv

a PV

Returns

converted value

Exceptions

std::invalid_argument

if the Type is not a numeric scalar

Definition at line 183 of file convert.h.

{ return pv->getAs<uint16>();}

---

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

• modules/pvData/src/pv/convert.h
• modules/pvData/src/factory/Convert.cpp