nturi.h

Go to the documentation of this file.

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

#include <vector>
#include <string>

#ifdef epicsExportSharedSymbols
#   define nturiEpicsExportSharedSymbols
#   undef epicsExportSharedSymbols
#endif

#ifdef nturiEpicsExportSharedSymbols
#   define epicsExportSharedSymbols
#   undef nturiEpicsExportSharedSymbols
#endif

#include <pv/ntfield.h>

#include <shareLib.h>

namespace epics { namespace nt {

class NTURI;
typedef std::tr1::shared_ptr<NTURI> NTURIPtr;

namespace detail {

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

        shared_pointer addAuthority();

         shared_pointer addQueryString(std::string const & name);

         shared_pointer addQueryDouble(std::string const & name);

         shared_pointer addQueryInt(std::string const & name);

        epics::pvData::StructureConstPtr createStructure();

        epics::pvData::PVStructurePtr createPVStructure();

        NTURIPtr create();

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

    private:
        NTURIBuilder();

        void reset();

        std::vector<std::string> queryFieldNames;
        std::vector<epics::pvData::ScalarType> queryTypes;

        bool authority;

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

        friend class ::epics::nt::NTURI;
    };

}

typedef std::tr1::shared_ptr<detail::NTURIBuilder> NTURIBuilderPtr;



class epicsShareClass NTURI
{
public:
    POINTER_DEFINITIONS(NTURI);

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

    ~NTURI() {}

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

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

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

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

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

    epics::pvData::StringArray const & getQueryNames() const;

    epics::pvData::PVFieldPtr getQueryField(std::string const & name) const;

    template<typename PVT>
    std::tr1::shared_ptr<PVT> getQueryField(std::string const & name) const
    {
        epics::pvData::PVFieldPtr pvField = getQueryField(name);
        if (pvField.get())
            return std::tr1::dynamic_pointer_cast<PVT>(pvField);
        else
            return std::tr1::shared_ptr<PVT>();
    }

private:
    NTURI(epics::pvData::PVStructurePtr const & pvStructure);
    epics::pvData::PVStructurePtr pvNTURI;
    friend class detail::NTURIBuilder;
};

}}
#endif  /* NTURI_H */