epics::nt::detail::NTHistogramBuilder Class Reference

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

#include "nthistogram.h"

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

Collaboration 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

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

Definition at line 107 of file nthistogram.cpp.

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

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.

{
    alarm = true;
    return shared_from_this();
}

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.

{
    descriptor = true;
    return shared_from_this();
}

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.

{
    timeStamp = true;
    return shared_from_this();
}

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.

{
    return NTHistogramPtr(new NTHistogram(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.

{
    return getPVDataCreate()->createPVStructure(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.

{
    if (!valueTypeSet)
        throw std::runtime_error("value array element type not set");

    FieldBuilderPtr builder =
            getFieldCreate()->createFieldBuilder()->
               setId(NTHistogram::URI)->
               addArray("ranges", pvDouble)->
               addArray("value", valueType);

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

    if (alarm)
        builder->add("alarm", ntField->createAlarm());

    if (timeStamp)
        builder->add("timeStamp", ntField->createTimeStamp());

    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::NTHistogramBuilder::POINTER_DEFINITIONS

(

NTHistogramBuilder

)

NTHistogramBuilder::shared_pointer epics::nt::detail::NTHistogramBuilder::value

(

epics::pvData::ScalarType

scalarType

)

Sets the scalar type of the value field array.

Parameters

scalarType

the scalar type of the value field array.

Returns

this instance of NTHistogramBuilder.

Definition at line 22 of file nthistogram.cpp.

{
    valueType = scalarType;
    valueTypeSet = true;

    return shared_from_this();
}

Friends And Related Function Documentation

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:

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