Convenience Class for NTContinuum.
More...
#include <ntcontinuum.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 NTContinuumBuilderPtr | createBuilder () |
|
|
static const std::string | URI |
|
Convenience Class for NTContinuum.
- Author
- dgh
Definition at line 118 of file ntcontinuum.h.
◆ ~NTContinuum()
epics::nt::NTContinuum::~NTContinuum |
( |
| ) |
|
|
inline |
◆ attachAlarm()
bool epics::nt::NTContinuum::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 170 of file ntcontinuum.cpp.
◆ attachTimeStamp()
bool epics::nt::NTContinuum::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 161 of file ntcontinuum.cpp.
◆ createBuilder()
◆ getAlarm()
PVStructurePtr epics::nt::NTContinuum::getAlarm |
( |
| ) |
const |
Returns the alarm field.
- Returns
- the alarm field or null if no such field.
Definition at line 194 of file ntcontinuum.cpp.
◆ getBase()
PVDoubleArrayPtr epics::nt::NTContinuum::getBase |
( |
| ) |
const |
Returns the base field.
- Returns
- the base field.
Definition at line 199 of file ntcontinuum.cpp.
◆ getDescriptor()
PVStringPtr epics::nt::NTContinuum::getDescriptor |
( |
| ) |
const |
Returns the descriptor field.
- Returns
- the descriptor field or null if no such field.
Definition at line 184 of file ntcontinuum.cpp.
◆ getPVStructure()
PVStructurePtr epics::nt::NTContinuum::getPVStructure |
( |
| ) |
const |
Returns the PVStructure wrapped by this instance.
- Returns
- the PVStructure wrapped by this instance.
Definition at line 179 of file ntcontinuum.cpp.
◆ getTimeStamp()
PVStructurePtr epics::nt::NTContinuum::getTimeStamp |
( |
| ) |
const |
Returns the timeStamp field.
- Returns
- the timStamp field or null if no such field.
Definition at line 189 of file ntcontinuum.cpp.
◆ getUnits()
PVStringArrayPtr epics::nt::NTContinuum::getUnits |
( |
| ) |
const |
Returns the units field.
- Returns
- the units field.
Definition at line 209 of file ntcontinuum.cpp.
◆ getValue()
PVDoubleArrayPtr epics::nt::NTContinuum::getValue |
( |
| ) |
const |
Returns the value field.
- Returns
- the value field.
Definition at line 204 of file ntcontinuum.cpp.
◆ is_a() [1/2]
static bool epics::nt::NTContinuum::is_a |
( |
epics::pvData::StructureConstPtr const & |
structure | ) |
|
|
static |
Returns whether the specified Structure reports to be a compatible NTContinuum.
Checks if the specified Structure reports compatibility with this version of NTContinuum 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 NTContinuum
◆ is_a() [2/2]
static bool epics::nt::NTContinuum::is_a |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
Returns whether the specified PVStructure reports to be a compatible NTContinuum.
Checks if the specified Structure reports compatibility with this version of NTContinuum 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 NTContinuum
◆ isCompatible() [1/2]
static bool epics::nt::NTContinuum::isCompatible |
( |
epics::pvData::StructureConstPtr const & |
structure | ) |
|
|
static |
Returns whether the specified Structure is compatible with NTContinuum.
Checks if the specified Structure is compatible with this version of NTContinuum through the introspection interface.
- Parameters
-
structure | the Structure to test |
- Returns
- (false,true) if the specified Structure (is not, is) a compatible NTContinuum
◆ isCompatible() [2/2]
static bool epics::nt::NTContinuum::isCompatible |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
Returns whether the specified PVStructure is compatible with NTContinuum.
Checks if the specified PVStructure is compatible with this version of NTContinuum through the introspection interface.
- Parameters
-
pvStructure | the PVStructure to test |
- Returns
- (false,true) if the specified PVStructure (is not, is) a compatible NTContinuum
◆ isValid()
bool epics::nt::NTContinuum::isValid |
( |
| ) |
|
Returns whether the wrapped structure is valid with respect to this version of NTContinuum.
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 NTContinuum
Definition at line 150 of file ntcontinuum.cpp.
◆ POINTER_DEFINITIONS()
epics::nt::NTContinuum::POINTER_DEFINITIONS |
( |
NTContinuum |
| ) |
|
◆ wrap()
NTContinuum::shared_pointer epics::nt::NTContinuum::wrap |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
Creates an NTContinuum wrapping the specified PVStructure if the latter is compatible.
Checks the supplied structure is compatible with NTContinuum and if so returns an NTContinuum 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
- NTContinuum instance wrapping pvStructure on success, null otherwise
Definition at line 104 of file ntcontinuum.cpp.
◆ wrapUnsafe()
NTContinuum::shared_pointer epics::nt::NTContinuum::wrapUnsafe |
( |
epics::pvData::PVStructurePtr const & |
pvStructure | ) |
|
|
static |
◆ detail::NTContinuumBuilder
◆ URI
const std::string epics::nt::NTContinuum::URI |
|
static |
The documentation for this class was generated from the following files: