epics::nt::detail::NTUnionBuilder Class Reference

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

#include "ntunion.h"

Inheritance diagram for epics::nt::detail::NTUnionBuilder:

Collaboration diagram for epics::nt::detail::NTUnionBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTUnionBuilder)
shared_pointer	value (epics::pvData::UnionConstPtr unionType)
shared_pointer	addDescriptor ()
shared_pointer	addAlarm ()
shared_pointer	addTimeStamp ()
epics::pvData::StructureConstPtr	createStructure ()
epics::pvData::PVStructurePtr	createPVStructure ()
NTUnionPtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTUnion

Detailed Description

Interface for in-line creating of NTUnion.

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

Member Function Documentation

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

Definition at line 99 of file ntunion.cpp.

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

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::addAlarm

(

)

Adds alarm field to the NTUnion.

Returns

this instance of NTUnionBuilder.

Definition at line 62 of file ntunion.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::addDescriptor

(

)

Adds descriptor field to the NTUnion.

Returns

this instance of NTUnionBuilder.

Definition at line 56 of file ntunion.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTUnion.

Returns

this instance of NTUnionBuilder.

Definition at line 68 of file ntunion.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTUnionPtr epics::nt::detail::NTUnionBuilder::create

(

)

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

Returns

a new instance of a NTUnion.

Definition at line 79 of file ntunion.cpp.

{
    return NTUnionPtr(new NTUnion(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTUnionBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure.

Definition at line 74 of file ntunion.cpp.

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

StructureConstPtr epics::nt::detail::NTUnionBuilder::createStructure

(

)

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

Returns

a new instance of a Structure.

Definition at line 29 of file ntunion.cpp.

{
    FieldBuilderPtr builder =
            getFieldCreate()->createFieldBuilder()->
               setId(NTUnion::URI)->
               add("value", valueType);

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

(

NTUnionBuilder

)

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::value

(

epics::pvData::UnionConstPtr

unionType

)

Specifies the union for the value field. If this is not called then a variant union is the default.

Parameters

unionType

the introspection object for the union value field

Returns

this instance of NTUnionBuilder

Definition at line 23 of file ntunion.cpp.

{
    valueType = unionType;
    return shared_from_this();
}

Friends And Related Function Documentation

friend class ::epics::nt::NTUnion

friend

Definition at line 112 of file ntunion.h.

---

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

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