epics::nt::NTAttribute Class Reference

Convenience Class for NTAttribute. More...

#include "ntattribute.h"

Public Member Functions
	POINTER_DEFINITIONS (NTAttribute)
bool	isValid ()
	~NTAttribute ()
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

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 NTAttributeBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTAttributeBuilder

Detailed Description

Convenience Class for NTAttribute.

Author

dgh

Definition at line 124 of file ntattribute.h.

Constructor & Destructor Documentation

epics::nt::NTAttribute::~NTAttribute ( )

inline

Destructor.

Definition at line 225 of file ntattribute.h.

{}

Member Function Documentation

bool epics::nt::NTAttribute::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 177 of file ntattribute.cpp.

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

bool epics::nt::NTAttribute::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 168 of file ntattribute.cpp.

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

NTAttributeBuilderPtr epics::nt::NTAttribute::createBuilder ( )

static

Creates an NTAttribute builder instance.

Returns

builder instance.

Definition at line 163 of file ntattribute.cpp.

{
    return NTAttributeBuilderPtr(new detail::NTAttributeBuilder());
}

PVStructurePtr epics::nt::NTAttribute::getAlarm

(

)

const

Returns the alarm field.

Returns

the alarm field or null if no such field.

Definition at line 201 of file ntattribute.cpp.

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

PVStringPtr epics::nt::NTAttribute::getDescriptor

(

)

const

Returns the descriptor field.

Returns

the descriptor field or null if no such field.

Definition at line 191 of file ntattribute.cpp.

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

PVStringPtr epics::nt::NTAttribute::getName

(

)

const

Returns the name field.

Returns

the name field.

Definition at line 207 of file ntattribute.cpp.

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

PVStructurePtr epics::nt::NTAttribute::getPVStructure

(

)

const

Returns the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 186 of file ntattribute.cpp.

{
    return pvNTAttribute;
}

PVStringArrayPtr epics::nt::NTAttribute::getTags

(

)

const

Returns the tags field.

Returns

the tags field or null if no such field.

Definition at line 217 of file ntattribute.cpp.

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

PVStructurePtr epics::nt::NTAttribute::getTimeStamp

(

)

const

Returns the timeStamp field.

Returns

the timStamp field or null if no such field.

Definition at line 196 of file ntattribute.cpp.

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

PVUnionPtr epics::nt::NTAttribute::getValue

(

)

const

Returns the value field.

Returns

the value field.

Definition at line 212 of file ntattribute.cpp.

{
    return pvValue;
}

bool epics::nt::NTAttribute::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 123 of file ntattribute.cpp.

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

bool epics::nt::NTAttribute::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 128 of file ntattribute.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTAttribute.

Checks if the specified Structure is compatible with this version of NTAttribute 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 133 of file ntattribute.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

    return result
       .is<Structure>()
       .has<Scalar>("name")
       .has<Union>("value")
       .maybeHas<ScalarArray>("tags")
       .maybeHas<Scalar>("descriptor")
       .maybeHas<&NTField::isAlarm, Structure>("alarm")
       .maybeHas<&NTField::isTimeStamp, Structure>("timeStamp")
       .valid();
}

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

static

Returns whether the specified PVStructure is compatible with NTAttribute.

Checks if the specified tructure is compatible with this version of NTAttribute 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 151 of file ntattribute.cpp.

{
    if(!pvStructure) return false;

    return isCompatible(pvStructure->getStructure());
}

bool epics::nt::NTAttribute::isValid

(

)

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

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 NTAttribute

Definition at line 158 of file ntattribute.cpp.

{
    return true;
}

epics::nt::NTAttribute::POINTER_DEFINITIONS

(

NTAttribute

)

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

static

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

Checks the supplied PVStructure is compatible with NTAttribute and if so returns an NTAttribute 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 112 of file ntattribute.cpp.

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

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

static

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

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

Parameters

pvStructure

the PVStructure to be wrapped

Returns

NTAttribute instance wrapping pvStructure

Definition at line 118 of file ntattribute.cpp.

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

Friends And Related Function Documentation

friend class detail::NTAttributeBuilder

friend

Definition at line 290 of file ntattribute.h.

Member Data Documentation

const std::string epics::nt::NTAttribute::URI

static

Definition at line 129 of file ntattribute.h.

---

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

• modules/normativeTypes/src/pv/ntattribute.h
• modules/normativeTypes/src/ntattribute.cpp