ntattribute.h

Go to the documentation of this file.

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

#ifdef epicsExportSharedSymbols
#   define ntattributeEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

#ifdef ntattributeEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef ntattributeEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>

namespace epics { namespace nt {

class NTAttribute;
typedef std::tr1::shared_ptr<NTAttribute> NTAttributePtr;

namespace detail {

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

        shared_pointer addTags();

        shared_pointer addDescriptor();

        shared_pointer addAlarm();

        shared_pointer addTimeStamp();

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTAttributePtr create();

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

    protected://private:
        NTAttributeBuilder();

        void reset();

        bool tags;
        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::NTAttribute;
    };

}

typedef std::tr1::shared_ptr<detail::NTAttributeBuilder> NTAttributeBuilderPtr;



class epicsShareClass NTAttribute
{
public:
    POINTER_DEFINITIONS(NTAttribute);

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

    ~NTAttribute() {}

    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::PVStringPtr getName() const;

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

    epics::pvData::PVStringArrayPtr getTags() const;

private:
    NTAttribute(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTAttribute;
    epics::pvData::PVUnionPtr pvValue;

    friend class detail::NTAttributeBuilder;
};

}}
#endif  /* NTATTRIBUTE_H */