CogJob MethodsCognex VisionPro 9.21 SR1

The CogJob type exposes the following members.

Methods

  NameDescription
Public methodCloneParameters
CloneParamters. Internal use only.
Public methodCopyParameters
CopyParameters. Internal use only.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodImage 
Image() remvoes and returns the oldest image in the image queue. Image() will return null if the image queue is empty. Care must be taken to not remove images from the image queue if the CogJob is running image processing.
Public methodImage(Int32, Boolean)
Image(int,bool) allows any image to be looked at and/or removed from the image queue. Care must be taken to not remove images from the image queue if the CogJob is running image processing.
Public methodImageQueueFlush
Flush/clear the image queue of all images. This method cannot be called while the CogJob is running.
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodIOValidate
This function detects all the possible I/O configuration errors and returns them in a string. The user must call this routine after adding a new CogJob to the CogJobManager. This routine enables all the I/O lines, if possible, that are used by this job.
Public methodOnDeserialization
Serialization Callback. Internal use only.
Public methodReset
Reset puts the CogJob into its initial state.
Public methodResetAllStatistics
Reset all statistics to their default states.
Public methodRestartThroughputCalculation
Restart the calculation of the throughput calculations.
Public methodResumeAndRaiseChangedEvent
Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.)
Public methodRun
Run the CogJob just once. This Run method uses the RunMode of the CogJob determines which parts (acquisition and/or image processing) actually run.
Public methodRunContinuous
Run the CogJob in a continuous loop. The CogJob will not stop running until Stop() is called. This Run method uses the the RunMode of the CogJob determines which parts (acquisition and/or image processing) actually run.
Public methodShutdown
Shutdown terminates all internal threads inside the CogJob. Shutdown also disposes of any contained acquisition fifo and vision tools. Shutdown must be called to allow the CogJob to cleanly terminate. After the CogJob has shutdown, it cannot be run again. Do not persist (save) a shutdown CogJob, since it cannot be run again, even after de-persisting it.
Public methodStop
Stop forces the CogJob to stop running. Only CogJobs running continuously can be stopped. This method returns immediately and does not wait for the CogJob to stop. Once the CogJob has completely stopped, the Stopped event will be fired. If the CogJob is not running, this method has no effect.
Public methodSuspendChangedEvent
Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodVisionToolLink(Int32)
Returns the stored CogVTLink object using a integer index.
Public methodVisionToolLink(String)
Returns the stored CogVTLink object using a link name.
Public methodVisionToolLink(String, CogDestinationQueueConstants)
Returns the stored CogVTLink object using a link name and its type.
Public methodVisionToolLinkAdd
Add a new CogVTLink object to the CogJob. A CogVTLink object represents either an input (an image) or output (results collection) to or from the CogJob.
Public methodVisionToolLinkRemove(String)
Remove a CogVTLink object by its link name.
Public methodVisionToolLinkRemove(CogVTLink)
Remove a CogVTLink object by its reference.
Top
See Also