epics::nt::NTNameValue Class Reference

Convenience Class for NTNameValue. More...

#include "ntnameValue.h"

Public Member Functions
	POINTER_DEFINITIONS (NTNameValue)
bool	isValid ()
	~NTNameValue ()
bool	attachTimeStamp (epics::pvData::PVTimeStamp &pvTimeStamp) const
bool	attachAlarm (epics::pvData::PVAlarm &pvAlarm) const
epics::pvData::PVStructurePtr	getPVStructure () const
epics::pvData::PVStringPtr	getDescriptor () const
epics::pvData::PVStructurePtr	getTimeStamp () const
epics::pvData::PVStructurePtr	getAlarm () const
epics::pvData::PVStringArrayPtr	getName () const
epics::pvData::PVFieldPtr	getValue () const
template<typename PVT >
std::tr1::shared_ptr< PVT >	getValue () const

Static Public Member Functions
static shared_pointer	wrap (epics::pvData::PVStructurePtr const &pvStructure)
static shared_pointer	wrapUnsafe (epics::pvData::PVStructurePtr const &pvStructure)
static bool	is_a (epics::pvData::StructureConstPtr const &structure)
static bool	is_a (epics::pvData::PVStructurePtr const &pvStructure)
static bool	isCompatible (epics::pvData::StructureConstPtr const &structure)
static bool	isCompatible (epics::pvData::PVStructurePtr const &pvStructure)
static NTNameValueBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTNameValueBuilder

Detailed Description

Convenience Class for NTNameValue.

Author

mrk

Definition at line 128 of file ntnameValue.h.

Constructor & Destructor Documentation

epics::nt::NTNameValue::~NTNameValue ( )

inline

Destructor.

Definition at line 227 of file ntnameValue.h.

{}

Member Function Documentation

bool epics::nt::NTNameValue::attachAlarm

(

epics::pvData::PVAlarm &

pvAlarm

)

const

Attaches a PVAlarm to the wrapped PVStructure. Does nothing if no alarm field.

Parameters

pvAlarm

the PVAlarm that will be attached.

Returns

true if the operation was successfull (i.e. this instance has an alarm field), otherwise false.

Definition at line 180 of file ntnameValue.cpp.

{
    PVStructurePtr al = getAlarm();
    if (al)
        return pvAlarm.attach(al);
    else
        return false;
}

bool epics::nt::NTNameValue::attachTimeStamp

(

epics::pvData::PVTimeStamp &

pvTimeStamp

)

const

Attaches a PVTimeStamp to the wrapped PVStructure. Does nothing if no timeStamp field.

Parameters

pvTimeStamp

the PVTimeStamp that will be attached.

Returns

true if the operation was successfull (i.e. this instance has a timeStamp field), otherwise false.

Definition at line 171 of file ntnameValue.cpp.

{
    PVStructurePtr ts = getTimeStamp();
    if (ts)
        return pvTimeStamp.attach(ts);
    else
        return false;
}

NTNameValueBuilderPtr epics::nt::NTNameValue::createBuilder ( )

static

Creates an NTNameValue builder instance.

Returns

builder instance.

Definition at line 166 of file ntnameValue.cpp.

{
    return NTNameValueBuilderPtr(new detail::NTNameValueBuilder());
}

PVStructurePtr epics::nt::NTNameValue::getAlarm

(

)

const

Returns the alarm field.

Returns

the alarm field or null if no alarm field.

Definition at line 204 of file ntnameValue.cpp.

{
    return pvNTNameValue->getSubField<PVStructure>("alarm");
}

PVStringPtr epics::nt::NTNameValue::getDescriptor

(

)

const

Returns the descriptor field.

Returns

the descriptor field or null if no descriptor field.

Definition at line 194 of file ntnameValue.cpp.

{
    return pvNTNameValue->getSubField<PVString>("descriptor");
}

PVStringArrayPtr epics::nt::NTNameValue::getName

(

)

const

Returns the name array field.

Returns

The PVStringArray for the name.

Definition at line 209 of file ntnameValue.cpp.

{
    return pvNTNameValue->getSubField<PVStringArray>("name");
}

PVStructurePtr epics::nt::NTNameValue::getPVStructure

(

)

const

Returns the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 189 of file ntnameValue.cpp.

{
    return pvNTNameValue;
}

PVStructurePtr epics::nt::NTNameValue::getTimeStamp

(

)

const

Returns the timeStamp field.

Returns

the timStamp field or null if no timeStamp field.

Definition at line 199 of file ntnameValue.cpp.

{
    return pvNTNameValue->getSubField<PVStructure>("timeStamp");
}

PVFieldPtr epics::nt::NTNameValue::getValue

(

)

const

Returns the value array field.

Returns

The PVField for the value.

Definition at line 214 of file ntnameValue.cpp.

{
    return pvNTNameValue->getSubField("value");
}

template<typename PVT >

std::tr1::shared_ptr<PVT> epics::nt::NTNameValue::getValue ( ) const

inline

