normativeTypesCPP
Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
epics::nt::NTMatrix Class Reference

Convenience Class for NTMatrix. More...

#include <ntmatrix.h>

Public Member Functions

 POINTER_DEFINITIONS (NTMatrix)
 
bool isValid ()
 
 ~NTMatrix ()
 
bool attachTimeStamp (epics::pvData::PVTimeStamp &pvTimeStamp) const
 
bool attachAlarm (epics::pvData::PVAlarm &pvAlarm) const
 
bool attachDisplay (epics::pvData::PVDisplay &pvDisplay) 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::PVDoubleArrayPtr getValue () const
 
epics::pvData::PVIntArrayPtr getDim () 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 NTMatrixBuilderPtr createBuilder ()
 

Static Public Attributes

static const std::string URI
 

Friends

class detail::NTMatrixBuilder
 

Detailed Description

Convenience Class for NTMatrix.

Author
dgh

Definition at line 134 of file ntmatrix.h.

Constructor & Destructor Documentation

◆ ~NTMatrix()

epics::nt::NTMatrix::~NTMatrix ( )
inline

Destructor.

Definition at line 235 of file ntmatrix.h.

Member Function Documentation

◆ attachAlarm()

bool epics::nt::NTMatrix::attachAlarm ( epics::pvData::PVAlarm &  pvAlarm) const

Attaches a PVAlarm to the wrapped PVStructure. Does nothing if no alarm field.

Parameters
pvAlarmthe 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 207 of file ntmatrix.cpp.

◆ attachDisplay()

bool epics::nt::NTMatrix::attachDisplay ( epics::pvData::PVDisplay &  pvDisplay) const

Attaches a PVDisplay to the wrapped PVStructure. Does nothing if no display.

Parameters
pvDisplaythe 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 216 of file ntmatrix.cpp.

◆ attachTimeStamp()

bool epics::nt::NTMatrix::attachTimeStamp ( epics::pvData::PVTimeStamp &  pvTimeStamp) const

Attaches a PVTimeStamp to the wrapped PVStructure. Does nothing if no timeStamp field.

Parameters
pvTimeStampthe 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 198 of file ntmatrix.cpp.

◆ createBuilder()

NTMatrixBuilderPtr epics::nt::NTMatrix::createBuilder ( )
static

Creates an NTMatrix builder instance.

Returns
builder instance.

Definition at line 193 of file ntmatrix.cpp.

◆ getAlarm()

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

Returns the alarm field.

Returns
the alarm field or null if no such field.

Definition at line 240 of file ntmatrix.cpp.

◆ getDescriptor()

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

Returns the descriptor field.

Returns
the descriptor field or null if no such field.

Definition at line 230 of file ntmatrix.cpp.

◆ getDim()

PVIntArrayPtr epics::nt::NTMatrix::getDim ( ) const

Returns the dim field.

Returns
the dim field or or null if no such field.

Definition at line 255 of file ntmatrix.cpp.

◆ getDisplay()

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

Returns the display field.

Returns
the display field or null if no such field.

Definition at line 245 of file ntmatrix.cpp.

◆ getPVStructure()

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

Get the PVStructure wrapped by this instance.

Returns
the PVStructure wrapped by this instance.

Definition at line 225 of file ntmatrix.cpp.

◆ getTimeStamp()

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

Returns the timeStamp field.

Returns
the timStamp field or null if no such field.

Definition at line 235 of file ntmatrix.cpp.

◆ getValue()

PVDoubleArrayPtr epics::nt::NTMatrix::getValue ( ) const

Returns the value field.

Returns
the value field.

Definition at line 250 of file ntmatrix.cpp.

◆ is_a() [1/2]

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

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

Checks if the specified Structure reports compatibility with this version of NTMatrix 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
structurethe structure to test
Returns
(false,true) if the specified Structure (is not, is) a compatible NTMatrix

◆ is_a() [2/2]

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

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

Checks if the specified PVStructure reports compatibility with this version of NTMatrix 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
pvStructurethe PVStructure to test
Returns
(false,true) if the specified PVStructure (is not, is) a compatible NTMatrix

◆ isCompatible() [1/2]

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

Returns whether the specified Structure is compatible with NTMatrix.

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

Parameters
structurethe Structure to test
Returns
(false,true) if the specified Structure (is not, is) a compatible NTMatrix

◆ isCompatible() [2/2]

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

Returns whether the specified PVStructure is compatible with NTMatrix.

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

Parameters
pvStructurethe PVStructure to test
Returns
(false,true) if the specified PVStructure (is not, is) a compatible NTMatrix

◆ isValid()

bool epics::nt::NTMatrix::isValid ( )

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

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 NTMatrix

Definition at line 167 of file ntmatrix.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::NTMatrix::POINTER_DEFINITIONS ( NTMatrix  )

◆ wrap()

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

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

Checks the supplied PVStructure is compatible with NTMatrix and if so returns an NTMatrix which wraps it. This method will return null if the structure is is not compatible or is null.

Parameters
pvStructurethe PVStructure to be wrapped
Returns
NTMatrix instance wrapping pvStructure on success, null otherwise

Definition at line 121 of file ntmatrix.cpp.

◆ wrapUnsafe()

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

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

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

Parameters
pvStructurethe PVStructure to be wrapped
Returns
NTMatrix instance wrapping pvStructure

Definition at line 127 of file ntmatrix.cpp.

References epics::nt::Result::is(), and epics::nt::Result::maybeHas().

Friends And Related Function Documentation

◆ detail::NTMatrixBuilder

friend class detail::NTMatrixBuilder
friend

Definition at line 308 of file ntmatrix.h.

Member Data Documentation

◆ URI

const std::string epics::nt::NTMatrix::URI
static

Definition at line 139 of file ntmatrix.h.


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