ntmultiChannel.h

Go to the documentation of this file.

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

#include <vector>
#include <string>

#ifdef epicsExportSharedSymbols
#   define ntmultiChannelEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

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

#ifdef ntmultiChannelEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntmultiChannelEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>


namespace epics { namespace nt { 


class NTMultiChannel;
typedef std::tr1::shared_ptr<NTMultiChannel> NTMultiChannelPtr;

namespace detail {

    class epicsShareClass NTMultiChannelBuilder :
        public std::tr1::enable_shared_from_this<NTMultiChannelBuilder>
    {
    public:
        POINTER_DEFINITIONS(NTMultiChannelBuilder);
        shared_pointer value(epics::pvData::UnionConstPtr valuePtr);

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        shared_pointer addSeverity();

        shared_pointer addStatus();

        shared_pointer addMessage();

        shared_pointer addSecondsPastEpoch();

        shared_pointer addNanoseconds();

        shared_pointer addUserTag();

        shared_pointer addIsConnected();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTMultiChannelPtr create();

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

    private:
        NTMultiChannelBuilder();

        void reset();

        epics::pvData::UnionConstPtr valueType;
        bool descriptor;
        bool alarm;
        bool timeStamp;
        bool severity;
        bool status;
        bool message;
        bool secondsPastEpoch;
        bool nanoseconds;
        bool userTag;
        bool isConnected;

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

        friend class ::epics::nt::NTMultiChannel;
    };

}

typedef std::tr1::shared_ptr<detail::NTMultiChannelBuilder> NTMultiChannelBuilderPtr;


class epicsShareClass NTMultiChannel
{
public:
    POINTER_DEFINITIONS(NTMultiChannel);

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

    ~NTMultiChannel() {}
    bool attachTimeStamp(epics::pvData::PVTimeStamp &pvTimeStamp) const;

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

    epics::pvData::PVStructurePtr getPVStructure() const
    {return pvNTMultiChannel;}

    epics::pvData::PVStringPtr getDescriptor() const 
    {return pvDescriptor;}

    epics::pvData::PVStructurePtr getTimeStamp() const
    {return pvTimeStamp;}

    epics::pvData::PVStructurePtr getAlarm() const
     {return pvAlarm;}

    epics::pvData::PVUnionArrayPtr getValue() const 
    {return pvValue;}

    epics::pvData::PVStringArrayPtr getChannelName() const 
    { return pvChannelName;};

    epics::pvData::PVBooleanArrayPtr getIsConnected() const 
    { return pvIsConnected;};

    epics::pvData::PVIntArrayPtr getSeverity() const 
    {return pvSeverity;}

    epics::pvData::PVIntArrayPtr getStatus() const 
    {return pvStatus;}

    epics::pvData::PVStringArrayPtr getMessage() const 
    {return pvMessage;}

    epics::pvData::PVLongArrayPtr getSecondsPastEpoch() const 
    {return pvSecondsPastEpoch;}

    epics::pvData::PVIntArrayPtr getNanoseconds() const 
    {return pvNanoseconds;}

    epics::pvData::PVIntArrayPtr getUserTag() const 
    {return pvUserTag;}

private:
    NTMultiChannel(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTMultiChannel;
    epics::pvData::PVStructurePtr pvTimeStamp;
    epics::pvData::PVStructurePtr pvAlarm;
    epics::pvData::PVUnionArrayPtr pvValue;
    epics::pvData::PVStringArrayPtr pvChannelName;
    epics::pvData::PVBooleanArrayPtr pvIsConnected;
    epics::pvData::PVIntArrayPtr pvSeverity;
    epics::pvData::PVIntArrayPtr pvStatus;
    epics::pvData::PVStringArrayPtr pvMessage;
    epics::pvData::PVLongArrayPtr pvSecondsPastEpoch;
    epics::pvData::PVIntArrayPtr pvNanoseconds;
    epics::pvData::PVIntArrayPtr pvUserTag;
    epics::pvData::PVStringPtr pvDescriptor;
    friend class detail::NTMultiChannelBuilder;
};

}}
#endif  /* NTMULTICHANNEL_H */