Convenience Class for NTAggregate. More...

#include "ntaggregate.h"

Public Member Functions
	POINTER_DEFINITIONS (NTAggregate)

bool	isValid ()

	~NTAggregate ()

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::PVDoublePtr	getValue () const

epics::pvData::PVLongPtr	getN () const

epics::pvData::PVDoublePtr	getDispersion () const

epics::pvData::PVDoublePtr	getFirst () const

epics::pvData::PVStructurePtr	getFirstTimeStamp () const

epics::pvData::PVDoublePtr	getLast () const

epics::pvData::PVStructurePtr	getLastTimeStamp () const

epics::pvData::PVDoublePtr	getMax () const

epics::pvData::PVDoublePtr	getMin () 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 NTAggregateBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTAggregateBuilder

Detailed Description

Convenience Class for NTAggregate.

Author: dgh

Definition at line 166 of file ntaggregate.h.

Constructor & Destructor Documentation

epics::nt::NTAggregate::~NTAggregate ( )

inline

Destructor.

Definition at line 267 of file ntaggregate.h.

267 {}

Member Function Documentation

bool epics::nt::NTAggregate::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 247 of file ntaggregate.cpp.

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

bool epics::nt::NTAggregate::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 238 of file ntaggregate.cpp.

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

NTAggregateBuilderPtr epics::nt::NTAggregate::createBuilder ( )

static

Creates an NTAggregate builder instance.

Returns: builder instance.

Definition at line 233 of file ntaggregate.cpp.

 {
     return NTAggregateBuilderPtr(new detail::NTAggregateBuilder());
 }

PVStructurePtr epics::nt::NTAggregate::getAlarm ( ) const

Returns the alarm field.

Returns: the alarm field or null if no such field.

Definition at line 271 of file ntaggregate.cpp.

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

PVStringPtr epics::nt::NTAggregate::getDescriptor ( ) const

Returns the descriptor field.

Returns: the descriptor field or null if no such field.

Definition at line 261 of file ntaggregate.cpp.

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

PVDoublePtr epics::nt::NTAggregate::getDispersion ( ) const

Returns the dispersion field.

Returns: the dispersion or null if no such field.

Definition at line 286 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVDouble>("dispersion");
 }

PVDoublePtr epics::nt::NTAggregate::getFirst ( ) const

Returns the first field.

Returns: the first field or null if no such field.

Definition at line 291 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVDouble>("first");
 }

PVStructurePtr epics::nt::NTAggregate::getFirstTimeStamp ( ) const

Returns the firstTimeStamp field.

Returns: the firstTimeStamp field or null if no such field.

Definition at line 296 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVStructure>("firstTimeStamp");
 }

PVDoublePtr epics::nt::NTAggregate::getLast ( ) const

Returns the last field.

Returns: the last field or null if no such field.

Definition at line 301 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVDouble>("last");
 }

PVStructurePtr epics::nt::NTAggregate::getLastTimeStamp ( ) const

Returns the lastTimeStamp field.

Returns: the lastTimeStamp field or null if no such field.

Definition at line 306 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVStructure>("lastTimeStamp");
 }

PVDoublePtr epics::nt::NTAggregate::getMax ( ) const

Returns the max field.

Returns: the max field or null if no such field.

Definition at line 311 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVDouble>("max");
 }

PVDoublePtr epics::nt::NTAggregate::getMin ( ) const

Returns the min field.

Returns: the min field or null if no such field.

Definition at line 316 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVDouble>("min");
 }

PVLongPtr epics::nt::NTAggregate::getN ( ) const

Returns the N field.

Returns: the N field.

Definition at line 281 of file ntaggregate.cpp.

 {
     return pvNTAggregate->getSubField<PVLong>("N");
 }

PVStructurePtr epics::nt::NTAggregate::getPVStructure ( ) const

Returns the PVStructure wrapped by this instance.

Returns: the PVStructure wrapped by this instance.

Definition at line 256 of file ntaggregate.cpp.

 {
     return pvNTAggregate;
 }

PVStructurePtr epics::nt::NTAggregate::getTimeStamp ( ) const

Returns the timeStamp field.

Returns: the timStamp field or null if no such field.

Definition at line 266 of file ntaggregate.cpp.

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

PVDoublePtr epics::nt::NTAggregate::getValue ( ) const

Returns the value field.

Returns: the value field.

Definition at line 276 of file ntaggregate.cpp.

 {
     return pvValue;
 }

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

static

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

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

Definition at line 186 of file ntaggregate.cpp.

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

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

static

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

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

Definition at line 191 of file ntaggregate.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTAggregate.

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

Parameters

structure the Structure to test

Returns: (false,true) if the specified Structure (is not, is) a compatible NTAggregate

Definition at line 197 of file ntaggregate.cpp.

 {
     if (!structure)
         return false;
 
     Result result(structure);
 
     return result
         .is<Structure>()
         .has<Scalar>("value")
         .has<Scalar>("N")
         .maybeHas<Scalar>("dispersion")
         .maybeHas<Scalar>("first")
         .maybeHas<&NTField::isTimeStamp, Structure>("firstTimeStamp")
         .maybeHas<Scalar>("last")
         .maybeHas<&NTField::isTimeStamp, Structure>("lastTimeStamp")
         .maybeHas<Scalar>("max")
         .maybeHas<Scalar>("min")
         .maybeHas<Scalar>("descriptor")
         .maybeHas<&NTField::isAlarm, Structure>("alarm")
         .maybeHas<&NTField::isTimeStamp, Structure>("timeStamp")
         .valid();
 }

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

static

Returns whether the specified PVStructure is compatible with NTAggregate.

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

Parameters

pvStructure the PVStructure to test

Returns: (false,true) if the specified PVStructure (is not, is) a compatible NTAggregate

Definition at line 221 of file ntaggregate.cpp.

 {
     if(!pvStructure) return false;
 
     return isCompatible(pvStructure->getStructure());
 }

bool epics::nt::NTAggregate::isValid ( )

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

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

Returns: (false,true) if wrapped PVStructure a valid NTAggregate

Definition at line 228 of file ntaggregate.cpp.

 {
     return true;
 }

epics::nt::NTAggregate::POINTER_DEFINITIONS ( NTAggregate )

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

static

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

Checks the supplied PVStructure is compatible with NTAggregate and if so returns an NTAggregate 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: the NTAggregate instance on success, null otherwise

Definition at line 175 of file ntaggregate.cpp.

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

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

static

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

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

Parameters

pvStructure the PVStructure to be wrapped

Returns: the NTAggregate instance

Definition at line 181 of file ntaggregate.cpp.

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

Friends And Related Function Documentation

friend class detail::NTAggregateBuilder

friend

Definition at line 368 of file ntaggregate.h.

Member Data Documentation

const std::string epics::nt::NTAggregate::URI

static

Definition at line 171 of file ntaggregate.h.

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

modules/normativeTypes/src/pv/ntaggregate.h
modules/normativeTypes/src/ntaggregate.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation