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

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

#include <nthistogram.h>

Inheritance diagram for epics::nt::detail::NTHistogramBuilder:

Public Member Functions

 POINTER_DEFINITIONS (NTHistogramBuilder)
 
shared_pointer value (epics::pvData::ScalarType scalarType)
 
shared_pointer addDescriptor ()
 
shared_pointer addAlarm ()
 
shared_pointer addTimeStamp ()
 
epics::pvData::StructureConstPtr createStructure ()
 
epics::pvData::PVStructurePtr createPVStructure ()
 
NTHistogramPtr create ()
 
shared_pointer add (std::string const &name, epics::pvData::FieldConstPtr const &field)
 

Friends

class ::epics::nt::NTHistogram
 

Detailed Description

Interface for in-line creating of NTHistogram.

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 38 of file nthistogram.h.

Member Function Documentation

◆ add()

NTHistogramBuilder::shared_pointer epics::nt::detail::NTHistogramBuilder::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 NTHistogramBuilder.

Definition at line 107 of file nthistogram.cpp.

◆ addAlarm()

NTHistogramBuilder::shared_pointer epics::nt::detail::NTHistogramBuilder::addAlarm ( )

Adds alarm field to the NTHistogram.

Returns
this instance of NTHistogramBuilder.

Definition at line 69 of file nthistogram.cpp.

◆ addDescriptor()

NTHistogramBuilder::shared_pointer epics::nt::detail::NTHistogramBuilder::addDescriptor ( )

Adds descriptor field to the NTHistogram.

Returns
this instance of NTHistogramBuilder.

Definition at line 63 of file nthistogram.cpp.

◆ addTimeStamp()

NTHistogramBuilder::shared_pointer epics::nt::detail::NTHistogramBuilder::addTimeStamp ( )

Adds timeStamp field to the NTHistogram.

Returns
this instance of NTHistogramBuilder.

Definition at line 75 of file nthistogram.cpp.

◆ create()

NTHistogramPtr epics::nt::detail::NTHistogramBuilder::create ( )

Creates a NTHistogram instance. This resets this instance state and allows new instance to be created.

Returns
a new instance of NTHistogram.

Definition at line 87 of file nthistogram.cpp.

◆ createPVStructure()

PVStructurePtr epics::nt::detail::NTHistogramBuilder::createPVStructure ( )

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

Returns
a new instance of PVStructure.

Definition at line 82 of file nthistogram.cpp.

◆ createStructure()

StructureConstPtr epics::nt::detail::NTHistogramBuilder::createStructure ( )

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

Returns
a new instance of Structure.

Definition at line 32 of file nthistogram.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTHistogramBuilder::POINTER_DEFINITIONS ( NTHistogramBuilder  )

◆ value()

NTHistogramBuilder::shared_pointer epics::nt::detail::NTHistogramBuilder::value ( epics::pvData::ScalarType  scalarType)

Sets the scalar type of the value field array.

Parameters
scalarTypethe scalar type of the value field array.
Returns
this instance of NTHistogramBuilder.

Definition at line 22 of file nthistogram.cpp.

Friends And Related Function Documentation

◆ ::epics::nt::NTHistogram

friend class ::epics::nt::NTHistogram
friend

Definition at line 114 of file nthistogram.h.


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