8.18. Clara Pipeline Payload

Application code looking to make use of Clara’s pipeline orchestration should utilize of Clara Pipeline Driver operator life-cycle and register an execute callback handler. When the execution event callback handler is called, a reference to the current stage’s payload (clara.Payload) will be passed to application code.

Using the supplied pointer enables application code to iterate through the list of name / path pairs for both inputs and outputs.

see also: Clara Pipeline Driver and Clara Pipeline Driver Callbacks

Gets a collection of the payload’s input entries.

The set of input entries returned when calling this function is determined by the pipeline definition. Pipeline definitions declare a set of input values for each operator. Those input values are represented as payload entries.

see also: Payload Entry

Return

Returns a System.Collections.Generic.IReadOnlyList<IPayloadEntry>.

            

            
IReadOnlyList<IPayloadEntry> InputEntries { get; }
        

Gets a collection of the payload’s output entries.

The set of output entries returned when calling this function is determined by the pipeline definition. Pipeline definitions declare a set of output values for each operator. Those output values are represented as payload entries.

see also: Payload Entry

Return

Returns a System.Collections.Generic.IReadOnlyList<IPayloadEntry>.

            

            
IReadOnlyList<IPayloadEntry> OutputEntries { get; }