nttable.h

Go to the documentation of this file.

/* nttable.h */
/*
 * Copyright information and license terms for this software can be
 * found in the file LICENSE that is included with the distribution
 */
#ifndef NTTABLE_H
#define NTTABLE_H

#include <vector>
#include <string>

#ifdef epicsExportSharedSymbols
#   define nttableEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

#include <pv/pvDisplay.h>
#include <pv/pvControl.h>

#ifdef nttableEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef nttableEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>

namespace epics { namespace nt {

class NTTable;
typedef std::tr1::shared_ptr<NTTable> NTTablePtr;

namespace detail {

    class epicsShareClass NTTableBuilder :
        public std::tr1::enable_shared_from_this<NTTableBuilder>
    {
    public:
        POINTER_DEFINITIONS(NTTableBuilder);

        shared_pointer addColumn(std::string const & name, epics::pvData::ScalarType elementType);

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTTablePtr create();

        shared_pointer add(std::string const & name, epics::pvData::FieldConstPtr const & field);

    private:
        NTTableBuilder();

        void reset();

        std::vector<std::string> columnNames;
        std::vector<epics::pvData::ScalarType> types;

        bool descriptor;
        bool alarm;
        bool timeStamp;

        // NOTE: this preserves order, however it does not handle duplicates
        epics::pvData::StringArray extraFieldNames;
        epics::pvData::FieldConstPtrArray extraFields;

        friend class ::epics::nt::NTTable;
    };

}

typedef std::tr1::shared_ptr<detail::NTTableBuilder> NTTableBuilderPtr;



class epicsShareClass NTTable
{
public:
    POINTER_DEFINITIONS(NTTable);

    static const std::string URI;

    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);

    bool isValid();

    static NTTableBuilderPtr createBuilder();

    ~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
    {
        epics::pvData::PVFieldPtr pvField = getColumn(columnName);
        if (pvField.get())
            return std::tr1::dynamic_pointer_cast<PVT>(pvField);
        else
            return std::tr1::shared_ptr<PVT>();
    }

private:
    NTTable(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTTable;
    epics::pvData::PVStructurePtr pvValue;
    friend class detail::NTTableBuilder;
};

}}
#endif  /* NTTABLE_H */