ntscalar.h

Go to the documentation of this file.

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

#ifdef epicsExportSharedSymbols
#   define ntscalarEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

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

#ifdef ntscalarEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntscalarEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>

namespace epics { namespace nt {

class NTScalar;
typedef std::tr1::shared_ptr<NTScalar> NTScalarPtr;

namespace detail {

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

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

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        shared_pointer addDisplay();

        shared_pointer addControl();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTScalarPtr create();

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

    private:
        NTScalarBuilder();

        void reset();

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

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

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

        friend class ::epics::nt::NTScalar;
    };

}

typedef std::tr1::shared_ptr<detail::NTScalarBuilder> NTScalarBuilderPtr;



class epicsShareClass NTScalar
{
public:
    POINTER_DEFINITIONS(NTScalar);

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

    ~NTScalar() {}

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

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

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

    bool attachControl(epics::pvData::PVControl &pvControl) const;

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

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

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

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

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

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

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

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

private:
    NTScalar(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTScalar;
    epics::pvData::PVFieldPtr pvValue;

    friend class detail::NTScalarBuilder;
};

}}
#endif  /* NTSCALAR_H */