epics::nt::NTHistogram Class Reference

Convenience Class for NTHistogram. More...

#include "nthistogram.h"

Public Member Functions
	POINTER_DEFINITIONS (NTHistogram)
bool	isValid ()
	~NTHistogram ()
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	getRanges () const
epics::pvData::PVScalarArrayPtr	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 NTHistogramBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTHistogramBuilder

Detailed Description

Convenience Class for NTHistogram.

Author

dgh

Definition at line 128 of file nthistogram.h.

Constructor & Destructor Documentation

epics::nt::NTHistogram::~NTHistogram ( )

inline

Destructor.

Definition at line 229 of file nthistogram.h.

{}

Member Function Documentation

bool epics::nt::NTHistogram::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 181 of file nthistogram.cpp.

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

bool epics::nt::NTHistogram::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 172 of file nthistogram.cpp.

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

NTHistogramBuilderPtr epics::nt::NTHistogram::createBuilder ( )

static

Creates an NTHistogram builder instance.

Returns

builder instance.

Definition at line 167 of file nthistogram.cpp.

{
    return NTHistogramBuilderPtr(new detail::NTHistogramBuilder());
}

PVStructurePtr epics::nt::NTHistogram::getAlarm

(

)

const

Returns the alarm field.

Returns

the alarm field or null if no such field.

Definition at line 205 of file nthistogram.cpp.

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

PVStringPtr epics::nt::NTHistogram::getDescriptor

(

)

const

Returns the descriptor field.

Returns

the descriptor field or null if no such field.

Definition at line 195 of file nthistogram.cpp.

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

PVStructurePtr epics::nt::NTHistogram::getPVStructure

(

)

const

Get the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 190 of file nthistogram.cpp.

{
    return pvNTHistogram;
}

PVDoubleArrayPtr epics::nt::NTHistogram::getRanges

(

)

const

Returns the ranges field.

Returns

the ranges field.

Definition at line 210 of file nthistogram.cpp.

{
    return pvNTHistogram->getSubField<PVDoubleArray>("ranges");
}

PVStructurePtr epics::nt::NTHistogram::getTimeStamp

(

)

const

Returns the timeStamp field.

Returns

the timStamp field or null if no such field.

Definition at line 200 of file nthistogram.cpp.

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

PVScalarArrayPtr epics::nt::NTHistogram::getValue

(

)

const

Returns the value field.

Returns

the value field.

Definition at line 215 of file nthistogram.cpp.

{
    return pvValue;
}

template<typename PVT >

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

inline

Returns the value field of a specified type (e.g. PVIntArray).

Template Parameters

PVT	the expected type of the value field which should be be PVShortArray, PVIntArray pr PVLongArray.

Returns

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

Definition at line 290 of file nthistogram.h.

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

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

static

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

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

Definition at line 128 of file nthistogram.cpp.

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

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

static

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

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

Definition at line 133 of file nthistogram.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTHistogram.

Checks whether the specified Structure is compatible with this version of NTHistogram through the introspection interface.

Parameters

structure

the Structure to test

Returns

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

Definition at line 138 of file nthistogram.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

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

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

static

Returns whether the specified PVStructure is compatible with NTHistogram.

Checks whether the specified PVStructure is compatible with this version of NTHistogram through the introspection interface.

Parameters

pvStructure

the PVStructure to test

Returns

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

Definition at line 155 of file nthistogram.cpp.

{
    if(!pvStructure.get()) return false;

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

bool epics::nt::NTHistogram::isValid

(

)

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

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 NTHistogram

Definition at line 162 of file nthistogram.cpp.

{
    return (getValue()->getLength()+1 == getRanges()->getLength());
}

epics::nt::NTHistogram::POINTER_DEFINITIONS

(

NTHistogram

)

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

static

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

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

NTHistogram instance wrapping pvStructure on success, null otherwise

Definition at line 117 of file nthistogram.cpp.

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

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

static

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

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

Parameters

pvStructure

the PVStructure to be wrapped.

Returns

NTHistogram instance wrapping pvStructure.

Definition at line 123 of file nthistogram.cpp.

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

Friends And Related Function Documentation

friend class detail::NTHistogramBuilder

friend

Definition at line 301 of file nthistogram.h.

Member Data Documentation

const std::string epics::nt::NTHistogram::URI

static

Definition at line 133 of file nthistogram.h.

---

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

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