epics::nt::NTTable Class Reference

Convenience Class for NTTable. More...

#include "nttable.h"

Public Member Functions
	POINTER_DEFINITIONS (NTTable)
bool	isValid ()
	~NTTable ()
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::PVStringArrayPtr	getLabels () const
epics::pvData::StringArray const &	getColumnNames () const
epics::pvData::PVFieldPtr	getColumn (std::string const &columnName) const
template<typename PVT >
std::tr1::shared_ptr< PVT >	getColumn (std::string const &columnName) 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 NTTableBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTTableBuilder

Detailed Description

Convenience Class for NTTable.

Author

mrk

Definition at line 137 of file nttable.h.

Constructor & Destructor Documentation

epics::nt::NTTable::~NTTable ( )

inline

Destructor.

Definition at line 237 of file nttable.h.

{}

Member Function Documentation

bool epics::nt::NTTable::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 228 of file nttable.cpp.

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

bool epics::nt::NTTable::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 219 of file nttable.cpp.

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

NTTableBuilderPtr epics::nt::NTTable::createBuilder ( )

static

Creates an NTTable builder instance.

Returns

builder instance.

Definition at line 214 of file nttable.cpp.

{
    return NTTableBuilderPtr(new detail::NTTableBuilder());
}

PVStructurePtr epics::nt::NTTable::getAlarm

(

)

const

Returns the alarm field.

Returns

the alarm field or null if no such field.

Definition at line 252 of file nttable.cpp.

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

PVFieldPtr epics::nt::NTTable::getColumn

(

std::string const &

columnName

)

const

Returns the PVField for the column with the specified colum name.

Parameters

columnName

the name of the column.

Returns

the field for the column or null if column does not exist.

Definition at line 267 of file nttable.cpp.

{
    return pvValue->getSubField(columnName);
}

template<typename PVT >

std::tr1::shared_ptr<PVT> epics::nt::NTTable::getColumn ( std::string const &  columnName ) const

inline

Returns the column with the specified column name and of a specified expected type (for example, PVDoubleArray).

Template Parameters

PVT	the expected type of the column which should be be PVScalarArray or a derived class.

Parameters

columnName

the name of the column.

Returns

the field for the column or null if column does not exist or is not of the specified type.

Definition at line 309 of file nttable.h.

    {
        epics::pvData::PVFieldPtr pvField = getColumn(columnName);
        if (pvField.get())
            return std::tr1::dynamic_pointer_cast<PVT>(pvField);
        else
            return std::tr1::shared_ptr<PVT>();
    }

StringArray const & epics::nt::NTTable::getColumnNames

(

)

const

Returns the column names for the table. For each name, calling getColumn should return the column, which should not be null.

Returns

the column names.

Definition at line 262 of file nttable.cpp.

{
    return pvValue->getStructure()->getFieldNames();
}

PVStringPtr epics::nt::NTTable::getDescriptor

(

)

const

Returns the descriptor field.

Returns

the descriptor field or null if no descriptor field.

Definition at line 242 of file nttable.cpp.

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

PVStringArrayPtr epics::nt::NTTable::getLabels

(

)

const

Returns the labels field.

Returns

the labels field.

Definition at line 257 of file nttable.cpp.

{
    return pvNTTable->getSubField<PVStringArray>("labels");
}

PVStructurePtr epics::nt::NTTable::getPVStructure

(

)

const

Returns the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 237 of file nttable.cpp.

{
    return pvNTTable;
}

PVStructurePtr epics::nt::NTTable::getTimeStamp

(

)

const

Returns the timeStamp field.

Returns

the timStamp field or null if no such field.

Definition at line 247 of file nttable.cpp.

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

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

static

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

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

Definition at line 141 of file nttable.cpp.

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

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

static

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

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

Definition at line 146 of file nttable.cpp.

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

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

static

Returns whether the specified Structure is compatible with NTTable.

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

Parameters

structure

the Structure to test

Returns

(false,true) if the specified Structure (is not, is) a compatible NTTable

Definition at line 151 of file nttable.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

    result
        .is<Structure>()
        .has<Structure>("value")
        .has<ScalarArray>("labels")
        .maybeHas<Scalar>("descriptor")
        .maybeHas<&NTField::isAlarm, Structure>("alarm")
        .maybeHas<&NTField::isTimeStamp, Structure>("timeStamp");

    StructureConstPtr value(structure->getField<Structure>("value"));
    if (value) {
        Result r(value);
        StringArray const & names(value->getFieldNames());
        StringArray::const_iterator it;

        for (it = names.begin(); it != names.end(); ++it)
            r.has<ScalarArray>(*it);

        result |= r;
    }

    return result.valid();
}

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

static

Returns whether the specified PVStructure is compatible with NTTable.

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

Parameters

pvStructure

the PVStructure to test

Returns

(false,true) if the specified PVStructure (is not, is) a compatible NTTable

Definition at line 181 of file nttable.cpp.

{
    if(!pvStructure) return false;

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

bool epics::nt::NTTable::isValid

(

)

Returns whether the specified structure is a valid NTTable.

Unlike isCompatible(), isValid() may perform checks on the value data as well as the introspection data.

Returns

(false,true) if wrapped PVStructure (is not, is) a valid NTTable

Definition at line 188 of file nttable.cpp.

{
    PVFieldPtrArray const & columns = pvValue->getPVFields();

    if (getLabels()->getLength() != columns.size()) return false;
    bool first = true;
    int length = 0;
    for (PVFieldPtrArray::const_iterator it = columns.begin();
        it != columns.end();++it)
    {
        PVScalarArrayPtr column = std::tr1::dynamic_pointer_cast<PVScalarArray>(*it);
        if (!column.get()) return false;
        int colLength = column->getLength();
        if (first)
        {
            length = colLength;
            first = false;
        }
        else if (length != colLength)
            return false;
    }

    return true;
}

epics::nt::NTTable::POINTER_DEFINITIONS

(

NTTable

)

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

static

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

Checks the supplied PVStructure is compatible with NTTable and if so returns an NTTable 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

NTTable instance wrapping pvStructure on success, null otherwise

Definition at line 130 of file nttable.cpp.

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

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

static

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

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

Parameters

pvStructure

the PVStructure to be wrapped

Returns

NTTable instance wrapping pvStructure

Definition at line 136 of file nttable.cpp.

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

Friends And Related Function Documentation

friend class detail::NTTableBuilder

friend

Definition at line 322 of file nttable.h.

Member Data Documentation

const std::string epics::nt::NTTable::URI

static

Definition at line 142 of file nttable.h.

---

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

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