epics::nt::NTURI Class Reference

Convenience Class for NTURI. More...

#include "nturi.h"

Public Member Functions
	POINTER_DEFINITIONS (NTURI)
bool	isValid ()
	~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

Static Public Member Functions
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)
static NTURIBuilderPtr	createBuilder ()

Static Public Attributes
static const std::string	URI

Friends
class	detail::NTURIBuilder

Detailed Description

Convenience Class for NTURI.

Author

dgh

Definition at line 136 of file nturi.h.

Constructor & Destructor Documentation

epics::nt::NTURI::~NTURI ( )

inline

Destructor.

Definition at line 236 of file nturi.h.

{}

Member Function Documentation

NTURIBuilderPtr epics::nt::NTURI::createBuilder ( )

static

Creates an NTURI builder instance.

Returns

builder instance.

Definition at line 193 of file nturi.cpp.

{
    return NTURIBuilderPtr(new detail::NTURIBuilder());
}

PVStringPtr epics::nt::NTURI::getAuthority

(

)

const

Returns the authority field.

Returns

the authority field or null if no such field.

Definition at line 210 of file nturi.cpp.

{
    return pvNTURI->getSubField<PVString>("authority");
}

PVStringPtr epics::nt::NTURI::getPath

(

)

const

Returns the path field.

Returns

the path field.

Definition at line 215 of file nturi.cpp.

{
    return pvNTURI->getSubField<PVString>("path");
}

PVStructurePtr epics::nt::NTURI::getPVStructure

(

)

const

Returns the PVStructure wrapped by this instance.

Returns

the PVStructure wrapped by this instance.

Definition at line 199 of file nturi.cpp.

{
    return pvNTURI;
}

PVStructurePtr epics::nt::NTURI::getQuery

(

)

const

Returns the query field.

Returns

the query field or null if no such field.

Definition at line 220 of file nturi.cpp.

{
    return pvNTURI->getSubField<PVStructure>("query");
}

PVFieldPtr epics::nt::NTURI::getQueryField

(

std::string const &

name

)

const

Returns the subfield of the query field with the specified name.

Parameters

name	the name of the subfield.

Returns

the the subfield of the query field or null if the field does not exist.

Definition at line 230 of file nturi.cpp.

{
    return pvNTURI->getSubField("query." + name);
}

template<typename PVT >

std::tr1::shared_ptr<PVT> epics::nt::NTURI::getQueryField ( std::string const &  name ) const

inline

Returns the subfield of the query field (parameter) with the specified name and of a specified expected type (for example, PVString).

Template Parameters

PVT	the expected type of the subfield which should be be PVString, PVInt pr PVDouble.

Parameters

name	the subfield of the query field or null if the field does not exist or is not of the expected type.

Returns

The PVT field.

Definition at line 293 of file nturi.h.

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

StringArray const & epics::nt::NTURI::getQueryNames

(

)

const

Returns the names of the query fields for the URI. For each name, calling getQueryField should return the query field, which should not be null.

Returns

The query field names.

Definition at line 225 of file nturi.cpp.

{
    return pvNTURI->getSubField<PVStructure>("query")->getStructure()->getFieldNames();
}

PVStringPtr epics::nt::NTURI::getScheme

(

)

const

Returns the scheme field.

Returns

the scheme field.

Definition at line 205 of file nturi.cpp.

{
    return pvNTURI->getSubField<PVString>("scheme");
}

bool epics::nt::NTURI::is_a ( epics::pvData::StructureConstPtr const &  structure )

static

Returns whether the specified Structure reports to be a compatible NTScalar.

Checks if the specified Structure reports compatibility with this version of NTScalar through its type ID, including checking version numbers. The return value does not depend on whether the structure is actually compatible in terms of its introspection type.

Parameters

structure

the Structure to test

Returns

(false,true) if (is not, is) a compatible NTScalar

Definition at line 141 of file nturi.cpp.

{
    return NTUtils::is_a(structure->getID(), URI);
}

