epics::nt::detail::NTURIBuilder Class Reference

Interface for in-line creating of NTURI. More...

#include "nturi.h"

Inheritance diagram for epics::nt::detail::NTURIBuilder:

Collaboration diagram for epics::nt::detail::NTURIBuilder:

Public Member Functions
	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)

Friends
class	::epics::nt::NTURI

Detailed Description

Interface for in-line creating of NTURI.

One instance can be used to create multiple instances. An instance of this object must not be used concurrently (an object has a state).

Author

dgh

Definition at line 40 of file nturi.h.

Member Function Documentation

NTURIBuilder::shared_pointer epics::nt::detail::NTURIBuilder::add	(	std::string const &	name,
		epics::pvData::FieldConstPtr const &	field
	)

Adds extra Field to the type.

Parameters

name	the name of the field.
field	the field to be added.

Returns

this instance of NTURIBuilder.

Definition at line 119 of file nturi.cpp.

{
    extraFields.push_back(field);
    extraFieldNames.push_back(name);
    return shared_from_this();
}

NTURIBuilder::shared_pointer epics::nt::detail::NTURIBuilder::addAuthority

(

)

Adds authority field to the NTURI.

Returns

this instance of NTURIBuilder.

Definition at line 91 of file nturi.cpp.

{
    authority = true;
    return shared_from_this();
}

NTURIBuilder::shared_pointer epics::nt::detail::NTURIBuilder::addQueryDouble

(

std::string const &

name

)

Adds extra Scalar of ScalarType pvDouble to the query field of the type.

Parameters

name	name of the field.

Returns

this instance of NTURIBuilder.

Definition at line 35 of file nturi.cpp.

{
    if (std::find(queryFieldNames.begin(), queryFieldNames.end(), name) != queryFieldNames.end())
        throw std::runtime_error("duplicate query field name");

    queryFieldNames.push_back(name);
    queryTypes.push_back(pvDouble);

    return shared_from_this();
}

NTURIBuilder::shared_pointer epics::nt::detail::NTURIBuilder::addQueryInt

(

std::string const &

name

)

Adds extra Scalar of ScalarType pvInt to the query field of the type.

Parameters

name	name of the field.

Returns

this instance of NTURIBuilder.

Definition at line 46 of file nturi.cpp.

{
    if (std::find(queryFieldNames.begin(), queryFieldNames.end(), name) != queryFieldNames.end())
        throw std::runtime_error("duplicate query field name");

    queryFieldNames.push_back(name);
    queryTypes.push_back(pvInt);

    return shared_from_this();
}

NTURIBuilder::shared_pointer epics::nt::detail::NTURIBuilder::addQueryString

(

std::string const &

name

)

Adds extra Scalar of ScalarType pvString to the query field of the type.

Parameters

name	name of the field.

Returns

this instance of NTURIBuilder.

Definition at line 24 of file nturi.cpp.

{
    if (std::find(queryFieldNames.begin(), queryFieldNames.end(), name) != queryFieldNames.end())
        throw std::runtime_error("duplicate query field name");

    queryFieldNames.push_back(name);
    queryTypes.push_back(pvString);

    return shared_from_this();
}

NTURIPtr epics::nt::detail::NTURIBuilder::create

(

)

Creates a NTURI instance. The returned NTURI will wrap a PVStructure which will have labels equal to the column names. This resets this instance state and allows new instance to be created.

Returns

a new instance of NTURI.

Definition at line 102 of file nturi.cpp.

{
    return NTURIPtr(new NTURI(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTURIBuilder::createPVStructure

(

)

Creates a PVStructure that represents NTURI. The returned PVStructure will have labels equal to the column names. This resets this instance state and allows new instance to be created.

Returns

a new instance of PVStructure.

Definition at line 97 of file nturi.cpp.

{
    return getPVDataCreate()->createPVStructure(createStructure());
}

StructureConstPtr epics::nt::detail::NTURIBuilder::createStructure

(

)

Creates a Structure that represents NTURI. This resets this instance state and allows new instance to be created.

Returns

a new instance of Structure.

Definition at line 57 of file nturi.cpp.

{
    FieldBuilderPtr builder = getFieldCreate()->
        createFieldBuilder()->
        setId(NTURI::URI)->
        add("scheme", pvString);

    if (authority)
        builder->add("authority", pvString);

    builder->add("path", pvString);

    if (!queryFieldNames.empty())
    {
        FieldBuilderPtr nestedBuilder = builder->
             addNestedStructure("query");

        vector<string>::size_type len = queryFieldNames.size();
        for (vector<string>::size_type i = 0; i < len; i++)
            nestedBuilder->add(queryFieldNames[i], queryTypes[i]);

        builder = nestedBuilder->endNested();
    }

    size_t extraCount = extraFieldNames.size();
    for (size_t i = 0; i< extraCount; i++)
        builder->add(extraFieldNames[i], extraFields[i]);

    StructureConstPtr s = builder->createStructure();

    reset();
    return s;
}

epics::nt::detail::NTURIBuilder::POINTER_DEFINITIONS

(

NTURIBuilder

)

Friends And Related Function Documentation

friend class ::epics::nt::NTURI

friend

Definition at line 122 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