ntndarray.h

Go to the documentation of this file.

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

#include <vector>
#include <string>

#ifdef epicsExportSharedSymbols
#   define ntndarrayEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

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

#ifdef ntndarrayEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntndarrayEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>

namespace epics { namespace nt {

class NTNDArray;
typedef std::tr1::shared_ptr<NTNDArray> NTNDArrayPtr;

namespace detail {

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

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        shared_pointer addDisplay();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTNDArrayPtr create();

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

    private:
        NTNDArrayBuilder();

        void reset();

        bool descriptor;
        bool timeStamp;
        bool alarm;
        bool display;

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

        friend class ::epics::nt::NTNDArray;
    };

}

typedef std::tr1::shared_ptr<detail::NTNDArrayBuilder> NTNDArrayBuilderPtr;

class epicsShareClass NTNDArray
{
public:
    POINTER_DEFINITIONS(NTNDArray);

    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 NTNDArrayBuilderPtr createBuilder();

    ~NTNDArray() {}

    bool attachTimeStamp(epics::pvData::PVTimeStamp &pvTimeStamp) const;

    bool attachDataTimeStamp(epics::pvData::PVTimeStamp &pvTimeStamp) const;

    bool attachAlarm(epics::pvData::PVAlarm &pvAlarm) const;

    epics::pvData::PVStructurePtr getPVStructure() const;

    epics::pvData::PVUnionPtr getValue() const;

    epics::pvData::PVStructurePtr getCodec() const;

    epics::pvData::PVLongPtr getCompressedDataSize() const;

    epics::pvData::PVLongPtr getUncompressedDataSize() const;

    epics::pvData::PVStructureArrayPtr getDimension() const;

    epics::pvData::PVIntPtr getUniqueId() const;

    epics::pvData::PVStructurePtr getDataTimeStamp() const;

    epics::pvData::PVStructureArrayPtr getAttribute() const;

    epics::pvData::PVStringPtr getDescriptor() const;

    epics::pvData::PVStructurePtr getTimeStamp() const;

    epics::pvData::PVStructurePtr getAlarm() const;

    bool attachDisplay(epics::pvData::PVDisplay &pvDisplay) const;

    epics::pvData::PVStructurePtr getDisplay() const;

private:
    NTNDArray(epics::pvData::PVStructurePtr const & pvStructure);

    epics::pvData::int64 getExpectedUncompressedSize();
    epics::pvData::int64 getValueSize();
    epics::pvData::int64 getValueTypeSize();

    epics::pvData::PVStructurePtr pvNTNDArray;

    friend class detail::NTNDArrayBuilder;
};

}}
#endif  /* NTNDARRAY_H */