epics::nt::detail::NTMatrixBuilder Class Reference

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

#include "ntmatrix.h"

Inheritance diagram for epics::nt::detail::NTMatrixBuilder:

Collaboration diagram for epics::nt::detail::NTMatrixBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTMatrixBuilder)
shared_pointer	addDim ()
shared_pointer	addDescriptor ()
shared_pointer	addAlarm ()
shared_pointer	addTimeStamp ()
shared_pointer	addDisplay ()
epics::pvData::StructureConstPtr	createStructure ()
epics::pvData::PVStructurePtr	createPVStructure ()
NTMatrixPtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTMatrix

Detailed Description

Interface for in-line creating of NTMatrix.

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 ntmatrix.h.

Member Function Documentation

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

Definition at line 111 of file ntmatrix.cpp.

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

NTMatrixBuilder::shared_pointer epics::nt::detail::NTMatrixBuilder::addAlarm

(

)

Adds alarm field to the NTMatrix.

Returns

this instance of NTMatrixBuilder.

Definition at line 67 of file ntmatrix.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTMatrixBuilder::shared_pointer epics::nt::detail::NTMatrixBuilder::addDescriptor

(

)

Adds descriptor field to the NTMatrix.

Returns

this instance of NTMatrixBuilder.

Definition at line 61 of file ntmatrix.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTMatrixBuilder::shared_pointer epics::nt::detail::NTMatrixBuilder::addDim

(

)

Adds dimension field to the NTMatrix.

Returns

this instance of NTMatrixBuilder.

Definition at line 55 of file ntmatrix.cpp.

{
    dim = true;
    return shared_from_this();
}

NTMatrixBuilder::shared_pointer epics::nt::detail::NTMatrixBuilder::addDisplay

(

)

Adds display field to the NTMatrix.

Returns

this instance of NTMatrixBuilder.

Definition at line 79 of file ntmatrix.cpp.

{
    display = true;
    return shared_from_this();
}

NTMatrixBuilder::shared_pointer epics::nt::detail::NTMatrixBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTMatrix.

Returns

this instance of NTMatrixBuilder.

Definition at line 73 of file ntmatrix.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTMatrixPtr epics::nt::detail::NTMatrixBuilder::create

(

)

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

Returns

a new instance of NTMatrix.

Definition at line 90 of file ntmatrix.cpp.

{
    return NTMatrixPtr(new NTMatrix(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTMatrixBuilder::createPVStructure

(

)

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

Returns

a new instance of PVStructure.

Definition at line 85 of file ntmatrix.cpp.

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

StructureConstPtr epics::nt::detail::NTMatrixBuilder::createStructure

(

)

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

Returns

a new instance of Structure.

Definition at line 22 of file ntmatrix.cpp.

{
    FieldBuilderPtr builder =
            getFieldCreate()->createFieldBuilder()->
               setId(NTMatrix::URI)->
               addArray("value", pvDouble);

    if (dim)
        builder->addArray("dim", pvInt);

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

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

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

    if (display)
        builder->add("display", ntField->createDisplay());

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

(

NTMatrixBuilder

)

Friends And Related Function Documentation

friend class ::epics::nt::NTMatrix

friend

Definition at line 120 of file ntmatrix.h.

---

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

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