morpheus.stages.boundary.linear_boundary_stage.LinearBoundaryIngressStage

Bases: morpheus.pipeline.preallocator_mixin.PreallocatorMixin, morpheus.pipeline.single_output_source.SingleOutputSource

The LinearBoundaryIngressStage acts as source ingress point from a corresponding egress in another linear segment. Given an existing linear pipeline that we want to connect to another segment, a linear boundary egress stage would be added to it and a matching LinearBoundaryIngressStage would be created to receive the egress point.

Parameters:

cmorpheus.config.Config

Pipeline configuration instance.

boundary_port_idstr

String corresponding to the name of the LinearBoundaryEgressStage’s egress port, use to identify and connect with the appropriate egress.

data_typeobject

Data type that this Stage will accept, which will correspond to some existing egress output.

Examples

            

            
>>> boundary_ingress = LinearBoundaryIngressStage(config, "my_boundary_port", int)
        

Attributes:

has_multi_input_ports

Indicates if this stage has multiple input ports.

has_multi_output_ports

Indicates if this stage has multiple output ports.

input_count

Return None for no max intput count.

input_ports

Input ports to this stage.

is_built

Indicates if this stage has been built.

name

The name of the stage.

output_ports

Output ports from this stage.

unique_name

Unique name of stage.

Methods

_build(builder, in_ports_streams)[source]

This function is responsible for constructing this stage’s internal mrc.SegmentObject object. The input of this function contains the returned value from the upstream stage.

The input values are the mrc.Builder for this stage and a StreamPair tuple which contain the input mrc.SegmentObject object and the message data type.

Parameters:

buildermrc.Builder

mrc.Builder object for the pipeline. This should be used to construct/attach the internal mrc.SegmentObject.

in_ports_streamsmorpheus.pipeline.pipeline.StreamPair

List of tuples containing the input mrc.SegmentObject object and the message data type.

Returns:

typing.List[morpheus.pipeline.pipeline.StreamPair]

List of tuples containing the output mrc.SegmentObject object from this stage and the message data type.

_build_source(builder)[source]

Abstract method all derived Source classes should implement. Returns the same value as build.

Returns:

morpheus.pipeline.pipeline.StreamPair:

A tuple containing the output mrc.SegmentObject object from this stage and the message data type.

accepted_types()[source]

Accepted input types for this stage are returned.

Returns:

typing.Tuple

Accepted input types.

build(builder, do_propagate=True)[source]

Build this stage.

Parameters:

buildermrc.Builder

MRC segment for this stage.

do_propagatebool, optional

Whether to propagate to build output stages, by default True.

can_build(check_ports=False)[source]

Determines if all inputs have been built allowing this node to be built.

Parameters:

check_portsbool, optional

Check if we can build based on the input ports, by default False.

Returns:

bool

True if we can build, False otherwise.

get_all_input_stages()[source]

Get all input stages to this stage.

Returns:

typing.List[morpheus.pipeline.pipeline.StreamWrapper]

All input stages.

get_all_inputs()[source]

Get all input senders to this stage.

Returns:

typing.List[morpheus.pipeline.pipeline.Sender]

All input senders.

get_all_output_stages()[source]

Get all output stages from this stage.

Returns:

typing.List[morpheus.pipeline.pipeline.StreamWrapper]

All output stages.

get_all_outputs()[source]

Get all output receivers from this stage.

Returns:

typing.List[morpheus.pipeline.pipeline.Receiver]

All output receivers.

get_needed_columns()[source]

Stages which need to have columns inserted into the dataframe, should populate the self._needed_columns dictionary with mapping of column names to morpheus.common.TypeId. This will ensure that the columns are allocated and populated with null values.

property has_multi_input_ports: bool

Indicates if this stage has multiple input ports.

Returns:

bool

True if stage has multiple input ports, False otherwise.

property has_multi_output_ports: bool

Indicates if this stage has multiple output ports.

Returns:

bool

True if stage has multiple output ports, False otherwise.

property input_count: int

Return None for no max intput count.

Returns:

int

Input count.

property input_ports: List[morpheus.pipeline.receiver.Receiver]

Input ports to this stage.

Returns:

typing.List[morpheus.pipeline.pipeline.Receiver]

Input ports to this stage.

property is_built: bool

Indicates if this stage has been built.

Returns:

bool

True if stage is built, False otherwise.

async join()[source]

Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped. Typically this is called after stop during a graceful shutdown, but may not be called if the pipeline is terminated on its own.

property name: str

The name of the stage. Used in logging. Each derived class should override this property with a unique name.

Returns:

str

Name of a stage.

property output_ports: List[morpheus.pipeline.sender.Sender]

Output ports from this stage.

Returns:

typing.List[morpheus.pipeline.pipeline.Sender]

Output ports from this stage.

set_needed_columns(needed_columns)[source]

Sets the columns needed to perform preallocation. This should only be called by the Pipeline at build time. The needed_columns shoudl contain the entire set of columns needed by any other stage in this segment.

stop()[source]

Stages can implement this to perform cleanup steps when pipeline is stopped.

supports_cpp_node()[source]

Specifies whether this Stage is capable of creating C++ nodes. During the build phase, this value will be combined with CppConfig.get_should_use_cpp() to determine whether or not a C++ node is created. This is an instance method to allow runtime decisions and derived classes to override base implementations.

property unique_name: str

Unique name of stage. Generated by appending stage id to stage name.

Returns:

str

Unique name of stage.