CogNdmOfflineRequestedEventArgs ClassCognex VisionPro 9.8
Event args returned as part of Cognex's Network Data Model (NDM) OfflineRequested event.
Inheritance Hierarchy

System Object
  System EventArgs
    Cognex.VisionPro.Comm CogNdmEventArgsBase
      Cognex.VisionPro.Comm CogNdmOfflineRequestedEventArgs

Namespace: Cognex.VisionPro.Comm
Assembly: Cognex.VisionPro.Comm (in Cognex.VisionPro.Comm.dll) Version: 75.1.0.0
Syntax

public sealed class CogNdmOfflineRequestedEventArgs : CogNdmEventArgsBase

The CogNdmOfflineRequestedEventArgs type exposes the following members.

Methods

  NameDescription
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Properties

  NameDescription
Public propertyMessageID
An ID number that uniquely identifies the message.
(Inherited from CogNdmEventArgsBase.)
Public propertyReturnToPreviousState
False if the remote device has signaled the vision system to go offline. True if the the remote device has signaled the vision system to return to the previous state,
Top
Remarks

Vision Systems often have an "online" and "offline" state. The exact meaning of what it means to be online and offline may differ depending on the particular vision system and application.

The NDM allows the vision system to communicate and synchronize its online/offline state with the remote device using the NotifyRunning  and NotifyStopped  methods.

The vision system calls NotifyRunning  to notify the remote device that the vision system is running or online.

The vision system calls NotifyStopped  to notify the remote device that the vision system has stopped or gone offline.

The vision system's current online/offline state is reflected in the high or low state of remote device's "Online" signal.

The remote device may also signal the running vision system to go offline. The remote device does this by asserting its "Set Offline" signal high. When the remote device raises the "Set Offline" signal high, the vision system receives the NDM OfflineRequested event.

The remote device may also signal the stopped vision system to return to its previous state. The remote device does this by setting its "Set Offline" signal low. When the remote device lowers the "Set Offline" signal, the vision system receives the NDM OfflineRequested event.

Your vision system code should handle the NDM OfflineRequested event. When your code receives this event you should examine the ReturnToPreviousState property of the event args to determine whether the remote device has signaled the vision system to go offline, or to return to the previous state.

Once the code in your event handler has made the necessary transition, be sure to call NotifyStopped , or NotifyRunning  to notify the remote device of the new state of the vision system.

See Also