epics::nt::detail::NTTableBuilder Class Reference

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

#include "nttable.h"

Inheritance diagram for epics::nt::detail::NTTableBuilder:

Collaboration diagram for epics::nt::detail::NTTableBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTTableBuilder)
shared_pointer	addColumn (std::string const &name, epics::pvData::ScalarType elementType)
shared_pointer	addDescriptor ()
shared_pointer	addAlarm ()
shared_pointer	addTimeStamp ()
epics::pvData::StructureConstPtr	createStructure ()
epics::pvData::PVStructurePtr	createPVStructure ()
NTTablePtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTTable

Detailed Description

Interface for in-line creating of NTTable.

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

mse

Definition at line 43 of file nttable.h.

Member Function Documentation

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

Definition at line 119 of file nttable.cpp.

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

NTTableBuilder::shared_pointer epics::nt::detail::NTTableBuilder::addAlarm

(

)

Adds alarm field to the NTTable.

Returns

this instance of NTTableBuilder.

Definition at line 77 of file nttable.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTTableBuilder::shared_pointer epics::nt::detail::NTTableBuilder::addColumn	(	std::string const &	name,
		epics::pvData::ScalarType	elementType
	)

Adds a column of given Scalar type.

Parameters

name	name of the column.
elementType	column type, a scalar array.

Returns

this instance of NTTableBuilder.

Definition at line 23 of file nttable.cpp.

{
    if (std::find(columnNames.begin(), columnNames.end(), name) != columnNames.end())
        throw std::runtime_error("duplicate column name");

    columnNames.push_back(name);
    types.push_back(scalarType);

    return shared_from_this();
}

NTTableBuilder::shared_pointer epics::nt::detail::NTTableBuilder::addDescriptor

(

)

Adds descriptor field to the NTTable.

Returns

this instance of NTTableBuilder.

Definition at line 71 of file nttable.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTTableBuilder::shared_pointer epics::nt::detail::NTTableBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTTable.

Returns

this instance of NTTableBuilder.

Definition at line 83 of file nttable.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTTablePtr epics::nt::detail::NTTableBuilder::create

(

)

Creates a NTTable instance. The returned NTTable 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 NTTable.

Definition at line 100 of file nttable.cpp.

{
    return NTTablePtr(new NTTable(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTTableBuilder::createPVStructure

(

)

Creates a PVStructure that represents NTTable. 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 89 of file nttable.cpp.

{
    // fill in labels with default values (the column names)
    size_t len = columnNames.size();
    shared_vector<string> l(len);
    for(size_t i=0; i<len; ++i) l[i] = columnNames[i];
    PVStructurePtr s = getPVDataCreate()->createPVStructure(createStructure());
    s->getSubField<PVStringArray>("labels")->replace(freeze(l));
    return s;
}

StructureConstPtr epics::nt::detail::NTTableBuilder::createStructure

(

)

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

Returns

a new instance of Structure.

Definition at line 36 of file nttable.cpp.

{
    FieldBuilderPtr builder = getFieldCreate()->createFieldBuilder();

    FieldBuilderPtr nestedBuilder =
            builder->
               setId(NTTable::URI)->
               addArray("labels", pvString)->
               addNestedStructure("value");

    vector<string>::size_type len = columnNames.size();
    for (vector<string>::size_type i = 0; i < len; i++)
        nestedBuilder->addArray(columnNames[i], types[i]);

    builder = nestedBuilder->endNested();

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

(

NTTableBuilder

)

Friends And Related Function Documentation

friend class ::epics::nt::NTTable

friend

Definition at line 123 of file nttable.h.

---

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

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