epics::nt::detail::NTMultiChannelBuilder Class Reference

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

#include "ntmultiChannel.h"

Inheritance diagram for epics::nt::detail::NTMultiChannelBuilder:

Collaboration diagram for epics::nt::detail::NTMultiChannelBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTMultiChannelBuilder)
shared_pointer	value (epics::pvData::UnionConstPtr valuePtr)
shared_pointer	addDescriptor ()
shared_pointer	addAlarm ()
shared_pointer	addTimeStamp ()
shared_pointer	addSeverity ()
shared_pointer	addStatus ()
shared_pointer	addMessage ()
shared_pointer	addSecondsPastEpoch ()
shared_pointer	addNanoseconds ()
shared_pointer	addUserTag ()
shared_pointer	addIsConnected ()
epics::pvData::StructureConstPtr	createStructure ()
epics::pvData::PVStructurePtr	createPVStructure ()
NTMultiChannelPtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTMultiChannel

Detailed Description

Interface for in-line creating of NTMultiChannel.

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 45 of file ntmultiChannel.h.

Member Function Documentation

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

Definition at line 204 of file ntmultiChannel.cpp.

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

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addAlarm

(

)

Adds alarm field to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 40 of file ntmultiChannel.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addDescriptor

(

)

Adds descriptor field to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 34 of file ntmultiChannel.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addIsConnected

(

)

Adds isConnected array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 88 of file ntmultiChannel.cpp.

{
    isConnected = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addMessage

(

)

Adds message array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 64 of file ntmultiChannel.cpp.

{
    message = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addNanoseconds

(

)

Adds nanoseconds array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 76 of file ntmultiChannel.cpp.

{
    nanoseconds = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addSecondsPastEpoch

(

)

Adds secondsPastEpoch array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 70 of file ntmultiChannel.cpp.

{
    secondsPastEpoch = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addSeverity

(

)

Adds severity array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 52 of file ntmultiChannel.cpp.

{
    severity = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addStatus

(

)

Adds status array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 58 of file ntmultiChannel.cpp.

{
    status = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 46 of file ntmultiChannel.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::addUserTag

(

)

Adds userTag array to the NTMultiChannel.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 82 of file ntmultiChannel.cpp.

{
    userTag = true;
    return shared_from_this();
}

NTMultiChannelPtr epics::nt::detail::NTMultiChannelBuilder::create

(

)

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

Returns

a new instance of a NTMultiChannel

Definition at line 176 of file ntmultiChannel.cpp.

{
    return NTMultiChannelPtr(new NTMultiChannel(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTMultiChannelBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure

Definition at line 171 of file ntmultiChannel.cpp.

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

StructureConstPtr epics::nt::detail::NTMultiChannelBuilder::createStructure

(

)

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

Returns

a new instance of a Structure.

Definition at line 94 of file ntmultiChannel.cpp.

{
    StandardFieldPtr standardField = getStandardField();
    size_t nfields = 2;
    size_t extraCount = extraFieldNames.size();
    nfields += extraCount;
    if(descriptor) ++nfields;
    if(alarm) ++nfields;
    if(timeStamp) ++nfields;
    if(severity) ++nfields;
    if(status) ++nfields;
    if(message) ++nfields;
    if(secondsPastEpoch) ++nfields;
    if(nanoseconds) ++nfields;
    if(userTag) ++nfields;
    if(isConnected) ++nfields;
    FieldConstPtrArray fields(nfields);
    StringArray names(nfields);
    size_t ind = 0;
    names[ind] = "value";
    if(valueType) {
        fields[ind++] =  fieldCreate->createUnionArray(valueType);
    } else {
        fields[ind++] =  fieldCreate->createVariantUnionArray();
    }
    names[ind] = "channelName";
    fields[ind++] =  fieldCreate->createScalarArray(pvString);
    if(descriptor) {
        names[ind] = "descriptor";
        fields[ind++] = fieldCreate->createScalar(pvString);
    }
    if(alarm) {
        names[ind] = "alarm";
        fields[ind++] = standardField->alarm();
    }
    if(timeStamp) {
        names[ind] = "timeStamp";
        fields[ind++] = standardField->timeStamp();
    }
    if(severity) {
        names[ind] = "severity";
        fields[ind++] = fieldCreate->createScalarArray(pvInt);
    }
    if(status) {
        names[ind] = "status";
        fields[ind++] = fieldCreate->createScalarArray(pvInt);
    }
    if(message) {
        names[ind] = "message";
        fields[ind++] = fieldCreate->createScalarArray(pvString);
    }
    if(secondsPastEpoch) {
        names[ind] = "secondsPastEpoch";
        fields[ind++] = fieldCreate->createScalarArray(pvLong);
    }
    if(nanoseconds) {
        names[ind] = "nanoseconds";
        fields[ind++] = fieldCreate->createScalarArray(pvInt);
    }
    if(userTag) {
        names[ind] = "userTag";
        fields[ind++] = fieldCreate->createScalarArray(pvInt);
    }
    if(isConnected) {
        names[ind] = "isConnected";
        fields[ind++] =  fieldCreate->createScalarArray(pvBoolean);
    }
    for (size_t i = 0; i< extraCount; i++) {
        names[ind] = extraFieldNames[i];
        fields[ind++] = extraFields[i];
    }

    StructureConstPtr st = fieldCreate->createStructure(NTMultiChannel::URI,names,fields);
    reset();
    return st;
}

epics::nt::detail::NTMultiChannelBuilder::POINTER_DEFINITIONS

(

NTMultiChannelBuilder

)

NTMultiChannelBuilder::shared_pointer epics::nt::detail::NTMultiChannelBuilder::value

(

epics::pvData::UnionConstPtr

valuePtr

)

specify the union for the value field. If this is not called then a variantUnion is the default.

Returns

this instance of NTMultiChannelBuilder.

Definition at line 27 of file ntmultiChannel.cpp.

{
    valueType = valuePtr;
    return shared_from_this();
}

Friends And Related Function Documentation

friend class ::epics::nt::NTMultiChannel

friend

Definition at line 167 of file ntmultiChannel.h.

---

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

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