CogIOTCPIP PropertiesCognex VisionPro 9.10

The CogIOTCPIP type exposes the following members.

Properties

  NameDescription
Public propertyChangedEventSuspended
If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.)
Public propertyClientAutoReconnect
Public propertyClientConnectionCount
This function should only be called for the server device type Returns 0 if the server socket has not been created, otherwise, returns the actual number of clients connected.
Public propertyDeviceName
Return the name that characterizes the instance of CogIODevice object.
(Inherited from CogIODevice.)
Public propertyEnabled
Returns true when the device is enabled. This does not mean the device is closed. When the device is disabled, it will neither send nor receive data even though the device is open and the socket is connected.
(Overrides CogIODevice Enabled.)
Public propertyEncoding
This is the encoding type that will be used to convert a queued output string into a sequence of bytes. The default value is ASCII.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyHost
This property identifies the computer to which results will be sent and from which commands will be read. This string may be in the form of an IP address, that is, a 32-bit integer expressed as four 8-bit values separated by periods, such as “127.205.42.9”. When Open() is called, this string will be evaluated to determine if it is in the form of an IP address. If it is then it will be used as such. If not, then we assume that this string is a host name which must be resolved using DNS. There is no default value.
Public propertyIOEnabled
Public propertyIsClientConnected
Returns true if the socket is connected. Should only call this property if the device type is client. Returns false if it is a server device type or the socket has not been created.
Public propertyIsDeviceOpen
Socket must be valid and the data handler thread is valid.
(Overrides CogIODevice IsDeviceOpen.)
Public propertyMode
Returns true if the device is a client type.
Public propertyOutputMessageDelimiter
Public propertyOutputMessageTerminator
Public propertyOutputOnlyFailedResult
When this property is true, it outputs the failed job's results. This means, the I/O queue must contain the job's run status, which is added automatically before a Job starts to run.
Public propertyPortNumber
Public propertyQueueSize
This is the maximum number of outbound strings that can be queued by this device. The default value is 32.
Public propertyStateFlags
Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.)
Public propertyTimeout
This timeout value is used for acknowledgement, sending and receiving data. For Acknowledgment: When AckEnabled is true, this is the maximum number of milliseconds that this device’s output processing thread will wait for an acknowledgement message. If this timeout is exceeded, the output processing thread will retransmit the message. This will be repeated up to AckNumRetries times. If the message is not acknowledged, the output processing thread generates an Error event. For other cases: It will throw a timeout error when it fails to successfully either send or the entire data.
Top
See Also