bool epics::nt::NTURI::is_a ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Returns whether the specified PVStructure reports to be a compatible NTURI.

Checks if the specified PVStructure reports compatibility with this version of NTURI through its type ID, including checking version numbers. The return value does not depend on whether the structure is actually compatible in terms of its introspection type.

Parameters

pvStructure

the PVStructure to test.

Returns

(false,true) if the specified PVStructure (is not, is) a compatible NTURI.

Definition at line 146 of file nturi.cpp.

{
    return is_a(pvStructure->getStructure());
}

bool epics::nt::NTURI::isCompatible ( epics::pvData::StructureConstPtr const &  structure )

static

Returns whether the specified Structure is compatible with NTURI.

Checks if the specified Structure is compatible with this version of NTURI through the introspection interface.

Parameters

structure

the Structure to test

Returns

(false,true) if the specified Structure (is not, is) a compatible NTURI

Definition at line 151 of file nturi.cpp.

{
    if (!structure)
        return false;

    Result result(structure);

    result
        .is<Structure>()
        .has<Scalar>("scheme")
        .has<Scalar>("path")
        .maybeHas<Scalar>("authority")
        .maybeHas<Structure>("query");

    StructureConstPtr query(structure->getField<Structure>("query"));
    if (query) {
        Result r(query);
        StringArray const & names(query->getFieldNames());
        StringArray::const_iterator it;

        for (it = names.begin(); it != names.end(); ++it)
            r.has<ScalarArray>(*it);

        result |= r;
    }

    return result.valid();
}

bool epics::nt::NTURI::isCompatible ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Returns whether the specified PVStructure is compatible with NTURI.

Checks if the specified PVStructure is compatible with this version of NTURI through the introspection interface.

Parameters

pvStructure

the PVStructure to test

Returns

(false,true) if the specified PVStructure (is not, is) a compatible NTURI

Definition at line 181 of file nturi.cpp.

{
    if(!pvStructure) return false;

    return isCompatible(pvStructure->getStructure());
}

bool epics::nt::NTURI::isValid

(

)

Returns whether the wrapped PVStructure is a valid NTURI.

Unlike isCompatible(), isValid() may perform checks on the value data as well as the introspection data.

Returns

(false,true) if wrapped PVStructure (is not, is) a valid NTURI.

Definition at line 188 of file nturi.cpp.

{
    return true;
}

epics::nt::NTURI::POINTER_DEFINITIONS

(

NTURI

)

NTURI::shared_pointer epics::nt::NTURI::wrap ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Creates an NTURI wrapping the specified PVStructure if the latter is compatible.

Checks the supplied PVStructure is compatible with NTURI and if so returns an NTURI which wraps it. This method will return null if the structure is is not compatible or is null.

Parameters

pvStructure

the PVStructure to be wrapped

Returns

NTURI instance wrapping pvStructure on success, null otherwise

Definition at line 130 of file nturi.cpp.

{
    if(!isCompatible(pvStructure)) return shared_pointer();
    return wrapUnsafe(pvStructure);
}

NTURI::shared_pointer epics::nt::NTURI::wrapUnsafe ( epics::pvData::PVStructurePtr const &  pvStructure )

static

Creates an NTScalar wrapping the specified PVStructure, regardless of the latter's compatibility.

No checks are made as to whether the specified PVStructure is compatible with NTScalar or is non-null.

Parameters

pvStructure

the PVStructure to be wrapped

Returns

NTScalar instance wrapping pvStructure

Definition at line 136 of file nturi.cpp.

{
    return shared_pointer(new NTURI(pvStructure));
}

Friends And Related Function Documentation

friend class detail::NTURIBuilder

friend

Definition at line 305 of file nturi.h.

Member Data Documentation

const std::string epics::nt::NTURI::URI

static

Definition at line 141 of file nturi.h.

---

The documentation for this class was generated from the following files:

• modules/normativeTypes/src/pv/nturi.h
• modules/normativeTypes/src/nturi.cpp