nthistogram.h

Go to the documentation of this file.

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

#ifdef epicsExportSharedSymbols
#   define nthistogramEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

#ifdef nthistogramEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef nthistogramEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>


namespace epics { namespace nt {

class NTHistogram;
typedef std::tr1::shared_ptr<NTHistogram> NTHistogramPtr;

namespace detail {

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

        shared_pointer value(epics::pvData::ScalarType scalarType);

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTHistogramPtr create();

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

    private:
        NTHistogramBuilder();

        void reset();

        bool valueTypeSet;
        epics::pvData::ScalarType valueType;

        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::NTHistogram;
    };

}

typedef std::tr1::shared_ptr<detail::NTHistogramBuilder> NTHistogramBuilderPtr;



class epicsShareClass NTHistogram
{
public:
    POINTER_DEFINITIONS(NTHistogram);

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

    ~NTHistogram() {}

    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::PVDoubleArrayPtr getRanges() const;

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

    template<typename PVT>
    std::tr1::shared_ptr<PVT> getValue() const
    {
        return std::tr1::dynamic_pointer_cast<PVT>(pvValue);
    }
  

private:
    NTHistogram(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTHistogram;
    epics::pvData::PVScalarArrayPtr pvValue;

    friend class detail::NTHistogramBuilder;
};

}}
#endif  /* NTHISTOGRAM_H */