epics::pvData::ScalarTypeFunc Namespace Reference

Convenience functions for ScalarType. More...

Functions
bool	isInteger (ScalarType type)
bool	isUInteger (ScalarType type)
bool	isNumeric (ScalarType type)
bool	isPrimitive (ScalarType type)
ScalarType	getScalarType (const string &pvalue)
const char *	name (ScalarType t)
size_t	elementSize (ScalarType id)
	gives sizeof(T) where T depends on the scalar type id. More...
shared_vector< void >	allocArray (ScalarType id, size_t len)
	Allocate an untyped array based on ScalarType. More...
template<ScalarType ID>
shared_vector< typename ScalarTypeTraits< ID >::type >	allocArray (size_t len)
	Allocate an untyped array based on ScalarType. More...
epicsShareExtern ScalarType	getScalarType (std::string const &value)

Detailed Description

Convenience functions for ScalarType.

Function Documentation

epicsShareFunc shared_vector< void > epics::pvData::ScalarTypeFunc::allocArray	(	ScalarType	id,
		size_t	len
	)

Allocate an untyped array based on ScalarType.

Definition at line 104 of file TypeFunc.cpp.

    {
        switch(id) {
#define OP(ENUM, TYPE) case ENUM: return static_shared_vector_cast<void>(shared_vector<TYPE>(len))
        OP(pvBoolean, boolean);
        OP(pvUByte, uint8);
        OP(pvByte, int8);
        OP(pvUShort, uint16);
        OP(pvShort, int16);
        OP(pvUInt, uint32);
        OP(pvInt, int32);
        OP(pvULong, uint64);
        OP(pvLong, int64);
        OP(pvFloat, float);
        OP(pvDouble, double);
        OP(pvString, string);
#undef OP
        default:
            throw std::bad_alloc();
        }
    }

template<ScalarType ID>

shared_vector<typename ScalarTypeTraits<ID>::type> epics::pvData::ScalarTypeFunc::allocArray ( size_t  len )

inline

Allocate an untyped array based on ScalarType.

Definition at line 955 of file sharedVector.h.

    {
        shared_vector<void> raw(allocArray(ID, len));
        return static_shared_vector_cast<typename ScalarTypeTraits<ID>::type>(raw);
    }

epicsShareExtern size_t epics::pvData::ScalarTypeFunc::elementSize

(

ScalarType

id

)

gives sizeof(T) where T depends on the scalar type id.

Definition at line 82 of file TypeFunc.cpp.

    {
        switch(id) {
#define OP(ENUM, TYPE) case ENUM: return sizeof(TYPE)
            OP(pvBoolean, boolean);
            OP(pvUByte, uint8);
            OP(pvByte, int8);
            OP(pvUShort, uint16);
            OP(pvShort, int16);
            OP(pvUInt, uint32);
            OP(pvInt, int32);
            OP(pvULong, uint64);
            OP(pvLong, int64);
            OP(pvFloat, float);
            OP(pvDouble, double);
            OP(pvString, string);
#undef OP
        default:
            THROW_EXCEPTION2(std::invalid_argument, "error unknown ScalarType");
        }
    }

ScalarType epics::pvData::ScalarTypeFunc::getScalarType

(

const string &

pvalue

)

Definition at line 69 of file TypeFunc.cpp.

                                                   {
        for(size_t i=0; i<NELEMENTS(names); i++)
            if(pvalue==names[i])
                return ScalarType(i);
        THROW_EXCEPTION2(std::invalid_argument, "error unknown ScalarType");
    }

epicsShareExtern ScalarType epics::pvData::ScalarTypeFunc::getScalarType

(

std::string const &

value

)

Get the scalarType for value.

Parameters

value

The name of the scalar type.

Returns

The scalarType. An exception is thrown if the name is not the name of a scalar type.

epicsShareExtern bool epics::pvData::ScalarTypeFunc::isInteger

(

ScalarType

scalarType

)

Is the type an integer, i.e. is it one of byte,...ulong

Parameters

scalarType

The type.

Returns

(false,true) if the scalarType is an integer.

Definition at line 43 of file TypeFunc.cpp.

                                    {
        if(type>=pvByte && type<=pvULong) return true;
        return false;
    }

epicsShareExtern bool epics::pvData::ScalarTypeFunc::isNumeric

(

ScalarType

scalarType

)

Is the type numeric, i.e. is it one of byte,...,double

Parameters

scalarType

The type.

Returns

(false,true) if the scalarType is a numeric

Definition at line 53 of file TypeFunc.cpp.

                                    {
        if(type>=pvByte && type<=pvDouble) return true;
        return false;
    }

epicsShareExtern bool epics::pvData::ScalarTypeFunc::isPrimitive

(

ScalarType

scalarType

)

Is the type primitive, i.e. not string

Parameters

scalarType

The type.

Returns

(false,true) if the scalarType is primitive.

Definition at line 58 of file TypeFunc.cpp.

                                      {
        if(type>=pvBoolean && type<=pvDouble) return true;
        return false;
    }

epicsShareExtern bool epics::pvData::ScalarTypeFunc::isUInteger

(

ScalarType

scalarType

)

Is the type an unsigned integer, i.e. is it one of ubyte,...ulong

Parameters

scalarType

The type.

Returns

(false,true) if the scalarType is an integer.

Definition at line 48 of file TypeFunc.cpp.

                                     {
        if(type>=pvUByte && type<=pvULong) return true;
        return false;
    }

epicsShareExtern const char * epics::pvData::ScalarTypeFunc::name

(

ScalarType

scalarType

)

Get a name for the scalarType.

Parameters

scalarType

The type.

Returns

The name for the scalarType.

Definition at line 76 of file TypeFunc.cpp.

                                   {
        if (t<pvBoolean || t>pvString)
            THROW_EXCEPTION2(std::invalid_argument, "error unknown ScalarType");
        return names[t];
    }