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

Convenience Class for NTNDArray. More...

#include <ntndarray.h>

Public Member Functions

 POINTER_DEFINITIONS (NTNDArray)
 
bool isValid ()
 
 ~NTNDArray ()
 
bool attachTimeStamp (epics::pvData::PVTimeStamp &pvTimeStamp) const
 
bool attachDataTimeStamp (epics::pvData::PVTimeStamp &pvTimeStamp) const
 
bool attachAlarm (epics::pvData::PVAlarm &pvAlarm) const
 
epics::pvData::PVStructurePtr getPVStructure () const
 
epics::pvData::PVUnionPtr getValue () const
 
epics::pvData::PVStructurePtr getCodec () const
 
epics::pvData::PVLongPtr getCompressedDataSize () const
 
epics::pvData::PVLongPtr getUncompressedDataSize () const
 
epics::pvData::PVStructureArrayPtr getDimension () const
 
epics::pvData::PVIntPtr getUniqueId () const
 
epics::pvData::PVStructurePtr getDataTimeStamp () const
 
epics::pvData::PVStructureArrayPtr getAttribute () const
 
epics::pvData::PVStringPtr getDescriptor () const
 
epics::pvData::PVStructurePtr getTimeStamp () const
 
epics::pvData::PVStructurePtr getAlarm () const
 
bool attachDisplay (epics::pvData::PVDisplay &pvDisplay) const
 
epics::pvData::PVStructurePtr getDisplay () 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 NTNDArrayBuilderPtr createBuilder ()
 

Static Public Attributes

static const std::string URI
 

Friends

class detail::NTNDArrayBuilder
 

Detailed Description

Convenience Class for NTNDArray.

Author
dgh

Definition at line 128 of file ntndarray.h.

Constructor & Destructor Documentation

◆ ~NTNDArray()

epics::nt::NTNDArray::~NTNDArray ( )
inline

Destructor.

Definition at line 228 of file ntndarray.h.

Member Function Documentation

◆ attachAlarm()

bool epics::nt::NTNDArray::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 399 of file ntndarray.cpp.

◆ attachDataTimeStamp()

bool epics::nt::NTNDArray::attachDataTimeStamp ( epics::pvData::PVTimeStamp &  pvTimeStamp) const

Attaches a pvTimeStamp to dataTimeStamp field.

Parameters
pvTimeStampThe pvTimeStamp that will be attached. Does nothing if no timeStamp.
Returns
true if the operation was successfull (i.e. this instance has a timeStamp field), otherwise false.

Definition at line 390 of file ntndarray.cpp.

◆ attachDisplay()

bool epics::nt::NTNDArray::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 408 of file ntndarray.cpp.

◆ attachTimeStamp()

bool epics::nt::NTNDArray::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 381 of file ntndarray.cpp.

◆ createBuilder()

NTNDArrayBuilderPtr epics::nt::NTNDArray::createBuilder ( )
static

Creates an NTNDArrayBuilder instance

Returns
builder instance.

Definition at line 375 of file ntndarray.cpp.

◆ getAlarm()

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

Returns the alarm field.

Returns
the alarm field or null if no alarm field.

Definition at line 472 of file ntndarray.cpp.

◆ getAttribute()

PVStructureArrayPtr epics::nt::NTNDArray::getAttribute ( ) const

Returns the attribute field.

Returns
the attribute field.

Definition at line 457 of file ntndarray.cpp.

◆ getCodec()

PVStructurePtr epics::nt::NTNDArray::getCodec ( ) const

Returns the codec field.

Returns
the codec field.

Definition at line 427 of file ntndarray.cpp.

◆ getCompressedDataSize()

PVLongPtr epics::nt::NTNDArray::getCompressedDataSize ( ) const

Returns the compressedDataSize field.

Returns
the compressedDataSize field.

Definition at line 432 of file ntndarray.cpp.

◆ getDataTimeStamp()

PVStructurePtr epics::nt::NTNDArray::getDataTimeStamp ( ) const

Returns the dataTimeStamp field.

Returns
the dataTimeStamp field.

Definition at line 452 of file ntndarray.cpp.

◆ getDescriptor()

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

Returns the descriptor field.

Returns
the descriptor field or null if no descriptor field.

Definition at line 462 of file ntndarray.cpp.

◆ getDimension()

PVStructureArrayPtr epics::nt::NTNDArray::getDimension ( ) const

Returns the dimension field.

Returns
the dimension field.

Definition at line 442 of file ntndarray.cpp.

◆ getDisplay()

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

Returns the display field.

Returns
PVStructurePtr or null if no alarm field.

Definition at line 477 of file ntndarray.cpp.

◆ getPVStructure()

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

Returns the PVStructure wrapped by this instance.

Returns
the PVStructure wrapped by this instance.

Definition at line 417 of file ntndarray.cpp.

◆ getTimeStamp()

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

Returns the timeStamp field.

Returns
the timStamp field or null if no timeStamp field.

Definition at line 467 of file ntndarray.cpp.

◆ getUncompressedDataSize()

PVLongPtr epics::nt::NTNDArray::getUncompressedDataSize ( ) const

Returns the uncompressedDataSize field.

Returns
the uncompressedDataSize field.

Definition at line 437 of file ntndarray.cpp.

◆ getUniqueId()

PVIntPtr epics::nt::NTNDArray::getUniqueId ( ) const

Returns the uniqueId field.

Returns
the uniqueId field.

Definition at line 447 of file ntndarray.cpp.

◆ getValue()

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

Returns the value field. Returns the value field.

Definition at line 422 of file ntndarray.cpp.

◆ is_a() [1/2]

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

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

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

◆ is_a() [2/2]

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

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

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

◆ isCompatible() [1/2]

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

Returns whether the specified Structure is compatible with NTNDArray.

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

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

◆ isCompatible() [2/2]

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

Returns whether the specified PVStructure is compatible with NTNDArray.

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

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

◆ isValid()

bool epics::nt::NTNDArray::isValid ( )

Returns whether the wrapped PVStructure is valid with respect to 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 NTNDArray

Definition at line 287 of file ntndarray.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::NTNDArray::POINTER_DEFINITIONS ( NTNDArray  )

◆ wrap()

NTNDArray::shared_pointer epics::nt::NTNDArray::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
pvStructurethe PVStructure to be wrapped
Returns
NTScalarArray instance wrapping pvStructure on success, null otherwise

Definition at line 200 of file ntndarray.cpp.

◆ wrapUnsafe()

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

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

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

Parameters
pvStructurethe PVStructure to be wrapped
Returns
NTNDArray instance wrapping pvStructure

Definition at line 206 of file ntndarray.cpp.

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

Friends And Related Function Documentation

◆ detail::NTNDArrayBuilder

friend class detail::NTNDArrayBuilder
friend

Definition at line 349 of file ntndarray.h.

Member Data Documentation

◆ URI

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

Definition at line 133 of file ntndarray.h.


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