epics::nt::detail::NTAttributeBuilder Class Reference

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

#include "ntattribute.h"

Inheritance diagram for epics::nt::detail::NTAttributeBuilder:

Collaboration diagram for epics::nt::detail::NTAttributeBuilder:

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

Protected Member Functions
	NTAttributeBuilder ()
void	reset ()

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

Friends
class	::epics::nt::NTAttribute

Detailed Description

Interface for in-line creating of NTAttribute.

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 37 of file ntattribute.h.

Constructor & Destructor Documentation

epics::nt::detail::NTAttributeBuilder::NTAttributeBuilder ( )

protected

Definition at line 88 of file ntattribute.cpp.

{
    reset();
}

Member Function Documentation

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

Definition at line 102 of file ntattribute.cpp.

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

NTAttributeBuilder::shared_pointer epics::nt::detail::NTAttributeBuilder::addAlarm

(

)

Adds alarm field to the NTAttribute.

Returns

this instance of NTAttributeBuilder.

Definition at line 66 of file ntattribute.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTAttributeBuilder::shared_pointer epics::nt::detail::NTAttributeBuilder::addDescriptor

(

)

Adds descriptor field to the NTAttribute.

Returns

this instance of NTAttributeBuilder.

Definition at line 60 of file ntattribute.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTAttributeBuilder::shared_pointer epics::nt::detail::NTAttributeBuilder::addTags

(

)

Adds tags field to the NTAttribute.

Returns

this instance of NTAttributeBuilder.

Definition at line 54 of file ntattribute.cpp.

{
    tags = true;
    return shared_from_this();
}

NTAttributeBuilder::shared_pointer epics::nt::detail::NTAttributeBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTAttribute.

Returns

this instance of NTAttributeBuilder.

Definition at line 72 of file ntattribute.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTAttributePtr epics::nt::detail::NTAttributeBuilder::create

(

)

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

Returns

a new instance of a NTAttribute.

Definition at line 83 of file ntattribute.cpp.

{
    return NTAttributePtr(new NTAttribute(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTAttributeBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure.

Definition at line 78 of file ntattribute.cpp.

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

StructureConstPtr epics::nt::detail::NTAttributeBuilder::createStructure

(

)

Creates a Structure that represents NTAttribute. 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 ntattribute.cpp.

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

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

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

(

NTAttributeBuilder

)

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

protected

Definition at line 93 of file ntattribute.cpp.

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

Friends And Related Function Documentation

friend class ::epics::nt::NTAttribute

friend

Definition at line 110 of file ntattribute.h.

Member Data Documentation

bool epics::nt::detail::NTAttributeBuilder::alarm

protected

Definition at line 103 of file ntattribute.h.

bool epics::nt::detail::NTAttributeBuilder::descriptor

protected

Definition at line 102 of file ntattribute.h.

epics::pvData::StringArray epics::nt::detail::NTAttributeBuilder::extraFieldNames

protected

Definition at line 107 of file ntattribute.h.

epics::pvData::FieldConstPtrArray epics::nt::detail::NTAttributeBuilder::extraFields

protected

Definition at line 108 of file ntattribute.h.

bool epics::nt::detail::NTAttributeBuilder::tags

protected

Definition at line 101 of file ntattribute.h.

bool epics::nt::detail::NTAttributeBuilder::timeStamp

protected

Definition at line 104 of file ntattribute.h.

---

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

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