Convenience Class for NTScalarMultiChannel.
More...
#include <ntscalarMultiChannel.h>
|
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 NTScalarMultiChannelBuilderPtr | createBuilder () |
|
|
static const std::string | URI |
|
Convenience Class for NTScalarMultiChannel.
- Author
- dgh
-
mrk
Definition at line 184 of file ntscalarMultiChannel.h.
◆ ~NTScalarMultiChannel()
epics::nt::NTScalarMultiChannel::~NTScalarMultiChannel |
( |
| ) |
|
|
inline |
◆ attachAlarm()
bool epics::nt::NTScalarMultiChannel::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 313 of file ntscalarMultiChannel.cpp.
◆ attachTimeStamp()
bool epics::nt::NTScalarMultiChannel::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 305 of file ntscalarMultiChannel.cpp.
◆ createBuilder()
◆ getAlarm()
epics::pvData::PVStructurePtr epics::nt::NTScalarMultiChannel::getAlarm |
( |
| ) |
const |
|
inline |
Returns the alarm field.
- Returns
- the alarm field or null if no such field.
Definition at line 325 of file ntscalarMultiChannel.h.
◆ getChannelName()
epics::pvData::PVStringArrayPtr epics::nt::NTScalarMultiChannel::getChannelName |
( |
| ) |
const |
|
inline |
Returns the field with the channelName of each channel.
- Returns
- the channelName field
Definition at line 352 of file ntscalarMultiChannel.h.
◆ getDescriptor()
epics::pvData::PVStringPtr epics::nt::NTScalarMultiChannel::getDescriptor |
( |
| ) |
const |
|
inline |
Return the descriptor field.
- Returns
- the descriptor field or null if no descriptor field.
Definition at line 311 of file ntscalarMultiChannel.h.
◆ getIsConnected()
epics::pvData::PVBooleanArrayPtr epics::nt::NTScalarMultiChannel::getIsConnected |
( |
| ) |
const |
|
inline |
Returns the field with the connection state of each channel.
- Returns
- the isConnected field or null if no such field
Definition at line 359 of file ntscalarMultiChannel.h.
◆ getMessage()
epics::pvData::PVStringArrayPtr epics::nt::NTScalarMultiChannel::getMessage |
( |
| ) |
const |
|
inline |
Returns the field with the message of each channel.
- Returns
- message field or null if no such field.
Definition at line 380 of file ntscalarMultiChannel.h.
◆ getNanoseconds()
epics::pvData::PVIntArrayPtr epics::nt::NTScalarMultiChannel::getNanoseconds |
( |
| ) |
const |
|
inline |
Returns the field with the nanoseconds of each channel.
- Returns
- nanoseconds field or null if no such field.
Definition at line 394 of file ntscalarMultiChannel.h.
◆ getPVStructure()
epics::pvData::PVStructurePtr epics::nt::NTScalarMultiChannel::getPVStructure |
( |
| ) |
const |
|
inline |
Returns the PVStructure wrapped by this instance.
- Returns
- the PVStructure wrapped by this instance.
Definition at line 304 of file ntscalarMultiChannel.h.
◆ getSecondsPastEpoch()
epics::pvData::PVLongArrayPtr epics::nt::NTScalarMultiChannel::getSecondsPastEpoch |
( |
| ) |
const |
|
inline |
Returns the field with the secondsPastEpoch of each channel.
- Returns
- the secondsPastEpoch field or null if no such field.
Definition at line 387 of file ntscalarMultiChannel.h.
◆ getSeverity()
epics::pvData::PVIntArrayPtr epics::nt::NTScalarMultiChannel::getSeverity |
( |
| ) |
const |
|
inline |
Returns the field with the severity of each channel.
- Returns
- the severity field or null if no such field
Definition at line 366 of file ntscalarMultiChannel.h.
◆ getStatus()
epics::pvData::PVIntArrayPtr epics::nt::NTScalarMultiChannel::getStatus |
( |
| ) |
const |
|
inline |
Returns the field with the status of each channel.
- Returns
- the status field or null if no such field
Definition at line 373 of file ntscalarMultiChannel.h.
◆ getTimeStamp()
epics::pvData::PVStructurePtr epics::nt::NTScalarMultiChannel::getTimeStamp |
( |
| ) |
const |
|
inline |
Returns the timeStamp field.
- Returns
- the timeStamp field or null if no such field.
Definition at line 318 of file ntscalarMultiChannel.h.
◆ getUserTag()
epics::pvData::PVIntArrayPtr epics::nt::NTScalarMultiChannel::getUserTag |
( |
| ) |
const |
|
inline |
Returns the field with the userTag of each channel.
- Returns
- the userTag field or null if no such field.
Definition at line 401 of file ntscalarMultiChannel.h.
◆ getValue() [1/2]
epics::pvData::PVScalarArrayPtr epics::nt::NTScalarMultiChannel::getValue |
( |
| ) |
const |
|
inline |
Returns the field with the value of each channel.
- Returns
- the value field.
Definition at line 332 of file ntscalarMultiChannel.h.
◆ getValue() [2/2]
template<typename PVT >
std::tr1::shared_ptr<PVT> epics::nt::NTScalarMultiChannel::getValue |
( |
| ) |
const |
|
inline |
Returns the value of each channel of a specified expected type (for example, 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 343 of file ntscalarMultiChannel.h.
◆ is_a() [1/2]
static bool epics::nt::NTScalarMultiChannel::is_a |
( |
epics::pvData::StructureConstPtr const & |
structure | ) |
|
|
static |
Returns whether the specified Structure reports to be a compatible NTScalarMultiChannel.
Checks if the specified Structure reports compatibility with this version of NTScalarMultiChannel 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 NTScalarMultiChannel
◆ is_a() [2/2]
static bool epics::nt::NTScalarMultiChannel::is_a |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
Returns whether the specified PVStructure reports to be a compatible NTScalarMultiChannel.
Checks if the specified PVStructure reports compatibility with this version of NTScalarMultiChannel 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 NTScalarMultiChannel
◆ isCompatible() [1/2]
static bool epics::nt::NTScalarMultiChannel::isCompatible |
( |
epics::pvData::StructureConstPtr const & |
structure | ) |
|
|
static |
Returns whether the specified Structure is compatible with NTScalarMultiChannel.
Checks if the specified Structure is compatible with this version of NTScalarMultiChannel through the introspection interface.
- Parameters
-
structure | the Structure to test |
- Returns
- (false,true) if the specified Structure (is not, is) a compatible NTScalarMultiChannel
◆ isCompatible() [2/2]
static bool epics::nt::NTScalarMultiChannel::isCompatible |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
◆ isValid()
bool epics::nt::NTScalarMultiChannel::isValid |
( |
| ) |
|
◆ POINTER_DEFINITIONS()
◆ wrap()
NTScalarMultiChannel::shared_pointer epics::nt::NTScalarMultiChannel::wrap |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
◆ wrapUnsafe()
NTScalarMultiChannel::shared_pointer epics::nt::NTScalarMultiChannel::wrapUnsafe |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
◆ detail::NTScalarMultiChannelBuilder
◆ URI
const std::string epics::nt::NTScalarMultiChannel::URI |
|
static |
The documentation for this class was generated from the following files: