51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Core.Configuration.ElementOptions Class Reference

Detailed Description

Configuration object that describes how to build an IFlowElement.

Public Member Functions

 ElementOptions ()
Default constructor. More...

Properties

string  BuilderName [get, set]
The name of the builder to use when creating the IFlowElement. More...
IDictionary< string, object >  BuildParameters [get, set]
The dictionary keys are method names or names of parameters on the Build method of the builder. More...
IList< ElementOptions >  SubElements [get, set]
If this property is populated, the flow element is a ParallelElements instance. More...

Constructor & Destructor Documentation

◆ ElementOptions()

FiftyOne.Pipeline.Core.Configuration.ElementOptions.ElementOptions ( )

Default constructor.

Property Documentation

◆ BuilderName

string FiftyOne.Pipeline.Core.Configuration.ElementOptions.BuilderName
get set

The name of the builder to use when creating the IFlowElement.

This does not necessarily have to be the full name of the type. The system will match on:

  1. Exact match of type name
  2. Convention based match by removing 'Builder' from the end of the type name. e.g. a BuilderName value of 'DeviceDetectionEngine' would match to 'DeviceDetectionEngineBuilder'
  3. Matching on an AlternateNameAttribute. e.g. a BuilderName value of 'DDEngine' would match to 'DeviceDetectionEngineBuilder' if that class also had [AlternateNameAttribute(Name = "DDEngine")]

◆ BuildParameters

IDictionary<string, object> FiftyOne.Pipeline.Core.Configuration.ElementOptions.BuildParameters
get set

The dictionary keys are method names or names of parameters on the Build method of the builder.

The value is the parameter value.

Similar to the BuilderName, the key value does not necessarily have to be the full name of the method. The system will match on:

  1. Exact match of method name
  2. Convention based match by removing 'Set' from the start of the method name. e.g. a key value of 'AutomaticUpdatesEnabled' would match to method 'SetAutomaticUpdatesEnabled'
  3. Matching on an AlternateNameAttribute. e.g. a key value of 'AutoUpdates' would match to 'SetAutoUpdateEnabled' if that class also had [AlternateNameAttribute(Name = "AutoUpdates")]

◆ SubElements

IList<ElementOptions> FiftyOne.Pipeline.Core.Configuration.ElementOptions.SubElements
get set

If this property is populated, the flow element is a ParallelElements instance.

BuilderName and BuildParameters should be ignored. Each options instance within SubElements contains the configuration for an element to be added to a ParallelElements instance.

A ParallelElements always executes all it's children in parallel so the ordering of this elements is irrelevant.