epics::nt::detail::NTNDArrayBuilder Class Reference

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

#include "ntndarray.h"

Inheritance diagram for epics::nt::detail::NTNDArrayBuilder:

Collaboration diagram for epics::nt::detail::NTNDArrayBuilder:

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

Friends
class	::epics::nt::NTNDArray

Detailed Description

Interface for in-line creating of NTNDArray.

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

Member Function Documentation

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::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 a NTArrayBuilder.

Definition at line 189 of file ntndarray.cpp.

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

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::addAlarm

(

)

Adds alarm field to the NTNDArray.

Returns

this instance of NTNDArrayBuilder.

Definition at line 146 of file ntndarray.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::addDescriptor

(

)

Adds descriptor field to the NTNDArray.

Returns

this instance of NTNDArrayBuilder.

Definition at line 140 of file ntndarray.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::addDisplay

(

)

Adds display field to the NTNDArray.

Returns

this instance of NTNDArrayBuilder.

Definition at line 158 of file ntndarray.cpp.

{
    display = true;
    return shared_from_this();
}

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTNDArray.

Returns

this instance of NTNDArrayBuilder.

Definition at line 152 of file ntndarray.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTNDArrayPtr epics::nt::detail::NTNDArrayBuilder::create

(

)

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

Returns

a new instance of a NTNDArray

Definition at line 169 of file ntndarray.cpp.

{
    return NTNDArrayPtr(new NTNDArray(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTNDArrayBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure

Definition at line 164 of file ntndarray.cpp.

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

StructureConstPtr epics::nt::detail::NTNDArrayBuilder::createStructure

(

)

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

Returns

a new instance of a Structure.

Definition at line 31 of file ntndarray.cpp.

{
    enum
    {
        DISCRIPTOR_INDEX,
        TIMESTAMP_INDEX,
        ALARM_INDEX,
        DISPLAY_INDEX
    };

    const size_t NUMBER_OF_INDICES = DISPLAY_INDEX+1;
    const size_t NUMBER_OF_STRUCTURES = 1 << NUMBER_OF_INDICES;

    Lock xx(mutex);

    static StructureConstPtr ntndarrayStruc[NUMBER_OF_STRUCTURES];
    static UnionConstPtr valueType;
    static StructureConstPtr codecStruc;
    static StructureConstPtr dimensionStruc;
    static StructureConstPtr attributeStruc;

    StructureConstPtr returnedStruc;

    size_t index = 0;
    if (descriptor) index  |= 1 << DISCRIPTOR_INDEX;
    if (timeStamp)  index  |= 1 << TIMESTAMP_INDEX;
    if (alarm)      index  |= 1 << ALARM_INDEX;
    if (display)    index  |= 1 << DISPLAY_INDEX;

    bool isExtended = !extraFieldNames.empty();

    if (isExtended || !ntndarrayStruc[index])
    {
        StandardFieldPtr standardField = getStandardField();
        FieldBuilderPtr fb = fieldCreate->createFieldBuilder();

        if (!valueType)
        {
            for (int i = pvBoolean; i < pvString; ++i)
            {
                ScalarType st = static_cast<ScalarType>(i);
                fb->addArray(std::string(ScalarTypeFunc::name(st)) + "Value", st);
            }
            valueType = fb->createUnion();
        }

        if (!codecStruc)
        {
            codecStruc = fb->setId("codec_t")->
                add("name", pvString)->
                add("parameters", fieldCreate->createVariantUnion())->
                createStructure();
        }

        if (!dimensionStruc)
        {
            dimensionStruc = fb->setId("dimension_t")->
                add("size", pvInt)->
                add("offset",  pvInt)->
                add("fullSize",  pvInt)->
                add("binning",  pvInt)->
                add("reverse",  pvBoolean)->
                createStructure();
        }

        if (!attributeStruc)
        {
            attributeStruc = NTNDArrayAttribute::createBuilder()->createStructure();
        }

        fb->setId(NTNDArray::URI)->
            add("value", valueType)->
            add("codec", codecStruc)->
            add("compressedSize", pvLong)->
            add("uncompressedSize", pvLong)->
            addArray("dimension", dimensionStruc)->
            add("uniqueId", pvInt)->
            add("dataTimeStamp", standardField->timeStamp())->
            addArray("attribute", attributeStruc);

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

        if (alarm)
            fb->add("alarm", standardField->alarm());

        if (timeStamp)
            fb->add("timeStamp", standardField->timeStamp());

        if (display)
            fb->add("display", standardField->display());

        size_t extraCount = extraFieldNames.size();
        for (size_t i = 0; i< extraCount; i++)
            fb->add(extraFieldNames[i], extraFields[i]);

        returnedStruc = fb->createStructure();

        if (!isExtended)
            ntndarrayStruc[index] = returnedStruc;
    }
    else
    {
        return ntndarrayStruc[index];
    }

    return returnedStruc;
}

epics::nt::detail::NTNDArrayBuilder::POINTER_DEFINITIONS

(

NTNDArrayBuilder

)

Friends And Related Function Documentation

friend class ::epics::nt::NTNDArray

friend

Definition at line 116 of file ntndarray.h.

---

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

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