ntaggregate.h

Go to the documentation of this file.

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

#ifdef epicsExportSharedSymbols
#   define ntaggregateEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

#ifdef ntaggregateEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntaggregateEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>

namespace epics { namespace nt {

class NTAggregate;
typedef std::tr1::shared_ptr<NTAggregate> NTAggregatePtr;

namespace detail {

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

        shared_pointer addDispersion();

        shared_pointer addFirst();

        shared_pointer addFirstTimeStamp();

        shared_pointer addLast();

        shared_pointer addLastTimeStamp();

        shared_pointer addMax();

        shared_pointer addMin();

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTAggregatePtr create();

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

    private:
        NTAggregateBuilder();

        void reset();

        bool dispersion;
        bool first;
        bool firstTimeStamp;
        bool last;
        bool lastTimeStamp;
        bool max; 
        bool min;

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

}

typedef std::tr1::shared_ptr<detail::NTAggregateBuilder> NTAggregateBuilderPtr;


class epicsShareClass NTAggregate
{
public:
    POINTER_DEFINITIONS(NTAggregate);

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

    ~NTAggregate() {}

    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::PVDoublePtr getValue() const;

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

    epics::pvData::PVDoublePtr getDispersion() const;

    epics::pvData::PVDoublePtr getFirst() const;

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

    epics::pvData::PVDoublePtr getLast() const;

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

    epics::pvData::PVDoublePtr getMax() const;

    epics::pvData::PVDoublePtr getMin() const;

private:
    NTAggregate(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTAggregate;
    epics::pvData::PVDoublePtr pvValue;

    friend class detail::NTAggregateBuilder;
};

}}
#endif  /* NTAGGREGATE_H */