Class that represents the context of an operator. More...

Detailed Description

Class that represents the context of an operator.

Member Function Documentation

◆ getName()

Get the physical name of the operator.

Returns
the physical name of the operator

◆ getClassName()

Get the name of the C++ class corresponding to the operator.

Returns
the name of the C++ class corresponding to the operator

◆ getPE()

Get the processing element hosting this operator.

Returns
processing element hosting this operator

◆ getIndex()

Get the index of the operator within the PE.

Returns
index of the operator within the PE

◆ getMetrics()

Get the operator metrics.

Returns
operator metrics

◆ isProfilingOn()

Check if this operator is running with profiling turned on Profiling is not supported as of Streams version 4.2.

Returns
false

◆ getProfilingBufferSize()

Get the reservoir size used for profiling this operator Profiling is not supported as of Streams version 4.2.

Returns
0

◆ getProfilingSamplingRate()

Get the sampling rate used for profiling this operator Profiling is not supported as of Streams version 4.2.

Returns
0.0

◆ isCheckpointingOn()

Check if operator checkpoiting is on.

Returns
true if this operator is running with checkpointing turned on, false otherwise

◆ getCheckpointingInterval()

Get the checkpointing interval for the operator.

Returns
the checkpointing interval for the operator (<0 if the operator is not performing periodic checkpointing)

◆ getLogicalName()

Get the logical name of the operator.

Returns
the logical name of the operator

◆ getChannel()

Get the parallel region channel number the operator is in.

Note that in the context of a nested parallel region the range of indexes considers replicated nested regions.

Returns
parallel region channel number the operaotr is in

◆ getMaxChannels()

Get the maximum number of channels in the current parallel region.

Note that in the context of a nested parallel region the range of indexes considers replicated nested regions.

Returns
maximum number of channels in the current parallel region

◆ getLocalChannel()

Get the parallel region channel number the operator is in.

Note that in the context of nested parallel regions the returned index does not consider replicated nested regions.

Returns
parallel region channel number the operaotr is in

◆ getLocalMaxChannels()

Get the maximum number of channels in the current parallel region.

Note that in the context of nested parallel regions the returned index does not consider replicated nested regions.

Returns
maximum number of channels in the current parallel region

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