epics::nt::detail::NTScalarMultiChannelBuilder Class Reference

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

#include "ntscalarMultiChannel.h"

Inheritance diagram for epics::nt::detail::NTScalarMultiChannelBuilder:

Collaboration diagram for epics::nt::detail::NTScalarMultiChannelBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTScalarMultiChannelBuilder)
shared_pointer	value (epics::pvData::ScalarType scalarType)
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 ()
NTScalarMultiChannelPtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTScalarMultiChannel

Detailed Description

Interface for in-line creating of NTScalarMultiChannel.

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

mse

Definition at line 46 of file ntscalarMultiChannel.h.

Member Function Documentation

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

Definition at line 199 of file ntscalarMultiChannel.cpp.

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

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addAlarm

(

)

Adds alarm field to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 38 of file ntscalarMultiChannel.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addDescriptor

(

)

Adds descriptor field to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 32 of file ntscalarMultiChannel.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addIsConnected

(

)

Adds isConnected array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 86 of file ntscalarMultiChannel.cpp.

{
    isConnected = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addMessage

(

)

Adds message array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 62 of file ntscalarMultiChannel.cpp.

{
    message = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addNanoseconds

(

)

Adds nanoseconds array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 74 of file ntscalarMultiChannel.cpp.

{
    nanoseconds = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addSecondsPastEpoch

(

)

Adds secondsPastEpoch array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 68 of file ntscalarMultiChannel.cpp.

{
    secondsPastEpoch = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addSeverity

(

)

Adds severity array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 50 of file ntscalarMultiChannel.cpp.

{
    severity = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addStatus

(

)

Adds status array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 56 of file ntscalarMultiChannel.cpp.

{
    status = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 44 of file ntscalarMultiChannel.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::addUserTag

(

)

Adds userTag array to the NTScalarMultiChannel.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 80 of file ntscalarMultiChannel.cpp.

{
    userTag = true;
    return shared_from_this();
}

NTScalarMultiChannelPtr epics::nt::detail::NTScalarMultiChannelBuilder::create

(

)

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

Returns

a new instance of a NTScalarMultiChannel

Definition at line 170 of file ntscalarMultiChannel.cpp.

{
    return NTScalarMultiChannelPtr(new NTScalarMultiChannel(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTScalarMultiChannelBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure

Definition at line 165 of file ntscalarMultiChannel.cpp.

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

StructureConstPtr epics::nt::detail::NTScalarMultiChannelBuilder::createStructure

(

)

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

Returns

a new instance of a Structure.

Definition at line 92 of file ntscalarMultiChannel.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";
    fields[ind++] =  fieldCreate->createScalarArray(valueType);
    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(NTScalarMultiChannel::URI,names,fields);
    reset();
    return st;
}

epics::nt::detail::NTScalarMultiChannelBuilder::POINTER_DEFINITIONS

(

NTScalarMultiChannelBuilder

)

NTScalarMultiChannelBuilder::shared_pointer epics::nt::detail::NTScalarMultiChannelBuilder::value

(

epics::pvData::ScalarType

scalarType

)

Sets the scalar type for the value field. If this is not called then pvDouble is the default.

Parameters

scalarType

the value field element ScalarType.

Returns

this instance of NTScalarMultiChannelBuilder.

Definition at line 25 of file ntscalarMultiChannel.cpp.

{
    valueType = scalarType;
    return shared_from_this();
}

Friends And Related Function Documentation

friend class ::epics::nt::NTScalarMultiChannel

friend

Definition at line 170 of file ntscalarMultiChannel.h.

---

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

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