CogPMRedLinePattern.TrainTimeout Property

CogPMRedLinePattern TrainTimeout Property

Cognex VisionPro 9.22 SR1

Gets or sets the maximum execution time (in msec) allowed when a PMRedLine tool is trained. This value only applies if TrainTimeoutEnabled is set to "true".

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 87.1.0.0

Syntax

C++

Copy to Clipboard Print

public double TrainTimeout { get; set; }

public double TrainTimeout { get; set; }

Public Property TrainTimeout As Double 
	Get 
	Set

Public Property TrainTimeout As Double 
	Get 
	Set

public:
property double TrainTimeout {
	double get ();
	void set (double value);
}

public:
property double TrainTimeout {
	double get ();
	void set (double value);
}

Property Value

Type: Double
The maximum training time allowed (in milliseconds). Default value is 5000.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfTrainTimeout

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than zero.

Remarks

If the timeout is enabled and training exceeds the timeout period, the Train method will throw a CogTimeoutExpiredException. This exception will occur shortly after the timeout period elapses.