epics::nt::NTScalar Class Reference

Convenience Class for NTScalar. More...

#include "ntscalar.h"

Public Member Functions
	POINTER_DEFINITIONS (NTScalar)
bool	isValid ()
	~NTScalar ()
bool	attachTimeStamp (epics::pvData::PVTimeStamp &pvTimeStamp) const
bool	attachAlarm (epics::pvData::PVAlarm &pvAlarm) const
bool	attachDisplay (epics::pvData::PVDisplay &pvDisplay) const
bool	attachControl (epics::pvData::PVControl &pvControl) const
epics::pvData::PVStructurePtr	getPVStructure () const
epics::pvData::PVStringPtr	getDescriptor () const
epics::pvData::PVStructurePtr	getTimeStamp () const
epics::pvData::PVStructurePtr	getAlarm () const
epics::pvData::PVStructurePtr	getDisplay () const
epics::pvData::PVStructurePtr	getControl () 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 NTScalarBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTScalarBuilder

Detailed Description

Convenience Class for NTScalar.

Author

mrk

Definition at line 144 of file ntscalar.h.

Constructor & Destructor Documentation

epics::nt::NTScalar::~NTScalar ( )

inline

Destructor.

Definition at line 245 of file ntscalar.h.

{}

Member Function Documentation

bool epics::nt::NTScalar::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 199 of file ntscalar.cpp.

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

bool epics::nt::NTScalar::attachControl

(

epics::pvData::PVControl &

pvControl

)

const

Attaches an PVControl to the wrapped PVStructure. Does nothing if no control field.

Parameters

pvControl

The PVControl that will be attached.

Returns

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

Definition at line 217 of file ntscalar.cpp.

{
    PVStructurePtr ctrl = getControl();
    if (ctrl)
        return pvControl.attach(ctrl);
    else
        return false;
}

bool epics::nt::NTScalar::attachDisplay

(

epics::pvData::PVDisplay &

pvDisplay

)

const

Attaches a PVDisplay to the wrapped PVStructure. Does nothing if no display field.

Parameters

pvDisplay

the PVDisplay that will be attached.

Returns

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

Definition at line 208 of file ntscalar.cpp.

{
    PVStructurePtr dp = getDisplay();
    if (dp)
        return pvDisplay.attach(dp);
    else
        return false;
}

bool epics::nt::NTScalar::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 190 of file ntscalar.cpp.

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

NTScalarBuilderPtr epics::nt::NTScalar::createBuilder ( )

static

Creates an NTScalar builder instance.

Returns

builder instance.

Definition at line 185 of file ntscalar.cpp.

{
    return NTScalarBuilderPtr(new detail::NTScalarBuilder());
}

PVStructurePtr epics::nt::NTScalar::getAlarm

(

)

const

Returns the alarm field.

Returns

the alarm field or null if no alarm field.

Definition at line 241 of file ntscalar.cpp.

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

PVStructurePtr epics::nt::NTScalar::getControl

(

)

const

Returns the control.

Returns

PVStructurePtr which may be null.

Definition at line 251 of file ntscalar.cpp.

{
    return pvNTScalar->getSubField<PVStructure>("control");
}

PVStringPtr epics::nt::NTScalar::getDescriptor

(

)

const

Returns the descriptor field.

Returns

the descriptor field or null if no descriptor field.

Definition at line 231 of file ntscalar.cpp.

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

PVStructurePtr epics::nt::NTScalar::getDisplay

(

)

const

Returns the display.

Returns

PVStructurePtr which may be null.

Definition at line 246 of file ntscalar.cpp.

{
    return pvNTScalar->getSubField<PVStructure>("display");
}

PVStructurePtr epics::nt::NTScalar::getPVStructure

(

)

const

Returns the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 226 of file ntscalar.cpp.

{
    return pvNTScalar;
}

PVStructurePtr epics::nt::NTScalar::getTimeStamp

(

)

const

Returns the timeStamp field.

Returns

the timStamp field or null if no timeStamp field.

Definition at line 236 of file ntscalar.cpp.

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

PVFieldPtr epics::nt::NTScalar::getValue

(

)

const

Returns the value field.

Returns

The PVField for the values.

Definition at line 256 of file ntscalar.cpp.

{
    return pvValue;
}

template<typename PVT >

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

inline

Returns the value field of a specified type (for example, PVDouble).

Template Parameters

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

Returns

the value field or null if it is not of the expected type.

Definition at line 328 of file ntscalar.h.

    {
        return std::tr1::dynamic_pointer_cast<PVT>(pvValue);
    }

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

static

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

Checks if the specified Structure reports compatibility with this version of NTScalar 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 NTScalar

Definition at line 145 of file ntscalar.cpp.

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

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

static

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

Checks if the specified PVStructure reports compatibility with this version of NTScalar 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 NTScalar

Definition at line 150 of file ntscalar.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTScalar.

Checks if the specified Structure is compatible with this version of NTScalar through the introspection interface.

Parameters

structure

the Structure to test

Returns

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

Definition at line 155 of file ntscalar.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

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

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

static

Returns whether the specified PVStructure is compatible with NTScalar.

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

Parameters

pvStructure

the PVStructure to test

Returns

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

Definition at line 173 of file ntscalar.cpp.

{
    if(!pvStructure) return false;

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

bool epics::nt::NTScalar::isValid

(

)

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

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

Returns

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

Definition at line 180 of file ntscalar.cpp.

{
    return true;
}

epics::nt::NTScalar::POINTER_DEFINITIONS

(

NTScalar

)

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

static

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

Checks the supplied PVStructure is compatible with NTScalar and if so returns an NTScalar 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

NTScalar instance wrapping pvStructure on success, null otherwise

Definition at line 134 of file ntscalar.cpp.

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

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

static

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

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

Parameters

pvStructure

the PVStructure to be wrapped

Returns

NTScalar instance wrapping pvStructure

Definition at line 140 of file ntscalar.cpp.

{
    return shared_pointer(new NTScalar(pvStructure));
}

Friends And Related Function Documentation

friend class detail::NTScalarBuilder

friend

Definition at line 338 of file ntscalar.h.

Member Data Documentation

const std::string epics::nt::NTScalar::URI

static

Definition at line 149 of file ntscalar.h.

---

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

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