CogJobManager MethodsCognex VisionPro 9.25 SR1

The CogJobManager 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 methodFailureItem 
FailureItem() removes and returns the oldest failure packet from the failure queue. FailureItem() will return null if the failure queue is empty. This method may be called while the CogJobManager or CogJobs are running.
Public methodFailureItem(Int32, Boolean)
FailureItem(int,bool) allows any failure packet to be looked at and/or removed from the failure queue.
Public methodFailureQueueFlush
Flush/clear the failure queue of all packets. This method cannot be called while the CogJobManager or any contained CogJobs are running.
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 methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodIOPostLoadSetup
QuickBuild is unable to monitor Online input command after it starts up because the default IOEnable mode is always set to false (offline mode). However, Online and Emergency Stop input signals should be still monitored even if in offline mode. The user must call this routine to ask CogJobManager to monitor those input signals that must be monitored in offline mode. This function should also be called after the user successfully loads a QuickBuild application.
Public methodJob(Int32)
Retrieve a references to the CogJob from the JobManager by name index.
Public methodJob(String)
Retrieve a references to the CogJob from the JobManager by name.
Public methodJobAdd
JobAdd is used to add CogJobs to the CogJobManager.
Public methodJobRemove(String)
JobRemove is used to remove CogJobs by name from the CogJobManager.
Public methodJobRemove(CogJob)
JobRemove is used to remove CogJobs from the CogJobManager.
Public methodOnDeserialization
Serialization Callback. Internal use only.
Public methodRequestHeartbeat
The user only needs to call this routine once. Once it is called, Heartbeat is generated whenever the following two conditions are met--IOEnable is true and IOHeartbeat is valid.
Public methodReset
Reset puts the CogJobManager into its initial state. If there are any contained CogJobs, they are shutdown and removed.
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 CogJobManager and any contained CogJobs just once. See CogJob.Run() for additional information regarding the running of CogJobs.
Public methodRunContinuous
Run the CogJobManager and all contained CogJobs in a continuous loop. This CogJobManager will not stop running until Stop() is called. See CogJob.RunContinuous() for additional information regarding the running of CogJobs.
Public methodShutdown
Shutdown terminates all internal threads inside the CogJobManager and calls shutdown on all contained CogJobs. Shutdown must be called to allow the CogJobManager to cleanly terminate. After the CogJobManager and all contained CogJobs have shutdown, it cannot be run again. Do not persist (save) a shutdown CogJobManager, since it cannot be run again, even after de-persisting it.
Public methodStop
Stop forces the CogJobManager and any contained CogJobs to stop running. Only when the CogJobManager is running continuously can it be stopped. This method returns immediately and does not wait. Once the CogJobManager and any contained jobs have completely stopped, the Stopped event will be fired. If the CogJobManager is not running, this method has no effect.
Public methodStopHeartbeat
Public methodStreamInput
Call this function to retrieve an interface, ICogIOTCPIP, of a QB TCP/IP device used to receive an input message.
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 methodStatic membertimeBeginPeriod
Public methodStatic membertimeEndPeriod
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUserQueueFlush
Flush/clear the user queue of all packets. This method cannot be called while the CogJobManager or any contained CogJobs are running.
Public methodUserResult 
UserResult() removes and returns the oldest result packet from the user queue. UserResult() will return null if the user queue is empty. This method may be called while the CogJobManager or CogJobs are running.
Public methodUserResult(Int32, Boolean)
UserResult(int,bool) allows any result packet to be looked at and/or removed from the user queue.
Top
See Also