Returns the value array field of a specified expected type (e.g. PVDoubleArray).

Template Parameters

PVT	The expected type of the value field which should be be PVScalarArray or a derived class.

Returns

The PVT array for the value.

Definition at line 289 of file ntnameValue.h.

    {
        epics::pvData::PVFieldPtr pvField = getValue();
        if (pvField.get())
            return std::tr1::dynamic_pointer_cast<PVT>(pvField);
        else
            return std::tr1::shared_ptr<PVT>();
    }

bool epics::nt::NTNameValue::is_a ( epics::pvData::StructureConstPtr const &  structure )

static

Returns whether the specified Structure reports to be a compatible NTNameValue.

Checks if the specified Structure reports compatibility with this version of NTNameValue through its type ID, including checking version numbers. The return value does not depend on whether the structure is actually compatible in terms of its introspection type.

Parameters

structure

the Structure to test.

Returns

(false,true) if the specified Structure (is not, is) a compatible NTNameValue.

Definition at line 127 of file ntnameValue.cpp.

{
    return NTUtils::is_a(structure->getID(), URI);
}

bool epics::nt::NTNameValue::is_a ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Returns whether the specified PVStructure reports to be a compatible NTNameValue.

Checks if the specified PVStructure reports compatibility with this version of NTNameValue through its type ID, including checking version numbers. The return value does not depend on whether the structure is actually compatible in terms of its introspection type

Parameters

pvStructure

The PVStructure to test.

Returns

(false,true) if the specified PVStructure (is not, is) a compatible NTNameValue.

Definition at line 132 of file ntnameValue.cpp.

{
    return is_a(pvStructure->getStructure());
}

bool epics::nt::NTNameValue::isCompatible ( epics::pvData::StructureConstPtr const &  structure )

static

Returns whether the specified Structure is compatible with NTNameValue.

Checks if the specified PVStructure is compatible with this version of NTNameValue through the introspection interface.

Parameters

structure

the Structure to test.

Returns

(false,true) if the specified Structure (is not, is) a compatible NTNameValue.

Definition at line 137 of file ntnameValue.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

    return result
        .is<Structure>()
        .has<ScalarArray>("name")
        .has<ScalarArray>("value")
        .maybeHas<Scalar>("descriptor")
        .maybeHas<&NTField::isAlarm, Structure>("alarm")
        .maybeHas<&NTField::isTimeStamp, Structure>("timeStamp")
        .valid();
}

bool epics::nt::NTNameValue::isCompatible ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Returns whether the specified PVStructure is compatible with NTNameValue.

Checks if the specified PVStructure is compatible with this version of NTNameValue through the introspection interface.

Parameters

pvStructure

the PVStructure to test

Returns

(false,true) if the specified PVStructure (is not, is) a compatible NTNameValue

Definition at line 154 of file ntnameValue.cpp.

{
    if(!pvStructure) return false;

    return isCompatible(pvStructure->getStructure());
}

bool epics::nt::NTNameValue::isValid

(

)

Returns whether the wrapped PVStructure is valid with respect to this version of NTNameValue.

Unlike isCompatible(), isValid() may perform checks on the value data as well as the introspection data.

Returns

(false,true) if the wrapped PVStructure (is not, is) a valid NTNameValue

Definition at line 161 of file ntnameValue.cpp.

{
    return (getValue<PVScalarArray>()->getLength() == getName()->getLength());
}

epics::nt::NTNameValue::POINTER_DEFINITIONS

(

NTNameValue

)

NTNameValue::shared_pointer epics::nt::NTNameValue::wrap ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Creates an NTNameValue wrapping the specified PVStructure if the latter is compatible.

Checks the supplied PVStructure is compatible with NTNameValue and if so returns an NTNameValue which wraps it. This method will return null if the structure is is not compatible or is null.

Parameters

pvStructure

the PVStructure to be wrapped.

Returns

NTNameValue instance wrapping pvStructure on success, null otherwise.

Definition at line 116 of file ntnameValue.cpp.

{
    if(!isCompatible(pvStructure)) return shared_pointer();
    return wrapUnsafe(pvStructure);
}

NTNameValue::shared_pointer epics::nt::NTNameValue::wrapUnsafe ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Creates an NTNameValue wrapping the specified PVStructure, regardless of the latter's compatibility.

No checks are made as to whether the specified PVStructure is compatible with NTNameValue or is non-null.

Parameters

pvStructure

the PVStructure to be wrapped.

Returns

NTNameValue instance wrapping pvStructure.

Definition at line 122 of file ntnameValue.cpp.

{
    return shared_pointer(new NTNameValue(structure));
}

Friends And Related Function Documentation

friend class detail::NTNameValueBuilder

friend

Definition at line 301 of file ntnameValue.h.

Member Data Documentation

const std::string epics::nt::NTNameValue::URI

static

Definition at line 133 of file ntnameValue.h.

---

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

• modules/normativeTypes/src/pv/ntnameValue.h
• modules/normativeTypes/src/ntnameValue.cpp