CogJobManager.UserQueueCapacity Property

CogJobManager UserQueueCapacity Property

Cognex VisionPro

Get or set the user queue capacity.

Namespace: Cognex.VisionPro.QuickBuild
Assembly: Cognex.VisionPro.QuickBuild.Core (in Cognex.VisionPro.QuickBuild.Core.dll) Version: 65.1.0.0 (65.1.0.0)

Syntax

C++

Copy to Clipboard Print

public int UserQueueCapacity { get; set; }

public int UserQueueCapacity { get; set; }

Public Property UserQueueCapacity As Integer 
	Get 
	Set

Public Property UserQueueCapacity As Integer 
	Get 
	Set

public:
property int UserQueueCapacity {
	int get ();
	void set (int value);
}

public:
property int UserQueueCapacity {
	int get ();
	void set (int value);
}

Property Value

Type: Int32
The capacity of the user queue is the number of result packets which can be queued up when the job is running and collecting results. Setting this value to something smaller than the number of contained CogJobs in this CogJobManager may cause user results to be dropped or lost from the user queue. This error condition will manifest itself as: a UserResultAvailable event will be fired, but the user queue will be empty (a null value will be returned from the UserResult method). The capacity of the user queue should always be equal to or greater than the the number of contained CogJobs in this CogJobManager.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when the UserQueueCapacity changes.

Exceptions

Exception	Condition
CogNotStoppedException	Thrown if the CogJobManager or any contained CogJobs are not stopped