epics::nt::NTContinuum Class Reference

Convenience Class for NTContinuum. More...

#include "ntcontinuum.h"

Public Member Functions
	POINTER_DEFINITIONS (NTContinuum)
bool	isValid ()
	~NTContinuum ()
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::PVDoubleArrayPtr	getBase () const
epics::pvData::PVDoubleArrayPtr	getValue () const
epics::pvData::PVStringArrayPtr	getUnits () 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 NTContinuumBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTContinuumBuilder

Detailed Description

Convenience Class for NTContinuum.

Author

dgh

Definition at line 118 of file ntcontinuum.h.

Constructor & Destructor Documentation

epics::nt::NTContinuum::~NTContinuum ( )

inline

Destructor.

Definition at line 219 of file ntcontinuum.h.

{}

Member Function Documentation

bool epics::nt::NTContinuum::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 170 of file ntcontinuum.cpp.

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

bool epics::nt::NTContinuum::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 161 of file ntcontinuum.cpp.

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

NTContinuumBuilderPtr epics::nt::NTContinuum::createBuilder ( )

static

Creates an NTContinuum builder instance.

Returns

builder instance.

Definition at line 156 of file ntcontinuum.cpp.

{
    return NTContinuumBuilderPtr(new detail::NTContinuumBuilder());
}

PVStructurePtr epics::nt::NTContinuum::getAlarm

(

)

const

Returns the alarm field.

Returns

the alarm field or null if no such field.

Definition at line 194 of file ntcontinuum.cpp.

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

PVDoubleArrayPtr epics::nt::NTContinuum::getBase

(

)

const

Returns the base field.

Returns

the base field.

Definition at line 199 of file ntcontinuum.cpp.

{
    return pvNTContinuum->getSubField<PVDoubleArray>("base");
}

PVStringPtr epics::nt::NTContinuum::getDescriptor

(

)

const

Returns the descriptor field.

Returns

the descriptor field or null if no such field.

Definition at line 184 of file ntcontinuum.cpp.

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

PVStructurePtr epics::nt::NTContinuum::getPVStructure

(

)

const

Returns the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 179 of file ntcontinuum.cpp.

{
    return pvNTContinuum;
}

PVStructurePtr epics::nt::NTContinuum::getTimeStamp

(

)

const

Returns the timeStamp field.

Returns

the timStamp field or null if no such field.

Definition at line 189 of file ntcontinuum.cpp.

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

PVStringArrayPtr epics::nt::NTContinuum::getUnits

(

)

const

Returns the units field.

Returns

the units field.

Definition at line 209 of file ntcontinuum.cpp.

{
    return pvNTContinuum->getSubField<PVStringArray>("units");
}

PVDoubleArrayPtr epics::nt::NTContinuum::getValue

(

)

const

Returns the value field.

Returns

the value field.

Definition at line 204 of file ntcontinuum.cpp.

{
    return pvValue;
}

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

static

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

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

Definition at line 115 of file ntcontinuum.cpp.

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

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

static

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

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

Definition at line 120 of file ntcontinuum.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTContinuum.

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

Parameters

structure

the Structure to test

Returns

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

Definition at line 125 of file ntcontinuum.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

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

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

static

Returns whether the specified PVStructure is compatible with NTContinuum.

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

Parameters

pvStructure

the PVStructure to test

Returns

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

Definition at line 143 of file ntcontinuum.cpp.

{
    if(!pvStructure) return false;

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

bool epics::nt::NTContinuum::isValid

(

)

Returns whether the wrapped structure is valid with respect to this version of NTContinuum.

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 NTContinuum

Definition at line 150 of file ntcontinuum.cpp.

{
    return ((getUnits()->getLength()-1)*getBase()->getLength() ==
            getValue()->getLength());
}

epics::nt::NTContinuum::POINTER_DEFINITIONS

(

NTContinuum

)

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

static

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

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

NTContinuum instance wrapping pvStructure on success, null otherwise

Definition at line 104 of file ntcontinuum.cpp.

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

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

static

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

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

Parameters

pvStructure

the PVStructure to be wrapped

Returns

NTContinuum instance wrapping pvStructure.

Definition at line 110 of file ntcontinuum.cpp.

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

Friends And Related Function Documentation

friend class detail::NTContinuumBuilder

friend

Definition at line 284 of file ntcontinuum.h.

Member Data Documentation

const std::string epics::nt::NTContinuum::URI

static

Definition at line 123 of file ntcontinuum.h.

---

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

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