OptimizationTimeSpanParameter constructor

constructor · OptimizationTimeSpanParameter · cAlgo.API Since 5.9

DesktopCLICloud

Optimizes the parameter over the range the minimum to the maximum by the step.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Overloads

Signature	Description
`OptimizationTimeSpanParameter(string name, TimeSpan min, TimeSpan max, TimeSpan step)`	Optimizes the parameter over the range the minimum to the maximum by the step.
`OptimizationTimeSpanParameter(string name, TimeSpan value)`	Holds the parameter fixed at the given value.
`OptimizationTimeSpanParameter(OptimizationTimeSpanParameter original)`

OptimizationTimeSpanParameter(string name, TimeSpan min, TimeSpan max, TimeSpan step)

Optimizes the parameter over the range the minimum to the maximum by the step.

C#Python

public OptimizationTimeSpanParameter(string name, TimeSpan min, TimeSpan max, TimeSpan step)

OptimizationTimeSpanParameter(name: str, min: TimeSpan, max: TimeSpan, step: TimeSpan)

Parameters

Name	C# type	Python type	Description
`name`	`string`	`str`	The cBot parameter name.
`min`	`TimeSpan`	`TimeSpan`	The inclusive minimum of the range.
`max`	`TimeSpan`	`TimeSpan`	The inclusive maximum of the range.
`step`	`TimeSpan`	`TimeSpan`	The step of the range.

Examples

C#Python

var parameter = new OptimizationTimeSpanParameter("MaxHoldTime", TimeSpan.FromHours(1), TimeSpan.FromHours(8), TimeSpan.FromHours(1));
Print("{0} is optimized: {1}", parameter.Name, parameter.IsOptimized);

from System import TimeSpan
parameter = OptimizationTimeSpanParameter("MaxHoldTime", TimeSpan.FromHours(1), TimeSpan.FromHours(8), TimeSpan.FromHours(1))
api.Print(f"{parameter.Name} is optimized: {parameter.IsOptimized}")

OptimizationTimeSpanParameter(string name, TimeSpan value)

Holds the parameter fixed at the given value.

C#Python

public OptimizationTimeSpanParameter(string name, TimeSpan value)

OptimizationTimeSpanParameter(name: str, value: TimeSpan)

Parameters

Name	C# type	Python type	Description
`name`	`string`	`str`	The cBot parameter name.
`value`	`TimeSpan`	`TimeSpan`	The fixed value.

Examples

C#Python

var parameter = new OptimizationTimeSpanParameter("Cooldown", TimeSpan.FromMinutes(30));
Print("{0} is fixed at {1}", parameter.Name, parameter.Value);

from System import TimeSpan
parameter = OptimizationTimeSpanParameter("Cooldown", TimeSpan.FromMinutes(30))
api.Print(f"{parameter.Name} is fixed at {parameter.Value}")

OptimizationTimeSpanParameter(OptimizationTimeSpanParameter original)

C#Python

public OptimizationTimeSpanParameter(OptimizationTimeSpanParameter original)

OptimizationTimeSpanParameter(original: OptimizationTimeSpanParameter)

Parameters

Name	C# type	Python type	Description
`original`	`OptimizationTimeSpanParameter`	`OptimizationTimeSpanParameter`