Convenience Class for NTNDArrayAttribute. More...

#include "ntndarrayAttribute.h"

Public Member Functions
	POINTER_DEFINITIONS (NTNDArrayAttribute)

bool	isValid ()

	~NTNDArrayAttribute ()

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::PVStringPtr	getName () const

epics::pvData::PVUnionPtr	getValue () const

epics::pvData::PVStringArrayPtr	getTags () const

epics::pvData::PVIntPtr	getSourceType () const

epics::pvData::PVStringPtr	getSource () 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 NTNDArrayAttributeBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTNDArrayAttributeBuilder

class	NTNDArray

Detailed Description

Convenience Class for NTNDArrayAttribute.

Author: dgh

Definition at line 125 of file ntndarrayAttribute.h.

Constructor & Destructor Documentation

epics::nt::NTNDArrayAttribute::~NTNDArrayAttribute ( )

inline

Destructor.

Definition at line 232 of file ntndarrayAttribute.h.

232 {}

Member Function Documentation

bool epics::nt::NTNDArrayAttribute::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 184 of file ntndarrayAttribute.cpp.

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

bool epics::nt::NTNDArrayAttribute::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 175 of file ntndarrayAttribute.cpp.

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

NTNDArrayAttributeBuilderPtr epics::nt::NTNDArrayAttribute::createBuilder ( )

static

Creates an NTNDArrayAttribute builder instance.

Returns: builder instance.

Definition at line 170 of file ntndarrayAttribute.cpp.

 {
     return NTNDArrayAttributeBuilderPtr(new detail::NTNDArrayAttributeBuilder());
 }

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

Returns the alarm field.

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

Definition at line 208 of file ntndarrayAttribute.cpp.

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

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

Returns the descriptor field.

Returns: the descriptor field.

Definition at line 198 of file ntndarrayAttribute.cpp.

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

PVStringPtr epics::nt::NTNDArrayAttribute::getName ( ) const

Returns the name field.

Returns: the name field.

Definition at line 214 of file ntndarrayAttribute.cpp.

 {
     return pvNTNDArrayAttribute->getSubField<PVString>("name");
 }

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

Returns the PVStructure wrapped by this instance.

Returns: the PVStructure wrapped by this instance.

Definition at line 193 of file ntndarrayAttribute.cpp.

 {
     return pvNTNDArrayAttribute;
 }

PVStringPtr epics::nt::NTNDArrayAttribute::getSource ( ) const

Returns the source field.

Returns: the source field.

Definition at line 234 of file ntndarrayAttribute.cpp.

 {
     return pvNTNDArrayAttribute->getSubField<PVString>("source");
 }

PVIntPtr epics::nt::NTNDArrayAttribute::getSourceType ( ) const

Returns the sourceType field.

Returns: the sourceType field.

Definition at line 229 of file ntndarrayAttribute.cpp.

 {
     return pvNTNDArrayAttribute->getSubField<PVInt>("sourceType");
 }

PVStringArrayPtr epics::nt::NTNDArrayAttribute::getTags ( ) const

Returns the tags field.

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

Definition at line 224 of file ntndarrayAttribute.cpp.

 {
     return pvNTNDArrayAttribute->getSubField<PVStringArray>("tags");
 }

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

Returns the timeStamp field.

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

Definition at line 203 of file ntndarrayAttribute.cpp.

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

PVUnionPtr epics::nt::NTNDArrayAttribute::getValue ( ) const

Returns the value field.

Returns: the value field.

Definition at line 219 of file ntndarrayAttribute.cpp.

 {
     return pvValue;
 }

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

static

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

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

Definition at line 127 of file ntndarrayAttribute.cpp.

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

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

static

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

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

Definition at line 132 of file ntndarrayAttribute.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTAttribute extended as required by NTNDArray.

Checks if the specified Structure is compatible with this version of NTAttribute extended as required by this version of NTNDArray through the introspection interface.

Parameters

structure the Structure to test

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

Definition at line 149 of file ntndarrayAttribute.cpp.

 {
     if (!structure)
         return false;
 
     Result result(structure);
     return isAttribute(result.is<Structure>()).valid();
 }

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

static

Returns whether the specified PVStructure is compatible with NTAttribute extended as required by NTNDArray.

Checks if the specified PVStructure is compatible with this version of NTAttribute extended as required by this version of NTNDArray through the introspection interface.

Parameters

pvStructure the PVStructure to test

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

Definition at line 158 of file ntndarrayAttribute.cpp.

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

bool epics::nt::NTNDArrayAttribute::isValid ( )

Returns whether the wrapped PVStructure is valid with respect to this version of NTAttribute extended as per this version of NTNDArray.

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 NTNDArrayAttribute

Definition at line 165 of file ntndarrayAttribute.cpp.

 {
     return true;
 }

epics::nt::NTNDArrayAttribute::POINTER_DEFINITIONS ( NTNDArrayAttribute )

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

static

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

Checks the supplied PVStructure is compatible with NTAttribute extended as required by NTNDArray and if so returns an NTNDArrayAttribute 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: NTAttribute instance wrapping pvStructure on success, null otherwise

Definition at line 116 of file ntndarrayAttribute.cpp.

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

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

static

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

No checks are made as to whether the specified PVStructure is compatible with NTAttribute extended as required by NTNDArray or is non-null.

Parameters

pvStructure the PVStructure to be wrapped

Returns: NTAttribute instance wrapping pvStructure

Definition at line 122 of file ntndarrayAttribute.cpp.

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

Friends And Related Function Documentation

friend class detail::NTNDArrayAttributeBuilder

friend

Definition at line 311 of file ntndarrayAttribute.h.

friend class NTNDArray

friend

Definition at line 312 of file ntndarrayAttribute.h.

Member Data Documentation

const std::string epics::nt::NTNDArrayAttribute::URI

static

Definition at line 130 of file ntndarrayAttribute.h.

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

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