normativeTypesCPP
Public Member Functions | Friends | List of all members
epics::nt::detail::NTURIBuilder Class Reference

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

#include <nturi.h>

Inheritance 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

◆ add()

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

Adds extra Field to the type.

Parameters
namethe name of the field.
fieldthe field to be added.
Returns
this instance of NTURIBuilder.

Definition at line 119 of file nturi.cpp.

◆ addAuthority()

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.

◆ addQueryDouble()

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
namename of the field.
Returns
this instance of NTURIBuilder.

Definition at line 35 of file nturi.cpp.

◆ addQueryInt()

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
namename of the field.
Returns
this instance of NTURIBuilder.

Definition at line 46 of file nturi.cpp.

◆ addQueryString()

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
namename of the field.
Returns
this instance of NTURIBuilder.

Definition at line 24 of file nturi.cpp.

◆ create()

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.

◆ 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.

◆ 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.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTURIBuilder::POINTER_DEFINITIONS ( NTURIBuilder  )

Friends And Related Function Documentation

◆ ::epics::nt::NTURI

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: