CogPMRedLineRunParams.Timeout Property

CogPMRedLineRunParams Timeout Property

Cognex VisionPro 9.22

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

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

Syntax

public double Timeout { get; set; }

public double Timeout { get; set; }

Public Property Timeout As Double 
	Get 
	Set

Public Property Timeout As Double 
	Get 
	Set

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

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

Type: Double
The maximum execution 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: SfTimeout

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than zero.

Remarks

If the timeout is enabled and PMRedLine exceeds the timeout period, the CogPMRedLinePattern class will throw a CogTimeoutExpiredException. This exception will occur shortly after the timeout period elapses. The exception will appear in the RunStatus of the CogPMRedLineTool.