Convenience Class for NTScalarArray. More...

#include "ntscalarArray.h"

Public Member Functions
	POINTER_DEFINITIONS (NTScalarArray)

bool	isValid ()

	~NTScalarArray ()

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 NTScalarArrayBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTScalarArrayBuilder

Detailed Description

Convenience Class for NTScalarArray.

Author: mrk

Definition at line 153 of file ntscalarArray.h.

Constructor & Destructor Documentation

epics::nt::NTScalarArray::~NTScalarArray ( )

inline

Destructor.

Definition at line 253 of file ntscalarArray.h.

253 {}

Member Function Documentation

bool epics::nt::NTScalarArray::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 208 of file ntscalarArray.cpp.

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

bool epics::nt::NTScalarArray::attachControl ( epics::pvData::PVControl & pvControl ) const

Attaches an pvControl.

Parameters

pvControl The pvControl that will be attached. Does nothing if no control field.

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

Definition at line 226 of file ntscalarArray.cpp.

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

bool epics::nt::NTScalarArray::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 217 of file ntscalarArray.cpp.

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

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

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

NTScalarArrayBuilderPtr epics::nt::NTScalarArray::createBuilder ( )

static

Creates an NTScalarArray builder instance.

Returns: builder instance.

Definition at line 194 of file ntscalarArray.cpp.

 {
     return NTScalarArrayBuilderPtr(new detail::NTScalarArrayBuilder());
 }

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

Returns the alarm field.

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

Definition at line 250 of file ntscalarArray.cpp.

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

PVStructurePtr epics::nt::NTScalarArray::getControl ( ) const

Returns the control.

Returns: PVStructurePtr which may be null.

Definition at line 260 of file ntscalarArray.cpp.

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

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

Returns the descriptor field.

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

Definition at line 240 of file ntscalarArray.cpp.

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

PVStructurePtr epics::nt::NTScalarArray::getDisplay ( ) const

Returns the display.

Returns: PVStructurePtr which may be null.

Definition at line 255 of file ntscalarArray.cpp.

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

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

Returns the PVStructure wrapped by this instance.

Returns: the PVStructure wrapped by this instance.

Definition at line 235 of file ntscalarArray.cpp.

 {
     return pvNTScalarArray;
 }

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

Returns the timeStamp field.

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

Definition at line 245 of file ntscalarArray.cpp.

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

PVFieldPtr epics::nt::NTScalarArray::getValue ( ) const

Returns the value field.

Returns: The PVField for the values.

Definition at line 265 of file ntscalarArray.cpp.

 {
     return pvValue;
 }

template<typename PVT >

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

inline

Returns the value field of a specified 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 value field or null if it is not of the expected type.

Definition at line 336 of file ntscalarArray.h.

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

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

static

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

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

Definition at line 154 of file ntscalarArray.cpp.

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

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

static

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

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

Definition at line 159 of file ntscalarArray.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTScalarArray.

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

Parameters

structure the Structure to test.

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

Definition at line 164 of file ntscalarArray.cpp.

 {
     if (!structure)
         return false;
 
     Result result(structure);
 
     return result
         .is<Structure>()
         .has<ScalarArray>("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::NTScalarArray::isCompatible ( epics::pvData::PVStructurePtr const & pvStructure )

static

Returns whether the specified PVStructure is compatible with NTScalarArray.

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

Parameters

pvStructure the PVStructure to test

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

Definition at line 182 of file ntscalarArray.cpp.

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

bool epics::nt::NTScalarArray::isValid ( )

Returns whether the wrapped PVStructure is a valid NTScalarArray.

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 NTScalarArray.

Definition at line 189 of file ntscalarArray.cpp.

 {
     return true;
 }

epics::nt::NTScalarArray::POINTER_DEFINITIONS ( NTScalarArray )

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

static

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

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

Definition at line 143 of file ntscalarArray.cpp.

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

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

static

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

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

Parameters

pvStructure the PVStructure to be wrapped

Returns: NTScalarArray instance wrapping pvStructure

Definition at line 149 of file ntscalarArray.cpp.

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

Friends And Related Function Documentation

friend class detail::NTScalarArrayBuilder

friend

Definition at line 346 of file ntscalarArray.h.

Member Data Documentation

const std::string epics::nt::NTScalarArray::URI

static

Definition at line 158 of file ntscalarArray.h.

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

modules/normativeTypes/src/pv/ntscalarArray.h
modules/normativeTypes/src/ntscalarArray.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