ntmatrix.h

Go to the documentation of this file.

/* ntmatrix.h */
/*
 * Copyright information and license terms for this software can be
 * found in the file LICENSE that is included with the distribution
 */
#ifndef NTMATRIX_H
#define NTMATRIX_H
 
#ifdef epicsExportSharedSymbols
#   define ntmatrixEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif
 
#include <pv/pvDisplay.h>
 
#ifdef ntmatrixEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntmatrixEpicsExportSharedSymbols
#endif
 
#include <pv/ntfield.h>
 
#include <shareLib.h>
 
 
namespace epics { namespace nt {
 
class NTMatrix;
typedef std::tr1::shared_ptr<NTMatrix> NTMatrixPtr;
 
namespace detail {
 
    class epicsShareClass NTMatrixBuilder :
        public std::tr1::enable_shared_from_this<NTMatrixBuilder>
    {
    public:
        POINTER_DEFINITIONS(NTMatrixBuilder);
 
        shared_pointer addDim();
 
        shared_pointer addDescriptor();
 
        shared_pointer addAlarm();
 
        shared_pointer addTimeStamp();
 
        shared_pointer addDisplay();
 
        epics::pvData::StructureConstPtr createStructure();
 
        epics::pvData::PVStructurePtr createPVStructure();
 
        NTMatrixPtr create();
 
        shared_pointer add(std::string const & name, epics::pvData::FieldConstPtr const & field);
 
    private:
        NTMatrixBuilder();
 
        void reset();
 
        bool dim;
        bool descriptor;
        bool alarm;
        bool timeStamp;
        bool display;
 
        // NOTE: this preserves order, however it does not handle duplicates
        epics::pvData::StringArray extraFieldNames;
        epics::pvData::FieldConstPtrArray extraFields;
 
        friend class ::epics::nt::NTMatrix;
    };
 
}
 
typedef std::tr1::shared_ptr<detail::NTMatrixBuilder> NTMatrixBuilderPtr;
 
 
 
class epicsShareClass NTMatrix
{
public:
    POINTER_DEFINITIONS(NTMatrix);
 
    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 NTMatrixBuilderPtr createBuilder();
 
    ~NTMatrix() {}
 
    bool attachTimeStamp(epics::pvData::PVTimeStamp &pvTimeStamp) const;
 
    bool attachAlarm(epics::pvData::PVAlarm &pvAlarm) const;
 
    bool attachDisplay(epics::pvData::PVDisplay &pvDisplay) const;
 
    epics::pvData::PVStructurePtr getPVStructure() const;
 
    epics::pvData::PVStringPtr getDescriptor() const;
 
    epics::pvData::PVStructurePtr getTimeStamp() const;
 
    epics::pvData::PVStructurePtr getAlarm() const;
 
    epics::pvData::PVStructurePtr getDisplay() const;
 
    epics::pvData::PVDoubleArrayPtr getValue() const;
 
    epics::pvData::PVIntArrayPtr getDim() const;   
 
private:
    NTMatrix(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTMatrix;
    epics::pvData::PVDoubleArrayPtr pvValue;
 
    friend class detail::NTMatrixBuilder;
};
 
}}
#endif  /* NTMATRIX_H */