epics::nt::detail::NTNDArrayAttributeBuilder Class Reference

Interface for in-line creating of NTAttribute extended as required by NTNDArray. More...

#include "ntndarrayAttribute.h"

Inheritance diagram for epics::nt::detail::NTNDArrayAttributeBuilder:

Collaboration diagram for epics::nt::detail::NTNDArrayAttributeBuilder:

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

Protected Member Functions
	NTNDArrayAttributeBuilder ()
void	reset ()

Protected Attributes
bool	tags
bool	descriptor
bool	alarm
bool	timeStamp
epics::pvData::StringArray	extraFieldNames
epics::pvData::FieldConstPtrArray	extraFields

Friends
class	::epics::nt::NTNDArrayAttribute

Detailed Description

Interface for in-line creating of NTAttribute extended as required by 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

dgh

Definition at line 38 of file ntndarrayAttribute.h.

Constructor & Destructor Documentation

epics::nt::detail::NTNDArrayAttributeBuilder::NTNDArrayAttributeBuilder ( )

protected

Definition at line 91 of file ntndarrayAttribute.cpp.

{
    reset();
}

Member Function Documentation

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

Definition at line 106 of file ntndarrayAttribute.cpp.

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

NTNDArrayAttributeBuilder::shared_pointer epics::nt::detail::NTNDArrayAttributeBuilder::addAlarm

(

)

Adds alarm field to the NTNDArrayAttribute.

Returns

this instance of NTNDArrayAttributeBuilder.

Definition at line 69 of file ntndarrayAttribute.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTNDArrayAttributeBuilder::shared_pointer epics::nt::detail::NTNDArrayAttributeBuilder::addDescriptor

(

)

Adds descriptor field to the NTNDArrayAttribute.

Returns

this instance of NTNDArrayAttributeBuilder.

Definition at line 63 of file ntndarrayAttribute.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTNDArrayAttributeBuilder::shared_pointer epics::nt::detail::NTNDArrayAttributeBuilder::addTags

(

)

Adds tags field to the NTNDArrayAttribute.

Returns

this instance of NTNDArrayAttributeBuilder.

Definition at line 57 of file ntndarrayAttribute.cpp.

{
    tags = true;
    return shared_from_this();
}

NTNDArrayAttributeBuilder::shared_pointer epics::nt::detail::NTNDArrayAttributeBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTNDArrayAttribute.

Returns

this instance of NTNDArrayAttributeBuilder.

Definition at line 75 of file ntndarrayAttribute.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTNDArrayAttributePtr epics::nt::detail::NTNDArrayAttributeBuilder::create

(

)

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

Returns

a new instance of a NTNDArrayAttribute.

Definition at line 86 of file ntndarrayAttribute.cpp.

{
    return NTNDArrayAttributePtr(new NTNDArrayAttribute(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTNDArrayAttributeBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure.

Definition at line 81 of file ntndarrayAttribute.cpp.

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

StructureConstPtr epics::nt::detail::NTNDArrayAttributeBuilder::createStructure

(

)

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

Returns

a new instance of a Structure.

Definition at line 23 of file ntndarrayAttribute.cpp.

{
    FieldBuilderPtr builder =
            getFieldCreate()->createFieldBuilder()->
               setId(NTNDArrayAttribute::URI)->
               add("name", pvString)->
               add("value", getFieldCreate()->createVariantUnion());

    if (tags)
        builder->addArray("tags", pvString);

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

    builder->add("sourceType", pvInt);

    builder->add("source", 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::NTNDArrayAttributeBuilder::POINTER_DEFINITIONS

(

NTNDArrayAttributeBuilder

)

void epics::nt::detail::NTNDArrayAttributeBuilder::reset ( )

protected

Definition at line 96 of file ntndarrayAttribute.cpp.

{
    tags = false;
    descriptor = false;
    alarm = false;
    timeStamp = false;
    extraFieldNames.clear();
    extraFields.clear();
}

Friends And Related Function Documentation

friend class ::epics::nt::NTNDArrayAttribute

friend

Definition at line 111 of file ntndarrayAttribute.h.

Member Data Documentation

bool epics::nt::detail::NTNDArrayAttributeBuilder::alarm

protected

Definition at line 104 of file ntndarrayAttribute.h.

bool epics::nt::detail::NTNDArrayAttributeBuilder::descriptor

protected

Definition at line 103 of file ntndarrayAttribute.h.

epics::pvData::StringArray epics::nt::detail::NTNDArrayAttributeBuilder::extraFieldNames

protected

Definition at line 108 of file ntndarrayAttribute.h.

epics::pvData::FieldConstPtrArray epics::nt::detail::NTNDArrayAttributeBuilder::extraFields

protected

Definition at line 109 of file ntndarrayAttribute.h.

bool epics::nt::detail::NTNDArrayAttributeBuilder::tags

protected

Definition at line 102 of file ntndarrayAttribute.h.

bool epics::nt::detail::NTNDArrayAttributeBuilder::timeStamp

protected

Definition at line 105 of file ntndarrayAttribute.h.

---

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

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