ntenum.h

Go to the documentation of this file.

/* ntenum.h */
/*
 * Copyright information and license terms for this software can be
 * found in the file LICENSE that is included with the distribution
 */
#ifndef NTENUM_H
#define NTENUM_H
 
#ifdef epicsExportSharedSymbols
#   define ntenumEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif
 
#ifdef ntenumEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntenumEpicsExportSharedSymbols
#endif
 
#include <pv/ntfield.h>
 
#include <shareLib.h>
 
namespace epics { namespace nt {
 
class NTEnum;
typedef std::tr1::shared_ptr<NTEnum> NTEnumPtr;
 
namespace detail {
 
    class epicsShareClass NTEnumBuilder :
        public std::tr1::enable_shared_from_this<NTEnumBuilder>
    {
    public:
        POINTER_DEFINITIONS(NTEnumBuilder);
 
        shared_pointer addDescriptor();
 
        shared_pointer addAlarm();
 
        shared_pointer addTimeStamp();
 
        epics::pvData::StructureConstPtr createStructure();
 
        epics::pvData::PVStructurePtr createPVStructure();
 
        NTEnumPtr create();
 
        shared_pointer add(std::string const & name, epics::pvData::FieldConstPtr const & field);
 
    private:
        NTEnumBuilder();
 
        void reset();
 
        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::NTEnum;
    };
 
}
 
typedef std::tr1::shared_ptr<detail::NTEnumBuilder> NTEnumBuilderPtr;
 
 
 
class epicsShareClass NTEnum
{
public:
    POINTER_DEFINITIONS(NTEnum);
 
    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 NTEnumBuilderPtr createBuilder();
 
    ~NTEnum() {}
 
    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::PVStructurePtr getValue() const;
 
private:
    NTEnum(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTEnum;
    epics::pvData::PVStructurePtr pvValue;
 
    friend class detail::NTEnumBuilder;
};
 
}}
#endif  /* NTENUM_H */