Cognex.VisionPro

Constants that can be assigned to the RecordUsage property of a CogRecord to specify how it is used.

Top-level record of a vision tool.

Configuration data, such as a region of interest.

A stored pattern, mask, template, etc.

An input, such as an input image.

Information generated for diagnostic purposes.

A result or output, such as an output image or result graphic.

A temporary record, typically added by an edit control.

A QuickBuild record, all records created by QuickBuild have this value.

Tool-defined record usage constants begin here, and end at 0x4FFFFFFF.

User-defined record usage constants begin here, and end at 0x7FFFFFFF.

Interface that describes a list of ICogRecord references.

Adds a record to the end of the list.

The record to be added.

Searches the list for a given record.

The record for which to search. True if the list contains the given record, false otherwise.

Searches the list for a given key.

The key for which to search. True if the list contains the given record, false otherwise.

Searches the list for a given record.

The record for which to search. The index of the record, or -1 if it is not in the list.

Searches the list for a given key.

The key for which to search. The index of the record, or -1 if it is not in the list.

Inserts a record at a specified index.

The index at which to insert the record. The record to insert.

Removes a record with a specified key.

The key of the record to remove.

Gets or sets the record at a specified index.

Gets or sets the record with a specified RecordKey.

Interface that describes a record provided by a tool.

Gets or sets the key of the record, which is used to identify it within a collection.

Gets or sets the type of the Content property.

Gets or sets a constant indicating the usage of the record.

Gets or sets a value that indicates whether the contents of the record should be considered mutable.

Gets or sets the content of the record.

Gets or sets a string that is a displayable annotation for the record.

Gets a list of records contained within this record.

Interface implemented by an object that constructs the Content, Annotation and SubRecords of a record when they are requested.

Constructs the record's Content.

The record being constructed. An integer that was stored when the record was created.

Constructs the record's Annotation.

The record being constructed. An integer that was stored when the record was created.

Constructs the record's SubRecords.

The record being constructed. An integer that was stored when the record was created.

Returns a copy of the constructor object.

Enumeration of Region modes. Region mode specifies how a region is applied to an image.

Only the pixels within the supplied region are used. This is implemented by computing a mask which extends the region to its pixel aligned bounding box.

If you specify an input region other than a simple, pixel-aligned rectangle, this region mode specifies that all the pixels within a pixel-aligned bounding box that encloses the region will be supplied to the vision tool. Those pixels that lie inside the bounding box but outside the region that you supply are set as "don't care" pixels in the mask image used by the vision tool (if it supports one). The following figure shows the effect of using this mode if you specify an ellipse as an input region.

The region used will be the pixel aligned bounding box enclosing the supplied region. This mode often provides faster performance than the PixelAlignedBoundingBoxAdjustMask mode.

If you specify an input region other than a simple, pixel-aligned rectangle, this region mode specifies that all the pixels within a pixel-aligned bounding box that encloses the region will be supplied to the vision tool. The following figure shows the effect of using this mode if you specify an ellipse as an input region.

A new image will be created by performing an affine transformation on the region. The region must be either a simple rectangle or an affine rectangle.

If you specify an as your input region, you can specify this region mode to have VisionPro affine-transform the pixels in the region into a new, pixel-aligned rectangular image. This mode is appropriate when your vision tool requires a pixel-aligned rectangular input region, but the data you wish to supply lies at an angle in the input image.

Enumeration of constants that indicate the overall result of running a tool.

Indicates that the tool ran successfully and did not generate a warning or reject condition.

Indicates that the tool ran successfully but generated a warning condition.

Indicates that the tool ran successfully but generated a reject condition.

Indicates that the tool did not run successfully.

This interface is returned by the RunStatus property of the ICogTool interface and provides general information about the last call to the tool's Run method. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run.

Gets a result code that indicates the overall result of running the tool.

Returns null if the result was Accept, and otherwise returns a string that provides additional information about the Warning, Reject or Error condition.

Returns the time in miliseconds taken to perform the tool's processing when its Run function was called. This excludes the time taken by event handlers connected to the tool.

Returns the total time in milliseconds taken by the tool's Run function. This includes the time taken by event handlers connected to the tool.

Returns the exception that happened when the tool's Run method was called, or null if no exception happened.

This interface is implemented by all VisionPro tools.

This interface contains the Changed event and methods for suspending and resuming it.

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.

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.

If the ChangedEventSuspended count is currently zero. Fires if the ChangedEventSuspended count is decremented to zero and a Changed event had been suppressed one or more times while changed events were suspended.

This event is raised when one or more parts of the object's state may have changed.

Indicates if the raising of the Changed event has been suspended.

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.

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) { ... }

Creates a new set of records that represents the tool's current state.

Creates a new set of records that represents the tool's last-run state.

Runs the tool. This method is guaranteed to not throw an exception. Any exception generated in the course of running the tool will be caught and packaged in the tool's RunStatus.Exception. Should this occur, the tool's RunStatus.Result will be set to Error and its RunStatus.Message will reference the message that accompanied the exception. It is the user's responsibility to examine the tool's RunStatus after calling Run.


Imports Cognex.VisionPro

Private Function RunTool() As Boolean
  mTool.Run() ' a previously created and configured tool ...

  Dim aRunStatus As Cognex.VisionPro.ICogRunStatus = mTool.RunStatus

  If (aRunStatus.Result = CogToolResultConstants.Error) Then
    If (Not aRunStatus.Exception Is Nothing) Then
      MessageBox.Show("Exception: " + _
        aRunStatus.Exception.ToString())
    End If

    If (Not aRunStatus.Message Is Nothing) Then
      MessageBox.Show("Message: " + _
        aRunStatus.Message)
    End If

    RunTool = False
  Else
    RunTool = True
  End If

End Function


using Cognex.VisionPro;

private Boolean RunTool()
  {
  mTool.Run(); // a previously created and configured tool

  ICogRunStatus aRunStatus = mTool.RunStatus;

  if (aRunStatus.Result == CogToolResultConstants.Error)
    {
    if (aRunStatus.Exception != null)
      MessageBox.Show("Exception: " +
        aRunStatus.Exception.ToString());

    if (aRunStatus.Message != null)
      MessageBox.Show("Message: " +
        aRunStatus.Message);

    return false;
    }
  else
    return true;
  }

Event that is raised at the start of the tool's Run method.

Event that is raised at the end of the tool's Run method.

Gets a CogDictionary object that can be used to store application-specific information.

Gets or sets the name of the tool.

Gets general information about the last call to the tool's Run function. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run.

Gets the data bindings for the tool.

Class that holds information about the state of a tool.

Base class for a Component that implements the interface. Objects that derive from this class will raise the Changed event whenever part of the object's state has changed.

Base class for all CogObjectBase subclasses that support serialization.

This is the base class for most non-Component VisionPro objects.

Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.

Creates a new instance of the CogSerializableObjectBase class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Implements the GetObjectData method of the ISerializable interface.

SerializationInfo to which serialization data must be added. StreamingContext that indicates the intent of the current serialization operation.

Gets the version of the assembly containing this object's type that created the given archive. It may be useful for objects to detect old archived versions of themselves, and manually depersist the old archives in a specialized way. Note that the returned Version object can be compared to fixed versions with its operator overloads for less than, equal to, etc.

The SerializationInfo containing the archived data. Version of the current type's assembly that created the given archive. Caution: Do not use this property during deserialization because the value of this property is undefined.

Interface for the HasChanged property of a mutable, serializable object

Indicates if the object has changed since this property was last set to false. This property is set to true when a changed event fires, and set to false on construction and when the object is persisted.

The next state flag value to be used by a derived class.

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.

If the ChangedEventSuspended count is currently zero.

This method should be called internally whenever the object's state may have changed.

The set of state flags that correspond to the parts of the object that may have changed.

This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class.

EventArgs to be fired with the change event.

Initializes a new instance of the CogSerializableChangedEventBase class with serialized data.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Initializes a new instance of the CogSerializableChangedEventBase class.

This event is raised when one or more parts of the object's state may have changed.

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.

State flag for the RecordKey property.

State flag for the ContentType property.

State flag for the RecordUsage property.

State flag for the ContentMutable property.

State flag for the Content property.

State flag for the Annotation property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogRecord class.

A CogRecord to copy.

Constructs a new instance of the CogRecord class.

Key used to identify the CogRecord. Format of record content. How the record is used. If true, record content can be modified. Record data. Description of the record.

Constructs a new instance of the CogRecord class.

Key used to identify the CogRecord. Format of record content. How the record is used. If true, record content can be modified. Record data. Description of the record. Interface to method for constructing content (including subrecords' content) and annotation. Passed to supplied ICogRecordConstructor methods when called.

Creates a deep copy of the record.

A deep copy of the cloned record.

Creates a new instance of the CogRecord class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Gets or sets the key used to identify the record.

The string key used to identify the record.

Gets or sets the format of record content.

The type of record content.

Gets or sets an indicator of the record's usage.

An enumeration describing the context in which the record is used.

Gets or sets the flag indicating whether or not the record's content can be modified.

A boolean which indicates whether or not the record's content can be modified.

Gets or sets the record's content.

The record's content.

Description of the record.

A string describing or annotating the record.

Gets the sub-records of this record.

The collection of sub-records contained within this record.

When used as the Content of a record, this class specifies that when the record is displayed it should call a method or set a property of the CogDisplay control.

Constructs a new instance of the DisplayMethod class.

The name of the method or property of the CogDisplay control. The arguments to the method or the property value. The invocation type, either BindingFlags.SetProperty or BindingFlags.InvokeMethod.

Gets the name of the method or property to be called.

Gets the arguments to the method, or null if no arguments are needed.

Gets the type of binding, either BindingFlags.SetProperty or BindingFlags.InvokeMethod.

Class that holds a collection of CogRecord objects.

Base class for a generic, serializable ordered collection of values that raises Cognex style change events.

An interface that comprises the events that are common to most editable VisionPro collections.

Raised before the collection is cleared.

Raised after the collection is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

Raised before an item is moved to a new index.

Raised after an item is moved to a new index.

State flag for the Item (indexer) property.

State flag for the Count property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogCollectionBase class.

Constructs a new instance of the CogCollectionBase class initially containing items cloned from the supplied instance.

Collection whose items are cloned and added to the new collection. If an item does not support the ICloned interface, the item itself will be added. If other is null.

Special serialization constructor.

Data used to deserialize the collection. Context to deserialize the serialization info.

Creates a deep copy of the object. Must be overridden in derived classes.

A deep copy of the cloned instance.

Raises the Clearing event.

Raises the Cleared event.

Raises the InsertingItem event.

Index at which the item will be inserted. Value of item being inserted.

Raises the InsertedItem event.

Index at which the item has been inserted. Value of the item inserted.

Raises the RemovingItem event.

Index of item being removed. Value of item being removed.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacingItem event.

Index of item being replaced. Value of item being replaced. Value of item replacing oldValue.

Raises the ReplacedItem event.

Index of item replaced. Value of item replaced. Value of item that replaced oldValue.

Raises the MovingItem event.

Index of item being moved. Destination index of item being moved.

Raises the MovedItem event.

Source index of item moved. New index of item moved.

Removes all objects from the collection.

Moves an item from one position to another.

The item's original index. The item's new index.

Removes the element at the specified index.

The zero-based index of the element to remove.

Copies the contents of the collection to an array.

The array into which to copy. The starting index at which to copy.

Gets the internal ArrayList containing the list of elements.

Gets an the IList interface of this collection.

Raised before the collection is cleared.

Raised after the collection is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

Raised before an item is moved to a new index.

Raised after an item is moved to a new index.

Gets the number of elements contained in the collection.

Constructs a new instance of the CogRecords class.

A CogRecords to copy.

Constructs a new instance of the CogRecords class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a deep copy of the records collection.

A deep copy of the cloned records collection.

This class provides an implementation of the ICogRunStatus interface. A tool's RunStatus property is of type CogRunStatus. This property provides general information about the last call to the tool's Run method. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run.

State flag for the TotalTime property.

Next state flag to be used in derived classes.

Creates a new instance of the CogRunStatus class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a new instance of the CogRunStatus class.

Run status tool result. Message describing or explaining run status. Time to execute VisionPro tools. Excludes time used by clients to process Changed events. Time to execute VisionPro tools and execute Changed events. This time includes such overhead as updating tool edit controls. Exception, if any, thrown while running tool.

Creates a new instance of the CogRunStatus class.

Note that is shallow copied. Both the original RunStatus, and the copy share the same reference to the original Exception. An ICogRunStatus to copy.

Determines whether the specified CogRunStatus is equal to the current CogRunStatus.

The CogRunStatus to compare with the current CogRunStatus. True if the specified CogRunStatus is equal to the current CogRunStatus; otherwise, false.

Serves as a hash function for this type, suitable for use in hashing algorithms and data structures like a hash table.

A hash code for the current CogRunStatus.

Gets a result code that indicates the overall result of running the tool.

An enumeration reporting the overall result of running the tool.

Gets a message describing the result of running the tool.

Returns null if the result was Accept, and otherwise returns a string that provides additional information about the Warning, Reject or Error condition.

Gets the time taken to perform the tool processing portion of the Run function.

Returns the time in milliseconds taken to perform the tool's processing when its Run function was called. This excludes the time taken by event handlers connected to the tool.

Gets the time taken to execute the entire Run function.

Returns the total time in milliseconds taken by the tool's Run function. This includes the time taken by event handlers connected to the tool.

Gets the exception thrown (and caught) while executing the tool's Run method.

Returns the exception that happened when the tool's Run method was called, or null if no exception happened.

A base class that implements the interface. Tools may implement the ICogTool interface in other ways and are not required to derive from this class.

Base class for a Component that implements the interface. Objects that derive from this class will raise the Changed event whenever part of the object's state has changed.

Base class for all CogComponentBase subclasses that support serialization.

This is the base class for most Component VisionPro objects.

Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.

Creates a new instance of the CogSerializableComponentBase class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Implements the GetObjectData method of the ISerializable interface.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Get the assembly version for this.GetType() as recorded in the archive. It may be useful for objects to detect old archived versions of themselves, and manually depersist the old archives in a specialized way. Note that the returned Version object can be compared to fixed versions with its operator overloads for <, >, etc.

The next state flag value to be used by a derived class.

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.

If the ChangedEventSuspended count is currently zero.

This method should be called internally whenever the object's state may have changed.

The set of state flags that correspond to the parts of the object that may have changed.

This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class.

EventArgs to be fired with the change event.

Initializes a new instance of the CogSerializableChangedEventComponentBase class with serialized data.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Initializes a new instance of the CogSerializableChangedEventComponentBase class.

This event is raised when one or more parts of the object's state may have changed.

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.

State flag for the CurrentRecordEnable property.

State flag for the LastRunRecordEnable property.

State flag for the RunStatus property.

State flag for the Name property.

State flag for the FailOnInvalidDataBinding property.

Next state flag to be used in derived classes.

Gets or sets the amount to offset reported tool processing time.

The amount added to the tool processing time when it is stored in the tool's RunStatus. Negative values will reduce the reported time. This is often necessary if your tool runs other VisionPro tools and you need to exclude the non-processing time used by the encapsulated tool.

Gets or sets the flags specifying the records to include based on the tool's current state. The derived class exposes this as a strongly- typed enum property.

Flags indicating which records to include based on the tool's current state.

Gets or sets the flags specifying the records to include based on the tool's last-run state. The derived class exposes this as a strongly- typed enum property.

Flags indicating which records to include based on the tool's last-run state.

Gets or sets the flags specifying the diagnostics records to include based on the tool's last-run state. The derived class exposes this as a strongly-typed enum property.

Flags indicating which diagnostics records to include based on the tool's last-run state. Only the diagnostic records created during the previous invocation of the Run method are available for inclusion in the tool record.

Gets or sets the flags specifying the records to create during the next invocation of the Run method.

Flags indicating which diagnostics records to create during the next invocation of the Run method.

Raises the Running event.

Raises the Ran event.

Called by the Run method to perform the main processing of the tool.

Can be set in the InternalRun function in order to save a message in the RunStatus object. CogToolResultConstant indicating overall tool run result.

Called by the CreateCurrentRecord method to create a record containing the current state of the tool.

A newly-created Current record, to which the derived tool may add new sub-records. The value of the CurrentRecordEnable property.

Called by the CreateLastRunRecord method to create a record containing the state of the tool after the last call to its Run method.

A newly-created LastRun record, to which the derived tool may add new sub-records. The value of the LastRunRecordEnable property during the last call to its Run method. The value of the LastRunRecordDiagEnable property during the last call to its Run method.

Creates a deep copy of the tool.

A deep copy of the cloned tool.

Constructs a new instance of the CogToolBase class.

A CogToolBase to copy. is null.

Constructs a new instance of the CogToolBase class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Returns true if the serilaized object data has a memberName.

The object that holds the serialized object data. The name of the member being checked.

Creates a new set of records that represents the tool's current state.

ICogRecord instance containing a set of records that represent the tool's current state. The records created are specified by the CreateCurrentRecord property.

Creates a new set of records that represents the tool's last-run state.

ICogRecord instance containing a set of records that represent the tool's last-run state. The records created are specified by the LastRunRecordEnable and LastRunRecordDiagEnable properties.


Imports Cognex.VisionPro

Private Function RunTool() As Boolean
  mTool.Run() ' a previously created and configured tool ...

  Dim aRunStatus As Cognex.VisionPro.ICogRunStatus = mTool.RunStatus

  If (aRunStatus.Result = CogToolResultConstants.Error) Then
    If (Not aRunStatus.Exception Is Nothing) Then
      MessageBox.Show("Exception: " + _
        aRunStatus.Exception.ToString())
    End If

    If (Not aRunStatus.Message Is Nothing) Then
      MessageBox.Show("Message: " + _
        aRunStatus.Message)
    End If

    RunTool = False
  Else
    RunTool = True
  End If

End Function


using Cognex.VisionPro;

private Boolean RunTool()
  {
  mTool.Run(); // a previously created and configured tool

  ICogRunStatus aRunStatus = mTool.RunStatus;

  if (aRunStatus.Result == CogToolResultConstants.Error)
    {
    if (aRunStatus.Exception != null)
      MessageBox.Show("Exception: " +
        aRunStatus.Exception.ToString());

    if (aRunStatus.Message != null)
      MessageBox.Show("Message: " +
        aRunStatus.Message);

    return false;
    }
  else
    return true;
  }

Check for run conditions including data binding, returning an exception for the first problem encountered.

Check for run conditions including data binding.

Cognex Internal use only.

Event that is raised at the start of the tool's Run method.

Event that is raised at the end of the tool's Run method.

Gets a CogDictionary object that can be used to store application-specific information.

CogDictionary containing application-specific information.

Gets or sets a user-supplied name for the tool.

User-supplied string used to identify the tool. The name cannot be empty if this tool is to be contained by a CogToolGroup.

ICogRunStatus object describing the status as of the last invocation of the Run method.

Gets the data bindings for the tool.

Data bindings for the tool.

Specifies that the Run method is to fail if executed while one or more data bindings are invalid.

Base class for CogDefaultToolTerminal subclasses. Application of a CogDefaultToolTerminalAttributeBase attribute identifies default terminals that will be created if a class type, rather than class instance, is passed to a CogToolGroup edit control for construction.

Creates a new instance of the CogDefaultToolTerminalAttributeBase class.

This terminal's index relative to other tool terminals. The name of the terminal. This is the value that is displayed to the user. The path to the method or property that this terminal represents.

Gets terminal's index relative to other tool terminals.

Position index of default terminal relative to like default terminals.

Name of the terminal.

Name of the terminal. This is the value that is displayed to the user when identifying a terminal.

Path to the method or property that this terminal represents.

Dot delimited path to the method or property that this terminal represents. The path is relative to the class upon which this attribute is applied.

Attribute applied to tools for identifying a method or property as one of its default input terminals. Note: this attribute is only effective when constructing a tool via a type-based vision tool template.

Creates a new instance of the CogDefaultToolInputTerminalAttribute class.

This terminal's index relative to other tool input terminals. The name of the terminal. This is the value that is displayed to the user. The path to the method or property that this terminal represents.

Attribute applied to tools for identifying a method or property as one of its default output terminals. Note: this attribute is only effective when constructing a tool via a type-based vision tool template.

Creates a new instance of the CogDefaultToolOutputTerminalAttribute class.

This terminal's index relative to other tool output terminals. The name of the terminal. This is the value that is displayed to the user. The path to the method or property that this terminal represents.

Attribute used to specify the strongly-named type of a node class to associate with a tool class.

Creates a new instance of the CogToolNodeAttribute class.

The strongname of the type used to represent the tool.

Gets the strongname of the type used to represent the tool.

The strongname of the type used to represent the tool. The strongname must be the CogTreeNode type or a subclass of it.

A class containing miscellaneous VisionPro utility methods.

A static method used to obtain the VisionPro base directory.

A string identifying the base directory path where VisionPro is installed.

A static method used to obtain the VisionPro bin directory.

A string identifying the VisionPro bin directory path.

Class used to synchronize access to VisionPro members. Multithreaded applications must provide an instance of this class to any edit controls sharing tools the application will be accessing from a non-GUI thread. It is the responsibility of the application to lock and unlock the CogSyncObject whenever it is accessing the tool.

Locks this object, blocking if necessary. Fires the event if this object was previously unlocked.

Try to lock this object immediately. If successful, and the object was previously unlocked, fire the event.

True if the object is locked successfully. Otherwise, false.

Unlocks this object and fires the event if the calling thread has called this method as many times as it has called or .

The current thread does not own the lock for this object.

Method responsible for notifiying registered objects of the event

This event is raised when this object is locked

This event is raised when this object is unlocked

Gets or sets a user-specified thread ID.

The user-specified thread ID. The default value is zero. This property is a convenience for users who wish to store the ID of the thread that has locked this CogSyncObject. Use of this property is optional.

A delegate for the CogVisionToolSyncRoot Lock event.

A delegate for the CogVisionToolSyncRoot Unlock event.

Interface that defines a single, read-only boolean, and an event that fires whenever the boolean value is toggled from true to false, or from false to true.

Clients can use the Toggled event to immediately synchronize their state with changes to the boolean.

Gets the value of the boolean.

Event that is raised after the boolean value is toggled.

Class that defines a single, read-only boolean, and an event that fires whenever the boolean value is toggled.

This class implements the ICogSyncBoolean interface, and also provides a way to directly set the boolean value. Clients can use the Toggled event to immediately synchronize their state with changes to the boolean.

Gets the value of the boolean.

Event that is raised after the boolean value is toggled.

Interface that defines a single synchronization pulse event. Iterative operations can fire this event each time they reach a defined "synchronization point" in their processing loop.

Event that represents a synchronization pulse.

Class that defines a single synchronization pulse event. Iterative operations can fire this event each time they reach a defined "synchronization point" in their processing loop.

This class implements the ICogSyncPulse interface, and also provides a way to directly fire the SyncPulse event.

Fires the synchronization pulse event.

Event that represents a synchronization pulse.

Serialization Constructor - necessary for save/restore.

This class manipulates strings in resource files. It provides methods for changing the current cultureinfo, retrieving a particular string from a given resource file, and formatting a string in a specific way.

Sets the UI culture to use everywhere in VisionPro. Must be called first at the start of an application when overriding system installed culture setting.

Gets the best-match localization of the string referenced by strKey.

Type associated with strKey resource. Type must reside in the same assembly as the string resource where strKey is located. Key to look up the string to localize. Resource string localized for current culture.

Replaces the format item in the best-match localization of the string referenced by strKey with the text equivalent of the value of a specified Object instance.

Type associated with strKey resource. Type must reside in the same assembly as the string resource where strKey is located. Key to look up the string to localize containing zero or more format items. An Object to format. A copy of the localized string in which the first format item has been replaced by the String equivalent of arg0.

Replaces the format items in the best-match localization of the string referenced by strKey with the text equivalent of the value of two specified Object instances.

Type associated with strKey resource. Type must reside in the same assembly as the string resource where strKey is located. Key to look up the string to localize containing zero or more format items. The first Object to format. The second Object to format. A copy of the localized string in which the first and second format items have been replaced by the String equivalents of arg0 and arg1.

Replaces the format items in the best-match localization of the string referenced by strKey with the text equivalent of the value of three specified Object instances.

Type associated with strKey resource. Type must reside in the same assembly as the string resource where strKey is located. Key to look up the string to localize containing zero or more format items. The first Object to format. The second Object to format. The third Object to format. A copy of the localized string in which the first, second, and third format items have been replaced by the String equivalents of arg0, arg1, and arg2.

Gets the help filename embedded in the specified type.

Type associated with the helpfile resource A copy of the help filename for the type.

Get the string ResourceManager from the assembly.

Assembly containing the string ResourceManager. The string ResourceManager.

Construct a localizer that can localize resources associated with the given type. The localizer determines what resource pool to load based on information in the given type.

The type associated with the resources to load.

Gets the best-match localization of the string specified by strKey.

Key to look up the string to localize. Resource string localized for current culture.

Replaces the format item in the best-match localization of the string referenced by strKey with the text equivalent of the value of a specified Object instance.

Key to look up the string to localize containing zero or more format items. An Object to format. A copy of the localized string in which the first format item has been replaced by the String equivalent of arg0.

Replaces the format items in the best-match localization of the string referenced by strKey with the text equivalent of the value of two specified Object instances.

Key to look up the string to localize containing zero or more format items. The first Object to format. The second Object to format. A copy of the localized string in which the first and second format items have been replaced by the String equivalents of arg0 and arg1.

Replaces the format items in the best-match localization of the string referenced by strKey with the text equivalent of the value of three specified Object instances.

Key to look up the string to localize containing zero or more format items. The first Object to format. The second Object to format. The third Object to format. A copy of the localized string in which the first, second, and third format items have been replaced by the String equivalents of arg0, arg1, and arg2.

Returns the value of the specified Object resource.

The name of the resource to get. The value of the localized resource. If a match is not possible, a null reference (Nothing in Visual Basic) is returned. The resource value can be a null reference (Nothing).

Interface that describes some vision data.

Custom VisionPro class for resolving string based .NET type information. Tries to mimic .NET's behavior (i.e. Type.GetType()) except to: 1. Override strong name version binding for VisionPro assemblies (use the newest version available). 2. Override strong name version binding for customer assemblies with the CogSerializationBinderAttribute.UseLatestVersionBinder set to true. (use the newest version available). 3. Override strong name version binding for assemblies that use the CogSerializationBinderAttribute.CustomBinder (by calling the custom binder). 4. Enable Resolving of VisionPro types using type string information that was specified without (or with partial) assembly information, especially if this type is not already loaded in the app domain (by searching the VisionPro assembly metadata). CogTypeResolveUtils exists because VisionPro updates the strong name version numbers of its assemblies for every release yet still wants VisionPro types from assemblies with earlier version #'s (usually in vpp files) to be bound or resolved to their equivilent types in newer versions of the VisionPro assemblies. This requires overiding the normal .NET strong name binding conventions with a custom scheme (described above). Most (all?) of this code would not be necessary if VisionPro only updated its assembly version numbers for truly incomaptible (breaking) changes to an assembly.

Resolve the type name infomration contained in typeName using VisionPro's custom type resolving scheme.

The assembly-qualified name of the type to get. If the type is a VisionPro type it is sufficient to supply the type name qualified by its namespace. The resolved type. For Cognex Internal Use Only! For VisionPro types (and third party types whose assemblies have the CogSerializationBinderAttribute.UseLatestVersionBinder set to true) this function will ignore any strong name version infomation and return Types bound to the latest (highest assembly version number) Assembly found in the GAC. Throws TypeLoadException().

Strips the version information from an AQN or a type FullName. For example, "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Version=43.0.0.0, Culture=neutral, PublicKeyToken=ef0f902af9dee505" becomes "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Culture=neutral, PublicKeyToken=ef0f902af9dee505"

The type spec from which to remove the version info. The type spec with the version info removed.

Strips the culture information from an AQN or a type FullName. For example, "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Version=43.0.0.0, Culture=neutral, PublicKeyToken=ef0f902af9dee505" becomes "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Version=43.0.0.0, PublicKeyToken=ef0f902af9dee505"

The type spec from which to remove the culture info. The type spec with the culture info removed.

Strips the public key information from an AQN or a type FullName. For example, "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Version=43.0.0.0, Culture=neutral, PublicKeyToken=ef0f902af9dee505" becomes "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Version=43.0.0.0, Culture=neutral"

The type spec from which to remove the public key info. The type spec with the public key info removed.

Strips all strong name details from an AQN or a type FullName. For example, "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob, Version=43.0.0.0, Culture=neutral, PublicKeyToken=ef0f902af9dee505" becomes "Cognex.VisionPro.Blob.CogBlob, Cognex.VisionPro.Blob"

The type spec from which to remove the strong name details. The type spec with the strong name details removed.

Performs a simple check on the fully qualified assemblyName string to see if it contains public key information which is a known Microsoft public key.

The fully qualified assemblyName true if assemblyName contains a Microsoft PublicKeyToken System.ArgumentNullException

Performs a simple check on the fully qualified assemblyName string to see if it is a known VisionPro assembly.

The fully qualified assemblyName True if the assemblyName starts with "Cognex.VisionPro" and contains the VisionPro PublicKeyToken System.ArgumentNullException

Performs a simple check on the Full Name (including namespace) of typeName to see if it is a "System" assembly.

The type neme to check True if typeName starts with "System." System.ArgumentNullException

Check to see if is a generic type by scanning for an unescaped backtick; '`'.

The typeName string to check for generic type information True if type name is generic, otherwise false Note that this routine does not ensure that typeName is a valid type name specification System.ArgumentNullException

Returns the assembly version information this assembly(Cognex.VisionPro.dll).

Returns the CultureInfo of this assembly(Cognex.VisionPro.dll).

Returns the PublicKeyToken of this assembly (Cognex.VisionPro.dll) and all other VisionPro assemblies.

Returns the Assembly FullName from an assembly qualified type name

The assembly qualified type name from which to retreive the full name of the assembly the full name of the Assembly Name System.ArgumentNullException System.ArgumentException

Returns a more display friendly version of an assembly qualified type name. It does this by stripping out all the assembly information from any generic arguments.

The assembly qualified type name from which to retireve the display name the Display friendly string System.ArgumentNullException System.ArgumentException

Returns the root type or element type name from an AQN. The Root type is the top level element type of the type. For example, The root type of "Cognex.VisionPro.Blob.CogBlob[][]" is "Cognex.VisionPro.Blob.CogBlob".

the AQN from which to get the type name the Type Name

Caches the latest assembly info structures that have allready been looked up.

Gets the latest assembly info based on the assemblyRef string.

The fully qualified assembly name of an assembly which potentially contains an older assembly version number. The latest assembly info structure for the latest assembly (highest version #) found on the machine. GetLatestAssemblyInfo() removes the version info from the assemblyRef string and uses LoadWithPartialName() to locate the latest version of the assembly available.

Holds a cached map of all VisionPro types back to the assembly which contains them.

Searches through the metadata of all the VisionPro assemblies present on this machine searching for the type which matches typeName.

The FullName of the type (including namespace) to search for. The FullName of the assembly where the type is found, or the empty string, "", if no assembly is found.

Returns the correct assembly based info provided using the VisionPro "use latest" mechanism. Passed as a delegate to CogTypeSpec.Resolve().

The assembly name to resolve The resolved (and loaded) assembly

Returns the correct type based info provided using the VisionPro "use latest" mechanism. Passed as a delegate to CogTypeSpec.Resolve().

The assembly which containst the type (or null if unknown) The name of the type

Used to retrieve the Latest Version Info of an assembly in a second app domain to avoid loading unwanted assemblys into the primary appdomain.

Used to lookup table of all VisionPro types back to the assembly which contains them.

This enumeration contains constants that are used by the CogSerializationOptionsAttribute to associate a serialization option with specific fields

Serialize a minimum set of properties. Excludes input/output images and results.

Serialize result objects.

Serialize input images.

Serialize output images.

Serialize images contained in ToolBlock terminals.

Do not serialize databindings.

Serialize all types of properties.

This attribute is applied to databindings fields in order to indicate that the databinding fields should not be serialized if the ExcludeDataBindings serialization option is set.

This attribute is applied to selected fields of VisionPro types in order to indicate that their serialization is optional, based on the bit flags in the CogSerializationOptionsConstants enumeration.

The serialization option bit for this field.

Creates a new instance of the CogSerializationOptions class.

One and only one member of the CogSerializationOptionsConstants enumeration (excluding All and Minimum), indicating the option bit for this field.

This attribute is applied to assembiles to select non-default binding schemes, such as the standard VisionPro scheme of upgrading loaded objects to the latest available assembly version.

The selected custom binder or null.

Creates a new instance of the CogSerializationBinderAttribute class. Indicates that a binder which upgrades types to the latest assembly verion will be used.

Creates a new instance of the CogSerializationBinderAttribute class.

A fully qualified type name for the custom binder for this attribute. If null, then the default .NET binding rules apply (generally indicating that side-by-side versioning is desired).

Creates a new instance of the CogSerializationBinderAttribute class.

A fully qualified type name for the custom binder for this attribute. If null, then the default .NET binding rules apply (generally indicating that side-by-side versioning is desired). Dictates whether to upgrade to the latest assembly verion.

This class serializes and deserializes objects in such a way that if fields are added or removed in future versions of an object, it does not cause an error when the object is loaded.

Populates the provided SerializationInfo with the data needed to serialize the object.

The object to serialize. The SerializationInfo to populate with data. The destination for this serialization.

Populates the provided SerializationInfo with the data needed to serialize the object.

The object to serialize. The SerializationInfo to populate with data. The destination for this serialization. A base class of "obj" which has it's own, non-visionpro serialization implementation. GetObjectData() will not serialize the private members of this base class.

Populates the object using the information in the SerializationInfo.

The object to populate. The information to populate the object. The source from which the object is deserialized. The populated deserialized object.

Populates the object using the information in the SerializationInfo.

The object to populate. The information to populate the object. The source from which the object is deserialized. The populated deserialized object. A base class of "obj" which has it's own, non-visionpro serialization implementation. SetObjectData() will not deserialize the private members of this base class.

Returns true if the serilaized object data has a memberName.

The object that holds the serialized object data. The name of the member being checked.

Returns true if the serilaized object data has a memberName.

The object that holds the serialized object data. The name of the member being checked. Returns the instance type of the member in the serialized object data

This class provides for the VisionPro binding behavior. If the latest version of the given assembly has the attribute "CogSerializationBinderAttribute", then this attribute is used to select a binder for that assembly. Otherwise, assembly version independence is provided to Cognex.* types automatically (Cognex types referred to in archives will be automatically upgraded to the latest installed assembly version).

Creates a new instance of the CogSerializationBinder class.

Supplemental serialization binder.

Remove the version info from the given assembly name.

The assembly name with version info removed.

Controls the binding of a serialized object to a type.

Specifies the Assembly name of the serialized object. Specifies the Type name of the serialized object. The type of the object the formatter creates a new instance of.

When serializing or deserializing, an instance of this class can be passed in as the "additional" parameter to the constructor of a SerializationContext structure in order to selectively serialize fields according to their option bits.

The option bits for the fields to be serialized.

Given a set of option bits, returns a value to be passed into the "additional" parameter of a StreamingContext structure.

The serialization option bits. Returns a new instance of the CogSerializationOptionsContext class unless optionBits=CogSerializationOptionsConstants.All, in which case it returns null.

Returns true if a given field should be serialized.

The field to determine whether or not to serialize. True if member should be serialized; false otherwise.

Returns true if a given field should be serialized.

The field which may or may not be serialized. The parent object containing the field which is going to be serialized (or not). True if fieldToSerialize should be serialized; false otherwise.

Returns true if a given field should be deserialized.

The field which may or may not be deserialized. The serialization info object containing data being deserialized. True if fieldToDeserialize should be deserialized; false otherwise.

Return the enum which identifies which "category" of optional serialization attributes fieldInfo was marked with (if any). If fieldInfo is _not_ optional this function returns CogSerializationOptionsConstants.Minimum.

Returns true if obj implements ICogImage

Returns true if type implements ICogImage

Serialization surrogate used when serializing delegates.

Creates a new instance of the CogDelegateSerializationSurrogate class.

Serializes an object.

The object to serialize. The object that holds the serialized object data. The contextual information about the SerializationInfo.

Returns the real object that should be deserialized, rather than the object that the serialized stream specifies.

The StreamingContext from which the current object is deserialized. Returns the actual object that is put into the graph.

Creates a new instance of the CogDelegateSerializationSurrogate class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Serialization surrogate used when serializing type objects.

Creates a new instance of the CogTypeSerializationSurrogate class.

Serializes an object.

The object to serialize. The object that holds the serialized object data. The contextual information about the SerializationInfo.

Returns the real object that should be deserialized, rather than the object that the serialized stream specifies.

The StreamingContext from which the current object is deserialized. Returns the actual object that is put into the graph.

Creates a new instance of the CogTypeSerializationSurrogate class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Serialization surrogate used when serializing exception objects.

Serializes an object.

The object to serialize. The object that holds the serialized object data. The contextual information about the SerializationInfo.

Populates the object using the information in the SerializationInfo.

The object to populate. The information to populate the object. The source from which the object is deserialized. The surrogate selector where the search for a compatible surrogate begins. The populated deserialized object.

Serialization surrogate used when serializing MemberInfo objects.

Serializes an object.

The object to serialize. The object that holds the serialized object data. The contextual information about the SerializationInfo.

Populates the object using the information in the SerializationInfo.

This class is needed to properly deserialize the System.Drawing.Font class with the SoapFormatter. Font deserialization with the SoapFormatter is broken in the .NET framework as of version 1.1.

Creates a new instance of the CogFontSerializationSurrogate class.

Serializes an object.

The object to serialize. The object that holds the serialized object data. The contextual information about the SerializationInfo.

Populates the object using the information in the SerializationInfo.

Serialization surrogate selector for VisionPro objects.

Creates a new instance of the CogSerializationSurrogateSelector class.

Supplemental surrogate selector.

Returns the next surrogate selector in the chain.

The next surrogate selector in the chain, or a null reference (Nothing in Visual Basic).

Finds the surrogate that represents the specified object's type, starting with the specified surrogate selector for the specified serialization context.

The Type of object (class) that needs a surrogate. The source or destination context for the current serialization. When this method returns, contains an ISurrogateSelector that holds a reference to the surrogate selector where the appropriate surrogate was found. This parameter is passed uninitialized. The appropriate surrogate for the given type in the given context.

Specifies the next ISurrogateSelector for surrogates to examine if the current instance does not have a surrogate for the specified type and assembly in the specified context.

The next surrogate selector to examine.

Internal use only. Get event delegates from the input object.

Internal use only. Public static method.

Different kinds of event delegates can be get. If you choose EditControlEvents, then it gets all delegates derived from the edit control, including CogWeakChangedEventDelegate pointed alive delegates. Note: If you choose Non-WeakChangedEvents, you won't be able to get alive CogWeakChangedEventDelegate pointed delegates, which are derived from the edit control.

This section handles events from the subject collection and updates the grids rows to match

This class watches a property or sub-property of an object, and raises a Changed event when the value of the property has changed.

State flag for the Subject property.

State flag for the Path property.

State flag for the PropertyDescriptor property.

State flag for the Value property.

State flag for the OptimizeIneffectiveChanges property.

State flag for the IsConnected property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogPropertyWatcher class.

Constructs a new instance of the CogPropertyWatcher class with the given subject and path.

Object instance to monitor. Path to property to monitor.

Constructs a new instance of the CogPropertyWatcher class with the given subject and path.

Object instance to monitor. Path to property to monitor. Extra flag used while constucting property watchers as part of the deserializing process. This helps ensure that the subject targets are fully deserialzed before we hook up to them.

Constructs a new instance of the CogPropertyWatcher class with the same subject and path as the other instance.

Template instance used to initialize this instance.

Initializes a new instance of the CogPropertyWatcher class with serialized data.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Raises the Disposed event.

Attaches to a new subject and path.

Object instance to monitor. Path to property to monitor.

This must be called when the Path has changed. It Parses the Path string into _PropertyName and (optionally) _SourcePath.

Disconnects and disposes of any existing source watcher.

Disconnects ValueChanged notifications from the property descriptor

This is called when the Subject and/or Path has changed. If the Path is complex, it adds a new watcher for the source. Then it attaches to the new source object via SetSource.

Checks for a valid state for getting and setting the property value, and throws an exception if not valid.

This is called when the source object has changed. It disconnects any old property descriptor ValueChanged notification on the old source, and if the new source is non-null then it establishes a new property descriptor ValueChanged notification.

This function gets called when the property descriptor detects a change in the property.

This function gets called when the _SourceWatcher detects a change in the parent property from which the _Source is obtained.

This event is raised when the Dispose method is called. It gets called before any disposing is done so the properties of this object are still valid at this point.

Gets or sets the object whose property or sub-property is being watched.

Gets or sets the path to the property or sub-property being watched.

Gets or sets the value of the property.

Indicates if this property watcher is currently connected to a valid property.

Gets the property descriptor of this property.

Indicates if Dispose has been called on this instance.

Determines if this property watcher will optimize out any attempts to set Value to its current value.

This class represents a binding for an input property of an object or one of its sub-objects.

State flag for the Source property.

State flag for the SourcePath property.

State flag for the SourceProperty property.

State flag for the UpdateException property.

State flag for the Container property.

State flag for the OptimizeIneffectiveChanges property.

Next state flag to be used in derived classes.

Source of the data.

Note that this field is accessed via reflection by cells of the Cognex.VisionPro.Implmentation.CogGridView.

Exception thrown when the binding tried to update its value.

Collection containing this instance.

Constructs a new instance of the CogDataBinding class.

The destination object. The property name or dotted path to the destination property. The source object. The property name or dotted path to the source property.

Constructs a new instance of the CogDataBinding class.

The destination object. The property name or dotted path to the destination property. The source object. The property name or dotted path to the source property. Determines if the source and destintation are immeadiatley syncronized when a new databinding is created. If true creating a new databinding will cause the destination value to be immeadiatley updated/syncronized with the source value. If false, the destination value will not be updated unitl the source value has changed.

Initializes a new instance of the CogDataBinding class with serialized data.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Frees all resources used by the CogDataBinding and removes it from its container.

Redirects the binding to a new source and path.

The source object. The property name or dotted path to the source property.

Reads the current value of the source property. May throw an exception if the source property is not currently valid.

Refreshes the destination property from the source

Passes the value from the DataSource binding to the destination property. If an exception occurs, it is stored in the _Exception field and not re-thrown by this function.

Gets a list of all output properties that can be assigned to the given type.

The type of the property to which the output's value will be assigned. The object that is the source of the data. An ArrayList of strings, each of which is a path to a compatible property.

Gets a list of all output properties that can be assigned to the given type. This override should only be called if an instance of the source object is not available.

The type of the property to which the output's value will be assigned. The type of the object that is the source of the data. An ArrayList of strings, each of which is a path to a compatible property.

Gets an array of all data bindings bound to a property of the supplied object. Data bindings having complex paths in which any portion reference the source object, are also included in the array.

Find all databindings for whom this object is the source object. Note: only supported for arguments implementing ICogChangedEvent. Array of data bindings, each of which uses (possibly implicitly) as its source object.

Gets the destination object.

Gets the destination property name or dotted property path.

Gets a PropertyDescriptor for the destination property.

Gets the source object.

Gets the source property name or dotted property path.

Gets a PropertyDescriptor for the source property.

Gets the exception, if any, that was thrown when the binding attempted to update its property value from its DataSource.

Returns the collection that contains the binding.

Determines if this data binding will optimize out any attempts to set the destination property to its current value.

An ordered collection of CogDataBinding objects that raises events whenever any change is made.

State flag for the OptimizeIneffectiveChanges property.

State flag for the SyncOnInitialize property.

Next state flag to be used in derived classes.

Determines if the source and destintation are immeadiatley syncronized when a new databinding is added to the collection.

Constructs a new instance of the CogDataBindingsCollection class.

The parent object that owns the collection.

Constructs a new copy of the CogDataBindingsCollection class.

The parent object that owns the new collection. The existing CogDataBindingsCollection to copy.

Constructs a new copy of the CogDataBindingsCollection class.

The parent object that owns the new collection. The existing CogDataBindingsCollection to copy. Option to use the old broken mode for possible backward compatibility issues. In historical mode the databindings do not set their destination to the supplied parent argument.

Initializes a new instance of the CogDataBindingsCollection class with serialized data.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a deep copy of the collection.

A deep copy of the cloned collection.

Binds the specified input from the specified property of the source object.

The property name or dotted path to the input property to bind. The object that provides the source property. The property name or dotted path to the source property. The newly-created CogDataBinding.

Replaces the current binding to the specified input with a binding from the specified property of the specified source object.

The property name or dotted path to the input property to re-bind. The new object that provides the source property. The property name or dotted path to the new source property. The newly-created CogDataBinding.

Searches for the specified CogDataBinding and returns its zero-based index.

The binding to locate in the collection. The zero-based index of the item if found; otherwise, -1.

Searches for a CogDataBinding with the given DestinationPath and returns its zero-based index.

The value of the DestinationPath property of the item to locate. The index of the item or -1 if it is not in the collection.

Determines whether a CogDataBinding is in the CogDataBindingsCollection.

The CogDataBinding to locate in the CogDataBindingsCollection. True if item is found in the CogDataBindingsCollection; otherwise, false.

Determines whether a CogDataBinding with the given DestinationPath is in the CogDataBindingsCollection.

The value of the DestinationPath property of the item to locate. True if item corresponding to destinationPath is found in the CogDataBindingsCollection; otherwise, false.

If the collection contains the given binding, removes it and calls its Dispose method.

Item to remove from the collection. Item is disposed after it is removed.

If the collection contains a binding with the given path, removes it and calls its Dispose method.

Destination path of item to remove.

Validates that an item being added or replaced is valid.

The new binding item. The index of the item being replaced, or -1 if it's being added.

Gets the object to which the collection belongs.

Determines if the source and destintation are immeadiatley syncronized when a new databinding is added to the collection. If true, adding or replacing a databinding will cause the destination to be immeadiatley updated/syncronized with the source value. If false, the destination will not be updated unitl the source property changes.

Get or set the binding object at the given index.

Index of binding object.

Get or set the binding object with the given DestinationPath.

Destination path of binding object to access.

Converts the unadapted PROPERTY value to the adapted CONTROL value

Converts the adapted CONTROL value "back" to the unadapted PROPERTY value.

The unadapted PROPERTY value type

The adapted CONTROL value type

Contains common extension methods of enumeration types.

Creates a List with all keys and values of a given Enum class

Must be derived from class Enum! A list of KeyValuePair<Enum, string> with all available names and values of the given Enum.

Summary description for CogPropertyTypeAdapterAttribute.

Summary description for CogTypeAdapterAttribute.

Summary description for CogReturnTypeAdapterAttribute.

Summary description for CogParameterTypeAdapterAttribute.

An ordered collection of VisionPro tools that raises events whenever a change is made.

State flag for the Parent property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogToolCollection class.

The object containing this CogToolCollection.

Constructs a new instance of the CogToolCollection class.

The items initially contained by this CogToolCollection.

Constructs a new instance of the CogToolCollection class.

The items initially contained by this CogToolCollection. The object containing this CogToolCollection.

Constructs a new instance of the CogToolCollection class.

A CogToolCollection to copy.

Constructs a new instance of the CogToolCollection class.

A CogToolCollection to copy. The object containing this CogToolCollection.

Constructs a new instance of the CogToolCollection class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a deep copy of the tool collection.

A deep copy of the cloned tool collection.

Returns an enumerator that can iterate through the CogToolCollection's elements.

An IEnumerator that can be used to iterate through the CogToolCollection's ICogTools.

Removes the first occurrence of a specific ICogTool from the CogToolCollection.

The key identifying the ICogTool to remove from the CogToolCollection.

Determines whether the CogToolCollection contains an ICogTool with the specified key.

The key to locate in the CogToolCollection. True if the CogToolCollection contains an ICogTool with the key; otherwise, false.

Adds an item to the CogToolCollection.

The ICogTool to add to the CogToolCollection.

Inserts an ICogTool into the CogToolCollection at the specified position.

The zero-based index at which value should be inserted. The ICogTool to insert into the CogToolCollection.

Removes the first occurrence of a specific ICogTool from the CogToolCollection.

The ICogTool to remove from the CogToolCollection.

Determines whether the CogToolCollection contains a specific ICogTool.

The ICogTool to locate in the CogToolCollection. True if the CogToolCollection contains value; otherwise, false.

Determines the index of the ICogTool with the specified key.

The key to locate in the CogToolCollection. The index of value if found in the CogToolCollection; otherwise, -1.

Determines the index of a specific ICogTool in the CogToolCollection.

The ICogTool to locate in the CogToolCollection. The index of value if found in the CogToolCollection; otherwise, -1.

Insert one or more tools from a toolbox item.

The index at which to insert. An ArrayList containing the tools inserted.

Returns a collection containing all PropertyDescriptors found in the standard fasion, augmented with property descriptors for each ICogTool that can be obtained using the string overload of the item indexer.

An array of type Attribute that is used as a filter. An array of type Attribute that represents the properties for this CogToolCollection instance that match the given set of attributes.

Raises the InsertingItem event.

Index at which the item will be inserted. Value of item being inserted.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacingItem event.

Index of item being replaced. Value of item being replaced. Value of item replacing oldValue.

Raises the Clearing event.

Gets or sets the parent object of this CogToolCollection.

Parent object of this CogToolCollection. Useful when determining an ICogTool's ancestry.

Gets or sets the ICogTool at the specified index. In C#, this property is the indexer for the CogToolCollection class.

The zero-based index of the ICogTool to get or set. The ICogTool at the specified index.

Gets or sets the ICogTool with the specified key. In C#, this property is the indexer for the CogToolCollection class.

The key of the ICogTool to get or set. The ICogTool with the specified key.

Creates a new instance of the CogDictionaryEnumerator class.

An IEnumerator to wrap.

Type implementing a polymorphic variable. Similar to a COM variant, except the set of possible types is established via generic type params.

Mainly used as the type of a polymorphic property. Polymorphic properties are the conceptual inverse of generic properties having base constraints. A polymorphic property is, at any moment, representative of one of a set of possible types; whereas a base constrained generic property is, at all moments, representative of an entire set of required types.

This is the base class for all VisionPro exceptions.

Constructs a new instance of the CogException class.

Initializes a new instance of the CogException class with a specified error message.

A message that describes the error.

Initializes a new instance of the CogException class with a specified error message and a reference to the inner exception that is the cause of this exception.

A message that describes the error. The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

Initializes a new instance of the CogException class with serialized data.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Sets a link to the help file associated with this exception.

Filename of help file to associate with this exception.

The exception that is thrown when the video format is not recognized, or no connected camera supports the video format.

The exception that is thrown when the period expires.

The exception that is thrown when the is not valid.

The exception that is thrown when a trigger could not be serviced.

The exception that is thrown when there is no outstanding for the supplied ticket.

The exception that is thrown when the ticked supplied corresponds to an image that has already been collected.

The exception that is thrown when a FIFO was not associated with a frame grabber.

The exception that is thrown when the acquisition trigger model selected is not compatible with the type of acquisition performed by an acquisition FIFO. For example, it is an error to call the Acquire method when the trigger model is 'Auto'. See for more information.

The exception that is thrown when the FIFO fills up. The size of the FIFO queue is 32 requests.

The exception that is thrown when the acquisition fails because of a fault in the acquisition hardware, or because of some other unusual problem. This failure should never happen in a properly functioning system. Some examples of abnormal failures are a blown camera fuse or a temperature alert that indicates that the frame grabber is overheating.

The exception that is thrown when you attempt an illegal operation on a slave FIFO.

The exception that is thrown when a FIFO cannot have a slave FIFO because of incompatible video formats or because there are no available ports for slave FIFOs.

The exception that is thrown when a timing error occurs.

The exception that is thrown when another process is using the hardware resource. Only a single process per computer can make use of Cognex hardware.

The exception that is thrown when no cameras are available with which to acquire an image.

The exception that is thrown when there was an error in another FIFO in the same master/slave group.

The exception that is thrown when an acquisition ticket is -1, but there are no outstanding StartAcquire requests.

The exception that is thrown when an encoder overrun occurs.

The exception that is thrown when no more acquisition requests can be made. The limit is 32 acquisition requests. You must call either CompleteAcquire or Flush to remove completed acquisition requests from the acquisition FIFO.

The exception that is thrown when a FIFO cannot be created (digital or linescan cameras onl

.")

The exception that is thrown when a register read or write access has failed (digital cameras only.)

.")

An interface that comprises the events that are common to most editable keyed VisionPro collections.

Raised before an item's key is changed.

Raised after an item's key is changed.

Arguments for InsertingItem and InsertedItem events.

Gets the index at which the item is inserted.

Gets the value that is inserted.

Constructs a new instance of the CogCollectionInsertEventArgs class.

Index of item inserted. Value of item inserted.

The delegate for the InsertingItem and InsertedItem events.

Arguments for the RemovingItem and RemovedItem events.

Gets the index at which the item is removed.

Gets the value that is removed.

Constructs a new instance of the CogCollectionRemoveEventArgs class.

Index of item removed. Value of item removed.

The delegate for the RemovingItem and RemovedItem events.

Arguments for the ReplacingItem and ReplacedItem events.

The index at which the item is replaced.

The old value at the given index.

The new value at the given index.

Constructs a new instance of the CogCollectionReplaceEventArgs class.

The index at which the item is replaced. The old value at the given index. The new value at the given index.

Delegate for the ReplacingItem and ReplacedItem events.

Arguments for the MovingItem and MovedItem events.

The index from which the item is moved.

The index to which the item is moved.

Constructs a new instance of the CogCollectionMoveEventArgs class.

The index from which the item is moved. The index to which the item is moved.

Delegate for the MovingItem and MovedItem events.

Arguments for the KeyChanging and KeyChanged events.

The index at which the item's key is changed.

The old key.

The new key.

Constructs a new instance of the CogCollectionKeyChangeEventArgs class.

The index at which the item's key is changed. The old key. The new key.

Delegate for the KeyChanging and KeyChanged events.

arguments for events that can be cancelled with an exception.

An exception to be raised by the setter that caused the changing event that was canceled. If the exception is null no exception is thrown.

Delegate for changing events that can be cancelled with an exception.

Generic, serializable ordered collection of values that can be enumerated.

This class is typically used to provide IEnumerable-only access to an existing collection.

State flag for the GetEnumerator method.

Next state flag to be used in derived classes.

Constructs a CogEnumerableCollection wrapper around inner.

The collection encapsulated by this instance.

Creates a CogEnumerableCollection wrapper around inner.

The collection encapsulated by the returned CogEnumerableCollection instance.

Special serialization constructor.

Data used to deserialize the collection. Context to deserialize the serialization info.

Raises the Clearing event.

Raises the Cleared event.

Raises the InsertingItem event.

Index at which the item will be inserted. Value of item being inserted.

Raises the InsertedItem event.

Index at which the item has been inserted. Value of the item inserted.

Raises the RemovingItem event.

Index of item being removed. Value of item being removed.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacingItem event.

Index of item being replaced. Value of item being replaced. Value of item replacing oldValue.

Raises the ReplacedItem event.

Index of item replaced. Value of item replaced. Value of item that replaced oldValue.

Raises the MovingItem event.

Index of item being moved. Destination index of item being moved.

Raises the MovedItem event.

Source index of item moved. New index of item moved.

Generic, serializable ordered collection of values that can be indexed.

This class is typically used to limit access to an existing collection. Specifically, collection access is limited to IEnumerable and indexer methods.

State flag for the Item (indexer) property.

State flag for the Count property.

Next state flag to be used in derived classes.

Constructs a CogIndexableCollection wrapper around inner.

The collection encapsulated by this instance. The method used to implement the indexer setter. The argument must be a serializable delegate. Note that the delegates produced by lambda expressions are not serializable.

Creates a CogIndexableCollection wrapper around inner.

The collection encapsulated by the returned CogIndexableCollection instance.

Special serialization constructor.

Data used to deserialize the collection. Context to deserialize the serialization info.

Default serialization excludes Action fields. This overload manually persists one such field.

Persistence object used to store the instance data. Context in which the instance data is being persisted.

Causes the list of items to show up in the property grid.

Raises the Cleared event.

Raises the InsertedItem event.

Index at which the item has been inserted. Value of the item inserted.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacedItem event.

Index of item replaced. Value of item replaced. Value of item that replaced oldValue.

Raises the MovedItem event.

Source index of item moved. New index of item moved.

Gets or sets element at the specified index.

The zero-based index of the element. The element at the specified index. Index is less than zero or greater than Count-1.

The number of elements contained in the Collection.

Provides a serializable delegate for use as the Action argument to .

The inner collection type.

Base class for a generic ordered collection of values that raises events whenever any change is made.

A base class that implements the interface. Objects that derive from this class will raise the Changed event whenever part of the object's state has changed.

Classes can most easily implement the ICogChangedEvent interface by deriving from this class. However in some cases a class may need to derive from some other base class, so the actual implementation of the ICogChangedEvent behavior is provided by the class that can be used by delegation rather than by inheritance.

The next state flag value to be used by a derived class.

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.

If the ChangedEventSuspended count is currently zero.

This method should be called internally whenever the object's state may have changed.

The set of state flags that correspond to the parts of the object that may have changed.

This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class.

EventArgs to be fired with the change event.

This event is raised when one or more parts of the object's state may have changed.

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.

State flag for the Item (indexer) property.

State flag for the Count property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogCollectionBase class.

Constructs a new instance of the CogCollectionBase class initially containing items cloned from the supplied instance.

Collection whose items are cloned and added to the new collection. If the item does not support the ICloned interface, the item will be added. If other is null.

Creates a deep copy of the object. Must be overridden in derived classes.

A deep copy of the cloned instance.

Raises the Clearing event.

Raises the Cleared event.

Raises the InsertingItem event.

Index to insert item being inserted. Value of item being inserted.

Raises the InsertedItem event.

Index at which item was inserted. Value of item inserted.

Raises the RemovingItem event.

Index of item being removed. Value of item being removed.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacingItem event.

Index of item being replaced. Value of item being replaced. Value of item replacing oldValue.

Raises the ReplacedItem event.

Index of item replaced. Value of item replaced. Value of item that replaced oldValue.

Raises the MovingItem event.

Index of item being moved. Destination index of item being moved.

Raises the MovedItem event.

Source index of item moved. New index of item moved.

Removes all objects from the collection.

Moves an item from one position to another.

The item's original index. The item's new index.

Removes the element at the specified index.

The zero-based index of the element to remove.

Copies the contents of the collection to an array.

The array into which to copy. The starting index at which to copy.

Gets the internal ArrayList containing the list of elements.

Gets an the IList interface of this collection.

Raised before the collection is cleared.

Raised after the collection is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

Raised before an item is moved to a new index.

Raised after an item is moved to a new index.

Gets the number of elements contained in the collection.

An IList wrapper that prevents modifying the underlying collection; therefore, if changes are made to the underlying collection, this class reflects those changes.

An IDictionary wrapper that prevents modifying the underlying collection; therefore, if changes are made to the underlying collection, this class reflects those changes.

Base class to be used for a generic, serializable ordered collection of values that cannot be changed after it is contsructed. Intended to be used for Tool results collections.

Constructs an empty CogReadOnlyCollection;

Constructs a new instance of the CogReadOnlyCollection class. Note that the properties of the collection elements themselves can still be changed via this interface.

Wraps the items list int a CogReadOnlyCollection. Note that changes to the original list will be reflected in the Read only collection. Note that the properties of the collection elements themselves can still be changed via this interface.

Special serialization constructor.

Data used to deserialize the collection. Context to deserialize the serialization info.

Searches the collection for the specified object and returns the zero-based index of the first occurrence.

The object to locate. The zero based index of the first occurrence of item withing the collection, if found; otherwise, -1

Determines whether an element is in the collection.

The object to locate in the Collection true if value is found in the Collection, otherwise, false.

Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.

The one-dimensional Array that is the destination of the elements copied from Collection. The Array must have zero-based indexing. The zero-based index in array at which copying begins. array is null. arrayIndex is less than 0. The number of elements in the Collection is greater than the available space from arrayIndex to the end of the destination array.

Calls CopyTo() and returns a new array which contains the members of this collection.

A new array which contains the members of this collection.

Causes the list of items to show up in the property grid.

Gets the element at the specified index.

The zero-based index of the element to get. The element at the specified index. index is less than zero. OR index is greater than or equal to Count.

The number of elements contained in the Collection.

Base class to be used for a generic, NON-Serializable ordered collection of values that cannot be changed after it is contsructed.

Constructs an empty CogReadOnlyCollectionNonSerializable;

Constructs a new instance of the CogReadOnlyCollectionNonSerializable class. Note that the properties of the collection elements themselves can still be changed via this interface.

Wraps the items list int a CogReadOnlyCollectionNonSerializable. Note that changes to the original list will be reflected in the Read only collection. Note that the properties of the collection elements themselves can still be changed via this interface.

Searches the collection for the specified object and returns the zero-based index of the first occurrence.

The object to locate. The zero based index of the first occurrence of item withing the collection, if found; otherwise, -1

Determines whether an element is in the collection.

The object to locate in the Collection true if value is found in the Collection, otherwise, false.

Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.

Calls CopyTo() and returns a new array which contains the members of this collection.

A new array which contains the members of this collection.

Causes the list of items to show up in the property grid.

Gets the element at the specified index.

The zero-based index of the element to get. The element at the specified index. index is less than zero. OR index is greater than or equal to Count.

The number of elements contained in the Collection.

Constructs an empty CogReadOnlyIntCollection;

Special serialization constructor.

Data used to deserialize the collection. Context to deserialize the serialization info.

Base class for a generic, serializable ordered collection of values that raises events whenever any change is made.

This is really just a generic version of CogSerializableCollectionBase which allows the user to specify the type of object that is contained in the collection

State flag for the Item (indexer) property.

State flag for the Count property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogSerializableCollectionBase class.

Special serialization constructor.

Data used to deserialize the collection. Context to deserialize the serialization info.

Raises the Clearing event.

Raises the Cleared event.

Raises the InsertingItem event.

Index at which the item will be inserted. Value of item being inserted.

Raises the InsertedItem event.

Index at which the item has been inserted. Value of the item inserted.

Raises the RemovingItem event.

Index of item being removed. Value of item being removed.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacingItem event.

Index of item being replaced. Value of item being replaced. Value of item replacing oldValue.

Raises the ReplacedItem event.

Index of item replaced. Value of item replaced. Value of item that replaced oldValue.

Raises the MovingItem event.

Index of item being moved. Destination index of item being moved.

Raises the MovedItem event.

Source index of item moved. New index of item moved.

Removes all objects from the collection.

Moves an item from one position to another.

The item's original index. The item's new index.

Removes the element at the specified index.

The zero-based index of the element to remove.

Inserts the value at the specified index of the collection

Returns true if value is in the collection

Returns the index of value in the collection, or -1 if value is not in the collection.

Removes value from the collection

Adds value to the end of the collection.

The

Copies the collection to an array

Get an enumerator for the collection.

Gets the internal List containing the list of elements.

Gets an the IList interface of this collection.

Raised before the collection is cleared.

Raised after the collection is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

Raised before an item is moved to a new index.

Raised after an item is moved to a new index.

Gets the number of elements contained in the collection.

Returns true if this collection is ReadOnly

Returns the at

returns false

Base class for any class that will eventually implement ICogTrackedItem

Provides common state flags for all ICogTrackedItem implementers

Items in a CogTrackingCollection must implement this interface

Name state flag

ID state flag

Value state flag

ValueType state flag

ForceChangedEvent state flag

Called at the begining of a section of code that must raise a changed event containing the given state flags.

Called at the end of a section of code that must raise a changed event with the given state flags... If a changed event with these state flags has not been raised "naturally" since the coresponding call to BeginForceChangedEvents was called, this call will raise the event.

Gets or Sets the value of the terminal.

The terminal value property provides storage for arbitrary link data.

Gets or Sets the name of the terminal.

The terminal name is used to index a CogToolTerminalsCollection and also provide the name for the graphical representation of this terminal. Thrown if the "Name" is not a valid .NET variable name or if "Name" is not unique in within a ToolBlock terminal collection of which this terminal is a member.

Gets the ID property of the terminal

The terminal ID holds a GUID string which identifies a particular terminal object instance. A new GUID is created and assinged to the ID property when a terminal is created using the (name, value) or (name, valueType) constructor. The ID property is serialized. The ID property is cloned. The ID property is used to index CogToolTerminalsCollection. Indexing by ID provides a path for terminal links (or CogDataBindings) to CogToolBlock Inputs and Outputs. Serializing or cloning a terminal will result in a terminal with the same ID as the oringinal terminal. This is desireable so that links (a.k.a. DataBindings) that use the ID property in their paths maitiain their links when copied or serialized. This means that it is possilble to create multiple terminals with the same ID property. However, the ID field will always be unique amongst terminals within a CogToolBlockTerminalCollection.

Gets the expected value type of the terminal

The terminal value type controls the linking behavior. Terminals can only be linked if their value types are compatible. See line 1631 of CogToolNode.cs for a better understanding of what it means for types to be compatible... Roughly, if the destination type is "assignable" from the source type or the destination can be "converted" (using .NET) to the source type the types are compatible.

Gets/Sets whether a CogToolBlock containing this terminal in its Outputs collection will force a changed event with the SfValue state flag set every time the CogToolBlock is run (even if the value did not change). Use this property when linking to a CogDataAnyalysisTool to prevent the CogDataAnyalysisTool from giving a reject result due to the Data Analysis Channels not being updated.

Setting the ForceChangedEvent on terminals that are part of the Inputs terminal collection has no effect.

Returns the Parent or CogTrackingCollection that is currently tracking this Item.

Event raised when the name of a terminal is about to change. Gives a listener an oportuity to cancel the name change.

CogTrackedItemBase (above) should never have had Value and ValueType as part of its interface.

Name state flag

ID state flag

A collection which can be indexed by name, index, or a string ID. The indexing by ID is designed to be semi-permenent (where name and index may change)to facilitate DataBinding where a constant path that identifies an entry in the collection is valuable.

The type of objects that will be tracked in this collection Each item in the collection must have a unique name and ID.

StateFlag indicating that the name of an Item in the collection may have changed

StateFlag indicating that the ID of an Item in the collection may have changed

Returns an enumerator that can iterate through the collection's items.

An IEnumerator that can be used to iterate through the items.

Removes the item with the specified Name or ID from the collection.

The Name or ID of the item to remove.

Returns true if the collection contains an item with the specified Name or ID.

The Name or ID to locate in the collection.

Called when a new item in the collection needs to be tracked

Called when an item in the collection no longer needs to be tracked

Event handler called when any tracked item is about to change its name. Funnels all the individual events into an event for the entire collection.

Returns a collection containing all PropertyDescriptors found in the standard fasion, augmented with property descriptors name and ID of the tracked item that can be obtained using the string overload of the item indexer.

An array of type Attribute that is used as a filter. An array of type Attribute that represents the properties for this CogTrackingCollection instance that match the given set of attributes.

Raises the InsertingItem event.

Index at which the item will be inserted. Value of item being inserted.

Raises the RemovedItem event.

Index of item removed. Value of item removed.

Raises the ReplacingItem event.

Index of item being replaced. Value of item being replaced. Value of item replacing oldValue.

Raises the Clearing event.

Gets the with the specified Name or ID.

Read only because a setting a value at an index would cause the item to imeadiatly re-index itself.

Event raised when a tracked item is about to change its name.

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.

If the ChangedEventSuspended count is currently zero.

This method should be called internally whenever the object's state may have changed.

The set of state flags that correspond to the parts of the object that may have changed.

This event is raised when one or more parts of the object's state may have changed.

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.

Returns the complete set of state flags supported on this object. The flags may be indexed by name as in: if(changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }

Validates a .NET variable name

A variable name to validate Alllow escaped C# or VB.NET keywords true if is a valid .NET varaible name, otherwise false.

Validates a .NET variable name

A variable name to validate true if is a valid .NET varaible name, otherwise false.

Returns true if is a C# or VB.Net reserved keyword

Returns true if the value is C# reserved keyword

Returns true if the value is VB.Net reserved keyword

Takes a string that represents a CogTerminal name and does the best it can to create a valid .NET variable name.

Indicates if this script contians auto-generated adapter or helper classes

Returns the user editable part of the script

Returns the protected auto-generated part of the source.

Returns the language appropriatte auto-generated region header tag

The ScriptTempFileManager is used as a singleton instance to keep track of the temporarily created files during the execution of QuickBuild or custom application that involves scripting and debug mode On app exit this class takes care of deleting the temporarily files created during the execution.

Constants that specify the location of a referenced assembly.

The referenced assembly is supplied by the .NET Framework.

The referenced assembly is supplied by VisionPro.

The referenced assembly is located using a custom directory path that may contain environment variables.

This class holds a single immutable assembly reference (to be used when compiling a script).

Returns true if the given path specifies the directory containing the .NET Framework assemblies. The framework version is the same as the executing version of the CLR.

Returns true if the given path specifies the directory containing the Cognex VisionPro assemblies.

Returns a copy of the given path that contains no forward slashes, no leading or trailing spaces, and no trailing backslashes.

Returns true if the given (expanded) full path name represents a valid, existing, .NET assembly.

Get the VisionPro "assembly path" from the actual assembly location.

Get the VisionPro "assembly name" from the actual assembly location.

Gets the directory containing the .NET Framework assemblies. The framework version is the same as the executing version of the CLR.

Gets the directory containing the Cognex VisionPro assemblies.

The CogStatisticsSimple is intended to represent an immutable set of simple statistics that might typically be part of some result object. At construction time the user provides a count plus a minimum, maximum, sum, and sum-of-squares value. The object may then be queried for these values plus a handful of derived values like mean, variance, and standard deviation. This class derives from CogSerializableObjectBase, so it implements VisionPro style serialization.

Constructs a CogStatisticsSimple object with the supplied values.

Int32. The number of samples. Must be greater than or equal to one. double. The minimum sample value. Must be less than or equal to valueMax. double. The maximum sample value. Must be greater than or equal to valueMin. double. The sum of the sample values. double. The sum of the squares of the sample values. Must be greater than or equal to zero. If valueCount is less than one. If valueSumSq is less than zero. If valueMin is greater than valueMax.

Copy constructs a CogStatisticsSimple object. This is a deep copy.

CogStatisticsSimple. The object to be copied. If the input argument is null.

Serialization construct a CogStatisticsSimple object

SerializationInfo. The standard serialization info argument. StreamingContext. The standard streaming context argument.

The number of samples that were processed to produce this result.

The minimum sample value.

The maximum sample value.

The sum of all sample values.

The sum of the squares of all sample values.

The mean or average of all sample values.

The root mean square of all sample values.

The variance of all sample values.

The standard deviation of all sample values.

This class holds one feature position and a bool value indicates whether this point is valid.

This bit will be set in the EventArgs of a Changed event every time the value returned by X may have been changed.

This bit will be set in the EventArgs of a Changed event every time the value returned by Y may have been changed.

This bit will be set in the EventArgs of a Changed event every time the value returned by Valid may have been changed.

Construct a default CogFeaturePosition: X = 0.0, Y = 0.0, Valid = false.

Construct this CogFeaturePosition with the supplied components.

The x value of the image position for this feature. The y value of the image position for this feature. The valid flag for this feature.

Construct this object by making a deep copy of the supplied object.

The CogFeaturePosition object to be copied. If is null.

Serialization construct a CogFeaturePosition object.

The standard SerializationInfo argument. The standard StreamingContext argument.

Gets/sets the x value of feature position.

Fires when this property changes.

Gets/sets the y value of feature position.

Fires when this property changes.

Gets/sets the validation value.

Fires when this property changes.

This class holds the feature positions found from one image.

Constructs a default (empty) CogFeaturePositions.

Copy constructs a CogFeaturePositions object. This is a deep copy.

The CogFeaturePositions object to be copied. If is null.

Serialization construct a CogFeaturePositions object.

The standard SerializationInfo argument. The standard StreamingContext argument.

This class holds the feature positions found from multiple cameras at one pose. CogFeaturePositionsMCameras[cameraIndex] is a holding the feature positions for camera "cameraIndex" at one pose.

Constructs a default (empty) CogFeaturePositionsMCameras.

Copy constructs a CogFeaturePositionsMCameras object. This is a deep copy.

The CogFeaturePositionsMCameras object to be copied. If is null.

Serialization construct a CogFeaturePositionsMCameras object.

The standard SerializationInfo argument. The standard StreamingContext argument.

This class holds the feature positions found from multiple cameras at multiple poses. CogFeaturePositionsMCamerasNPoses[poseIndex][cameraIndex] is a holding the feature correspondence for camera "cameraIndex" at pose "poseIndex".

Constructs a default (empty) CogFeaturePositionsMCamerasNPoses.

Copy constructs a CogFeaturePositionsMCamerasNPoses object. This is a deep copy.

The CogFeaturePositionsMCamerasNPoses object to be copied. If is null.

Serialization construct a CogFeaturePositionsMCamerasNPoses object.

The standard SerializationInfo argument. The standard StreamingContext argument.

This class parses a .NET Assembly Qualified Name (AQN). Though it should handle any properly formatted AQN, it is designed specifically to handle the parseing of AQN which contains generic type information. This class was created for use by the VisionPro serialization mechanism to enable deserialization of generic types that is consistent with normal VisionPro deserialization (Serialized VisionPro objects often wish to bind to the latest version of an assembly available on deserialization).

Most of the information need to construct this parser was taken from here: http://msdn.microsoft.com/en-us/library/w3f99sx1.aspx and here: http://msdn.microsoft.com/en-us/library/yfsftwz6(VS.80).aspx here are some AQN examples: A generic type with one type argument "MyGenericType`1[MyType]" A generic type with two type arguments "MyGenericType`2[MyType,AnotherType]" A generic type with two assembly-qualified type arguments "MyGenericType`2[[MyType,MyAssembly],[AnotherType,AnotherAssembly]]" An assembly-qualified generic type with an assembly-qualified type argument "MyGenericType`1[[MyType,MyAssembly]],MyGenericTypeAssembly" A generic type whose type argument is a generic type with two type arguments "MyGenericType`1[AnotherGenericType`2[MyType,AnotherType]]"

Creates a new CogParseGenericAQN

The AQN to parse

Parses the given AQN into its pieces

the AQN to parse

Returns the Assembly name from an AQN

the AQN from which to retreive the Assembly Name the Assembly Name

Returns the Type Name part of an AQN

the AQN from which to retireve the type name the Type Name

The gereric type name without any generic type parameters that may have been present in the original AQN

The number of generic parameters in the parsed AQN

The individual AQNs of the contained generic type parameters

Arguments of the Changed event. For more information see the topic About Events in VisionPro.

Gets the state flags associated with the Changed event.

Constructs a new instance of the CogChangedEventArgs class.

The state flags associated with the Changed event.

Creates a string containing the state flags that correspond to the members that may have changed.

The object that raised this Changed event. A string containing the state flag names separated by the | symbol.

Given an object type and a set of state flags corresponding to the StateFlags argument of a Changed event, creates a string containing the state flags that correspond to the properties that may have changed.

The type of object that raised a Changed event. The StateFlags argument of a Changed event. A string containing the state flag names separated by the | symbol.

Initializes a new instance of the StateFlagsCollection class with state flags of a given type.

The type whose state flags are extracted.

Gets the flag value of the given state name.

The statename whose flag value is queried.

Gets the list of state names.

Gets the list of flag values.

A delegate for the Changed event.

Implements the behavior of the ICogChangedEvent interface for classes that cannot derive directly from CogChangedEventBase.

A class can implement ICogChangedEvent by creating a private instance of CogChangedEventImpl and delegating each function of ICogChangedEvent to the corresponding function of CogChangedEventImpl.

Implements the SuspendChangedEvent member of the ICogChangedEvent interface.

Implements the ResumeAndRaiseChangedEvent member of the ICogChangedEvent interface.

The object that implements the ICogChangedEvent interface.

This method should be called internally whenever the object's state may have changed.

The object that implements the ICogChangedEvent interface. The set of state flags that correspond to the parts of the object that may have changed.

This method should be called internally whenever the object's state may have changed. This overload is useful when firing an EventArgs class that is derived from CogChangedEventArgs.

The object that implements the ICogChangedEvent interface. The CogChangedEventArgs-derived instance that should be fired with the Changed event.

Implements the Changed member of the ICogChangedEvent interface.

Implements the ChangedEventSuspended member of the ICogChangedEvent interface.

Base class for a Component that implements the interface. Objects that derive from this class will raise the Changed event whenever part of the object's state has changed.

The next state flag value to be used by a derived class.

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.

If the ChangedEventSuspended count is currently zero.

This method should be called internally whenever the object's state may have changed.

The set of state flags that correspond to the parts of the object that may have changed.

This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class.

EventArgs to be fired with the change event.

This event is raised when one or more parts of the object's state may have changed.

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.

This class is intended to be used in cases where paired calls to ChangedEventSuspended and ResumeAndRaiseChangedEvent are needed. Class users will instantiate the class in a C# using statement. The constructor will automatically call ChangedEventSuspended; Dispose will call ResumeAndRaiseChangedEvent.

Constructs a new instance of the CogChangedEventFunnel class.

A CogChangedEventFunnel to copy.

Constructs a new instance of the CogChangedEventFunnel class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a deep copy of the tool collection.

A deep copy of the cloned tool collection.

Returns an enumerator that can iterate through the CogChangedEventFunnel's elements.

An IEnumerator that can be used to iterate through the CogChangedEventFunnel's ICogChangedEvent objects.

Adds an item to the CogChangedEventFunnel.

The ICogChangedEvent to add to the CogChangedEventFunnel.

Inserts an ICogChangedEvent into the CogChangedEventFunnel at the specified position.

The zero-based index at which value should be inserted. The ICogChangedEvent to insert into the CogChangedEventFunnel.

Removes the first occurrence of a specific ICogChangedEvent from the CogChangedEventFunnel.

The ICogChangedEvent to remove from the CogChangedEventFunnel.

Determines whether the CogChangedEventFunnel contains a specific ICogChangedEvent.

The ICogChangedEvent to locate in the CogChangedEventFunnel. True if the CogChangedEventFunnel contains value; otherwise, false.

Determines the index of a specific ICogChangedEvent in the CogChangedEventFunnel.

The ICogChangedEvent to locate in the CogChangedEventFunnel. The index of value if found in the CogChangedEventFunnel; otherwise, -1.

Gets or sets the ICogChangedEvent at the specified index. In C#, this property is the indexer for the CogChangedEventFunnel class.

The zero-based index of the ICogChangedEvent to get or set. The ICogChangedEvent at the specified index.

An interface that comprises the events that are common to most VisionPro dictionary classes.

Raised before the dictionary is cleared.

Raised after the dictionary is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

This class is passed to ICogDictionaryEvents InsertingItem and InsertedItem event handlers.

Key of item inserted.

Value of item inserted.

Constructs a new instance of the CogDictionaryInsertEventArgs class.

Key of insert item. Value of insert item.

Delegate for registering ICogDictionaryEvents InsertingItem and InsertedItem event handlers.

This class is passed to ICogDictionaryEvents RemovingItem and RemoveItem event handlers.

Constructs a new instance of the CogDictionaryRemoveEventArgs class.

Key of item removed. Value of item removed.

Delegate for registering ICogDictionaryEvents RemovingItem and InsertedItem event handlers.

This class is passed to ICogDictionaryEvents ReplacingItem and ReplacedItem event handlers.

Key of item replaced.

Value of replaced item.

Value of replacing item.

Constructs a new instance of the CogDictionaryReplaceEventArgs class.

Key of item replaced. Value of replaced item. Value of replacing item.

Delegate for regisering ICogDictionaryEvents ReplacingItem and ReplacedItem event handlers.

Base class for a generic non-ordered collection of key-and-value pairs that raises events whenever any change is made.

State flag for the Item (indexer) property.

State flag for the Count property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogSerializableDictionaryBase class.

A CogSerializableDictionaryBase to copy.

Constructs a new instance of the CogSerializableDictionaryBase class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a deep copy of the object. Must be overridden in derived classes.

A deep copy of the cloned instance.

Copies the contents of the dictionary to an array.

The array into which to copy. The starting index at which to copy.

Gets a Hashtable containg the elements.

Gets the IDictionary interface of this instance.

Raised before the dictionary is cleared.

Raised after the dictionary is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

Returns the number of items in the dictionary.

Gets a collection of all values in the dictionary.

Gets a collection of all keys in the dictionary.

Base class for a generic non-ordered collection of key-and-value pairs that raises events whenever any change is made.

This is largely a generic version of CogSerializableDictionaryBase which allows the user to specify the type of the key and the type of the associated value contained in the dictionary.

State flag for the Item (indexer) property.

State flag for the Count property.

Next state flag to be used in derived classes.

Constructs a new instance of the CogSerializableDictionaryBase class.

Constructs a copy of the supplied CogSerializableDictionaryBase. If the values are ref types that implement ICloneable, this will be a deep copy.

CogSerializableDictionaryBase to be copied.

CogSerializableDictionaryBase serialization constructor.

Standard SerializationInfo parameter. Standard StreamingContext parameter.

Runs when the entire object graph has been deserialized.

The object that initiated the callback.

Raises the Clearing event.

Raises the Cleared event.

Raises the Inserting event.

Raises the Inserted event.

Raises the Removing event.

Raises the Removed event.

Raises the Replacing event.

Raises the Replaced event.

Add an entry to this dictionary with the supplied key and value.

The key for this new entry. The value for this new entry.

Add the supplied entry to this dictionary.

The entry to add to this dictionary.

Remove the specified entry from this dictionary. Returns true if the specified entry is successfully removed.

The key specifying the entry to be removed.

Remove the specified entry from this dictionary. Returns true if the specified entry is successfully removed.

The item to be removed.

Returns true if the specified key is found in this dictionary, otherwise returns false.

The key of interest.

Returns true if the specified value is found in this dictionary, otherwise returns false.

The value of interest.

Returns true if the key of the supplied item is found in this dictionary, otherwise returns false.

Search for a key matching the key in this key value pair.

Remove all entries from this dictionary.

If this dictionary contains the specified key, output the associated value. Return true if the key was found, otherwise return false.

Search for this key. The found value.

Get the specialized enumerator for this dictionary.

Get an IEnumerator for this dictionary.

Copy the key value pairs in this dictionary to the supplied array of key value pairs, starting to write at the supplied array index.

The destination array. The destination array index at which writing should begin.

Copy the key value pairs in this dictionary to the supplied array, starting to write at the supplied array index.

The destination array. The destination array index at which writing should begin.

Raised before the dictionary is cleared.

Raised after the dictionary is cleared.

Raised before an item is inserted.

Raised after an item is inserted.

Raised before an item is removed.

Raised after an item is removed.

Raised before an item is replaced.

Raised after an item is replaced.

Gets the internal Dictionary containing the set of key value pairs.

Gets the generic IDictionary interface of this object.

Gets the number of key value pairs in this dictionary.

Gets a collection of the values in this dictionary.

Gets a collection of the keys in this dictionary.

The indexer for this dictionary.

The key of the desired dictionary entry.

Get whether or not this dictionary is read only.

A container that stores a non-ordered collection of key-and-value pairs, and raises events whenever any change is made.

Constructs a new instance of the CogDictionary class.

A CogDictionary to copy.

Constructs a new instance of the CogDictionary class.

The object that holds the serialized object data. The contextual information about the SerializationInfo.

Creates a deep copy of the dictionary.

A deep copy of the cloned dictionary.

CogToolOwnsTerminalsAttribute is applied to Classes which implement ICogTool. This Attribute indicates that the Tool itself dictactes which input and output terminals are exposed. Used by CogToolNode to prevent automatic addition of inapporpriate terminals and databindings to CogResultsAnalysisTools, CogToolGroups, CogToolBlocks

Thrown by Comm Card Precision I/O interfaces to indicate attempted use of and invalid I/O bank.

Thrown by Comm Card Precision I/O interfaces to indicate attempted use of and invalid I/O line.

Thrown by Comm Card interfaces to indicate attempted use of hardware that is already in use by another process.

Thrown by Comm Card interfaces when the host system detects an incompatible version of firmware running on the card.

Thrown by Comm Card Precision I/O to indicate the maximum number of scheduled events has been reached.

Thrown by Comm Card Precision I/O to indicate an event could not be scheduled because it would have occurred in the past.

Thrown by Comm Card interfaces to indicate the connection to the Comm Card from the host PC has been lost or corrupted.

Known I/O banks

None

General Purpose Input Bank 0

General Purpose Output Bank 0

Special DS1000 Output Bank (only supported on Communication Card 24A, Cognex Vision Controller).

The types of precision I/O banks

Types of I/O line edge transitions.

None

The rising edge

The falling edge.

Either a rising edge or a falling edge.

Actions that may be applied to an output line.

Set the output line low

Set the output line high

Set the output line high if it is currently low. Set the output line low if it is currently high.

Delay types that may be applied to an output line action.

The output action is not delayed.

Delay the output action by a user specified amount of encoder ticks. Current firmware does not support encoder based delays.

Delay the output action by a user specified amount of time.

Not Supported

Scheduling options for registered I/O events.

The I/O event is scheduled to occur as soon as possible.

The I/O event is scheduled to occur at user specified absolute encoder position.

The I/O event is scheduled to occur at user specified encoder position relative to the current encoder position. Note this method may be less accurate than specifying an absolute encoder position because host OS latencies are involved when calculating the current encoder position.

The I/O event is scheduled to occur at a user specified absolute time stamp.

The I/O event is scheduled to occur at a user specified time stamp relative to the current time stamp counter position. Note this method may be less accurate than specifying an absolute time stamp position because host OS latencies are involved when calculating the current time stamp.

Not Supported

Base class for the CogPrioEvent class.

Initialize the board info class with values read from the comm card.

Returns the type (input, output, etc...) of a given I/O bank

Returns the number of I/O lines the hardware supports in the given bank.

Returns true if the hardware supports the given line, otherwise returns false.

Returns an array of the supported I/O banks of the current hardware.

Get the frequency of the clock.

Scheduling options for I/O events.

Schedules an I/O event based on the encoder position. Current firmware does not support encoder based scheduling.

Schedules an I/O event based on a time stamp.

Network Data Model (NDM) signals that can be used to cause precision i/o events directly without host operating system intervention.

Repesents the absence of a named signal

Use the TriggerAcquisition signal to cause a precision I/O event to occur when the Comm Card receives a "Trigger Camera" signal from the remote device. Note that a precision I/O event with a TriggerAcquisition as a cause will still occur even if the NDM's "Trigger Camera" signal results in a TriggerAcquisitionNotReadyError event or TriggerAcquisitionDisabledError event from the NDM. This means it is important to ensure that the remote device waits for the "Trigger Ready Camera" signal before asserting the "Trigger Camera" signal.

Use the TriggerSoftEvent signal to cause a precision I/O event to occur when the Comm Card recieves a soft event trigger request from the PLC.

Represents the state of a precision I/O interface at a particular moment in time. Note: Once a state object is read/created its contained values do not change. To get the current values you must call ReadState() again.

Construt a CogPrioState

Returns the values all lines in an i/o bank as an integer value. Note: Once a state object is read/created its contained values do not change. To get the current values you must call ReadState() again.

The value of each individual output line is calculated as: bool output0High = precisionIOState.Outputs & 0x01; bool output1High = precisionIOState.Outputs & 0x02; bool output3High = precisionIOState.Outputs & 0x04; and so on... Thrown if the hardware does not support the given i/o bank.

Returns the line value of the user supplied line at the moment the state was read. Note: Once a state object is read/created its contained values do not change. To get the current values you must call ReadState() again.

Thrown if the hardware does not support the given i/o bank. Thrown if the hardware does not support the given i/o line.

Returns the time difference between this state and some other state states in milliseconds (otherState - thisState).

The time stamp counter when the state was read. Note: Once a state object is read/created its contained values do not change. To get the current values you must call ReadState() again.

The encoder count when the state was read. Note: Once a state object is read/created its contained values do not change. To get the current values you must call ReadState() again. Note that current hardware platforms use only 32-bits of encoder data. This means that depending on the hardware, the encoder may rollover (go back to 0) when the encoder count reaches 0xFFFFFFFF (or 4294967295).

Get's value of a line that was caputured with this state object. Note: Once a state object is read/created its contained values do not change. To get the current values you must call ReadState() again.

Event handler for precision I/O events.

Event args for precision I/O events.

The name of the i/o event that caused this host notification event.

The I/O state at the moment the event occured.

Event handler for precision I/O events.

Event args for precision I/O events.

The event number of the registered precision I/O event that occurred.

If this was a user scheduled event, the tag will be filled in with the number provided at the time the event was scheduled.

The I/O state at the moment the event occured.

Cognex Internal Use Only

Indicates whether the configuration of this object is valid/invalid for the current hardware. The valid/invalid state is automatically updated when this object is part of a CogPrio.Events collection. Objects marked Invalid should be reconfigured to be valid. Otherwise the CogPrio event system will not function. Use the validationErrorMsg to understand how to reconfigure the object to be valid.

Returns a collection of validation error messages that describe issues with the CogPrio.Events configuration. The valid/invalid state is automatically updated when this object is part of a CogPrio.Events collection. Objects marked Invalid should be reconfigured to be valid. Otherwise the CogPrio event system will not function. Use the validation error msg to understand how to reconfigure the object to be valid.

Marker base class for precision I/O event causes.

Marker base class for precision I/O event responses.

A collection of precision I/O event causes.

A collection of precision I/O event responses.

Represents a network data model (NDM) signal transition which causes a precision I/O event. Construct and add instances of this class to a precision I/O event's cause collection to cause the precision I/O event to occur when a particular signal in the factory floor protocol assembly layout transitions. These events will occur directly on the Comm Card without host operating system intervention.

Construct a new Ffp i/o event cause.

Construct a new Network Data Model (NDM) i/o event cause.

Configure a CogPrioEventCauseNdm to to cause precision i/o events to occur directly without host operating system intervention. Ndm signal that will cause the precision i/o event. Index of the signal that causes the precision i/o event (eg. specifies which camera trigger (0-3) causes the event).

Construct a new Network Data Model (NDM) i/o event cause.

Serialization ctor

Gets/sets the signal which causes the precision IO event

Gets/sets the index of the signal that causes the precision i/o event (eg. specifies which camera trigger (0-3) causes the event).

Gets/sets whether the event occurs at the rising or falling transition of the NDM value.

Class which represents a line transition which causes a precision I/O event. Construct and add instances of this class to a precision I/O event's causes collection to cause the precision I/O event to occur when a particular I/O line transitions.

Construct a new i/o event line cause

The bank of the line which causes the event The index of the line number which causes the event The line transition which cause the event Thrown lineBank is set to an output bank... output lines cannot cause i/o events in this release. Thrown lineNumber is set to an invalid line number.

Serialization ctor

The bank of the I/O line which causes the event.

Thrown if lineBank is set to an output bank... output lines cannot cause i/o events in this release.

The line number of the I/O line which causes the event.

The line transition which causes the the event.

Class which represents an automatic I/O line transition in response to a precision I/O event. Construct and add instances of this class to a precision I/O event's response collection to cause an automatic I/O line transition in response to a precision I/O event.

Construct a new automatic output line response to an i/o event

The bank of the output line which responds to the event The index of the output line which responds to the event The value that is set to the output line when the event occurs How long to pulse the output line when the event occurs Controls if the response occurs immeadiatly after the event or after some amount of delay Controls how long after the event the response occurs Thrown if outputLineBank is set to an invalid bank. Thrown if outputLineNumber is set to an invalid line number. Thrown if delay type is set to Encoder or EventCount. Thrown if pulse duration is less than 0.0 or greater than the maximum valid pulse width.

Serialization ctor

Gets or sets the bank of the output line on which the event response occurs.

Thrown OutputLineBank is set to an input bank Thrown if outputLineNumber is set to an invalid line number.

Gets or sets the number of the output line on which the event response occurs.

Thrown if outputLineNumber is set to an invalid line number.

Gets or sets the value to set the output line to in response to the event.

Gets or sets the length of a the pulse in milliseconds.

Set to 0.0 to indicate that the line is not pulsed. Thrown if pulse duration is less than 0.0 or greater than the maximum valid pulse width.

Gets or sets the type of delay that occurs after the event and before the event response.

Thrown if delay type is set to Encoder or EventCount.

Gets or sets the amount of delay that occurs after the event and before the event response.

The units are in milliseconds or encoder ticks depending on the .

Used to persist an application's runtime settings.

Summary description for CogToolTerminals.

Returns True if both and have the exact same Input and Output terminals.

Returns True if both and have the exact same Input terminals.

Returns True if both and have the exact same Output terminals.

Creates a new instance of the CogIndexedPropertyInfo class.

A PropertyInfo to wrap. Index arguments to use if the supplied ProertyInfo is an indexed property.

Determines whether the specified CogIndexedPropertyInfo is equal to the current CogIndexedPropertyInfo.

The CogIndexedPropertyInfo to compare with the current CogIndexedPropertyInfo. True if the specified CogIndexedPropertyInfo is equal to the current CogIndexedPropertyInfo; otherwise, false.

Serves as a hash function for this type, suitable for use in hashing algorithms and data structures like a hash table.

A hash code for the current CogIndexedPropertyInfo.

Creates a new instance of the CogMethodInfo class.

A MethodInfo to wrap. The arguments to use, if any, when calling the wrapped MethodInfo.

Creates a new instance of the CogMethodInfo class.

A MethodInfo to wrap. The arguments to use, if any, when calling the wrapped MethodInfo. If CogMethodInfo wraps a setter method, the type of the last method argument; otherwise null.

Determines whether the specified CogMethodInfo is equal to the current CogMethodInfo.

The CogMethodInfo to compare with the current CogMethodInfo. True if the specified CogMethodInfo is equal to the current CogMethodInfo; otherwise, false.

Serves as a hash function for this type, suitable for use in hashing algorithms and data structures like a hash table.

A hash code for the current CogMethodInfo.

Creates a new instance of the CogTypeInfo class.

A Type to wrap. Implements call to SetValue.

This enum is used by members of CogToolTerminals to switch between different behaviors regarding how paths which contain invalid casts are handled. Most times (like when we are parsing paths or evaluating links) we wish to follow the path as though the cast had succedded, even if it didn't. Other times. like when we are trying to get the value of the terminal we want to ignore the actual cast and pretend as though the cast was to the type of which the object actually is. I think this goes back to the original databinding philosophy that started with Jay. In a nutshell I think this philosophy says "we will try anything we can to make a binding to an existing path succeed."

Utility function to extract a ToolBlockTerminal's ID property from a databinding

Utility function to extract a ToolBlockTerminal's ID property from a Terminal path

Class cooresponding to an individual ToolBlock terminal, usually a member of a ToolBlock Inputs or Outputs collection.

ToolBlock terminals are different from "regular" tool terminals. ToolBlock terminals are storage objects unto themselves. Regular tool terminals represent a path to an existing tool's member or property.

Description state flag

Creates a new CogToolBlockTerminal with the supplied name and value.

The Name of the terminal The Value The ValueType of the new Terminal is set to the type returned by value.GetType() Thrown when name or value is null, or if name is not a valid .Net variable name

Creates a new CogToolBlockTerminal with the supplied name and valueType.

Sets the Name of the new terminal Sets the ValueType of the new terminal Creates a terminal whose Value property is a null reference. Thrown when name or valueType is null, or if name is not a valid .Net variable name

Creates a new CogToolBlockTerminal with the supplied name, value, and valueType.

Sets the Name of the new terminal Sets the Value of the new terminal Sets the ValueType of the new terminal Only usefull if ValueType is more general than Value.GetType() Thrown when name or valueType is null, if name is not a valid .Net variable name, or if valueType is not assignable from value.

Creates a new CogToolBlockTerminal with the supplied name and valueType.

Sets the Name of the new terminal Sets the ValueType of the new terminal Dictates if value should be initailized with a default constructed instance of valueType If is true and has a default constructor the terminal will be initialzed to the default value. Thrown when name or valueType is null, or if name is not a valid .Net variable name

Standard Serialization Constructor

Throws an exception if is not a valid C# or VB.Net varialble name

the variable name to check

A short description of this terminal

Wraps property converters for properties in order to display bound properties using a special notation.

Constructs a new instance of the CogPropertyConverter class which wraps the supplied TypeConverter.

A standard TypeConverter to wrap.

Gets the full path to the selected property in a property grid

The context in which the property is selected. The dot-separated path to the property from the top-level selected item (normally a tool).

This class provides type conversion facilities for using VisionPro components at design time.

Constructs a new instance of the CogComponentConverter class.

The type of object to convert.

Checks whether the component type has a GetInstanceDescriptor member.

True if it has one, false otherwise.

This class takes the place of a standard PropertyDescriptor when obtained via the GetProperties method of a ICustomTypeDescriptor implementation. It behaves like a standard PropertyDescriptor except that its ValueChanged implementation works with our Changed event in order to support data binding, and it provides additional improvements to design-mode behavior over the standard PropertyDescriptor.

A standard PropertyDescriptor on which this one is based

A hash table keyed by component that contains the number of sinks for each component

The state flag associated with this property descriptor.

The description string for the property.

True when the description has been gotten.

Table of XML documentation files keyed by assembly

Constructs a new CogPropertyDescriptor given a standard PropertyDescriptor.

A standard property descriptor to wrap.

Constructs a new CogPropertyDescriptor given a PropertyInfo describing the property and a Type describing the type of the component containing the property.

PropertyInfo wrapped by this property descriptor. Type of component containing this descriptor's property.

Gets a PropertyDescriptorCollection containing property descriptors that will respond to Changed events.

The component for which to get property descriptors. An array of type System.Attribute to use as a filter.

This class takes the place of a CogPropertyDescriptor when a descriptor returned from the GetProperties method is itself a method. It behaves like a CogPropertyDescriptor except that it operates on methods rather than properties.

Constructs a new instance of the CogMethodDescriptor class.

Name of this instance. Method used to get the descriptor's value. Arguments passed to getterMethodInfo when getting the descriptor's value. Method used to set the descriptor's value. Arguments passed to setterMethodInfo when setting the descriptor's value. Type of component containing the method(s) to which this descriptor applies.

Get arguments passed to GetterMethodInfo when getting the descriptor's value.

Arguments passed to getterMethodInfo.

Get arguments passed to SetterMethodInfo when setting the descriptor's value.

Arguments passed to SetterMethodInfo.

Get method used to get the descriptor's value.

Get method used to set the descriptor's value.

This class takes the place of a CogPropertyDescriptor when a descriptor returned from the GetProperties method is an indexed property. It behaves like a CogPropertyDescriptor except that it includes the property's index arguments.

Constructs a new instance of the CogIndexedPropertyDescriptor class.

PropertyInfo wrapped by this property descriptor. Type of component containing this descriptor's property. Index arguments used when accessing property.

Gets the PropertyInfo having the appropriate name and arguments.

Type from which to obtain the PropertyInfo. Name of the property whose PropertyInfo is being retrieved. Arguments of the property whose PropertyInfo is being retrieved.

Gets PropertyInfo wrapped by this property descriptor.

Gets index arguments used when accessing property.

This class takes the place of a CogPropertyDescriptor when a descriptor encapsulating a type cast is needed.

Constructs a new instance of the CogTypeDescriptor class.

Type wrapped by this CogTypeDescriptor. SetValue implementation delegated to this PropertyDescriptor.

This class provides an editor for input properties on the property page

This class provides an editor for input image properties on the property page

This class implements a boolean "in use" flag that can be easily set to true for the duration of a C# "using" statement.

Start using this flag object. This method can be placed inside a C# "using" statement.

An IDisposable that can be used inside a C# "using" statement. Calling Dispose() on this returned value is equivalent to calling StopUsing() on the flag object.

Stop using this flag object.

Gets a value indicating whether this flag is currently in use.

True if this flag is in use. Otherwise, false. This flag is "in use" if has been called more times than .

This nested class provides an IDisposable that can be used inside a using statement. When disposed, it calls the StopUsing() method of the CogInUseFlag that created it.

The exception that is thrown when security is not enabled for the vision tool being used. See the topic titled 'Resolving Security-Related Error Messages' in the online help for more information.

The exception that is thrown when the image has no pixels.

The exception that is thrown when the memory for an image cannot be allocated.

The exception that is thrown when an image of the specified size cannot be allocated.

The exception that is thrown when the image is clipped.

The exception that is thrown when the specified pixel coordinate does not exist in this image.

The exception that is thrown when an operation does not support the specified image's format.

The exception that is thrown when no coordinate space tree was specified.

The exception that is thrown when one of the following is true: (1) The selected space of the input image is not a valid space of the input image's coordinate space tree, (2) The input image's selected space is nonqualified and more than one instance of it exists in the input image's space tree, or (3) The input image's selected space is not a legal space name.

The exception that is thrown when a nonlinear transform is used in an operation that requires only linear transforms.

The exception that is thrown when the transform is singular at the given point.

The exception that is thrown when a transform is singular.

The exception that is thrown when the Count of a Cognex.VisionPro.CogTransform2DComposed is zero and you attempt to call either the PopFromRight or PopFromLeft methods of that object.

The exception that is thrown when too few points were provided to compute a best fit linear transform.

The exception that is thrown when the specified timeout period has elapsed.

The exception that is thrown when an operation has been canceled.

The exception that is thrown when an internal error occurs.

The exception that is thrown when VisionPro does not support this hardware.

The exception that is thrown when there is an error opening a file.

The exception that is thrown when there is an error reading a file.

The exception that is thrown when there is an error writing a file.

The exception that is thrown when you try to read from or write to a file, but no file is open.

The exception that is thrown when the file format is not appropriate for the current use.

The exception that is thrown when the current file mode does not permit the specified operation. For example, you may have opened a file in read mode, but tried to write to it.

The exception that is thrown when the specified points do not describe a rectangle.

The exception that is thrown when the specified region must be an affine rectangle, but is not.

The exception that is thrown when the composite shape has no children.

The exception that is thrown when the start point and endpoint coordinates must differ.

The exception that is thrown when the polygon does not have enough vertices for the operation you requested.

The exception that is thrown when the shape cannot be enclosed by a rectangle.

The exception that is thrown when the shape is degenerate.

The exception that is thrown when the polygon is complex.

The exception that is thrown when the shape cannot be added as a child because it already has a parent.

The exception that is thrown when the specified shape type cannot be used because its internal representation cannot be converted.

The exception that is thrown when the type of the contour segment is not appropriate for the operation you requested.

The exception that is thrown when the contour vertex connection flags are incompatible. (See ).

The exception that is thrown when the pen with the specified key is in use.

The exception that is thrown when the starting segment is positioned after the ending segment.

The exception that is thrown when the contour vertex connection flags are incompatible. (See ).

The exception that is thrown when the contour contains no segments.

The exception that is thrown when this shape is a and is already referenced by an existing shape model.

The exception that is thrown when points on the elliptical arc segment are colinear.

The exception that is thrown when the operator does not have an input image.

The exception that is thrown when the operator is not trained.

The exception that is thrown when the operator cannot use the supplied region because it is invalid.

The exception that is thrown when the operator does not have a train image.

The exception that is thrown when no run parameters are specified for the operator.

The exception that is thrown when one of the following is true: (1) The selected space of the shape is not a valid space in the input image's coordinate space tree, (2) The selected space of the shape is nonqualified and more than one instance of the name is present in the input image's coordinate space tree, or (3) The selected space of the shape is not a legal space name.

The exception that is thrown when an operator object was not found for this tool.

The exception that is thrown when the result is not available.

The exception that is thrown when the selected space name of the image and all shapes must be equivalent, but are not.

The exception that is thrown when the RLE buffer is not initialized.

The exception that is thrown when a cannot combine two images. Typically, this error means that the subimage exceeds the primary image's bounds.

The exception that is thrown when the subimage size is greater than the RLE buffer. The subimage must fit entirely in the RLE buffer.

The exception that is thrown when the subimage's x- or y-position is less than the RLE buffer's (x, y) position. The subimage must fit entirely in the RLE buffer.

The exception that is thrown when the subimage extends beyond the size of the RLE buffer.

The exception that is thrown when the I/O line in use is not enabled. It must first be enabled before you can change its value.

The exception that is thrown when this I/O line cannot be enabled. It may be possible to enable it if other lines are first disabled.

The exception that is thrown when the mathematical operation is not supported with the specified coordinate transformations.

The exception that is thrown when the iterator is not positioned at a valid item.

The exception that is thrown when the specified iterator position is out of range or not valid.

The exception that is thrown when the iterator is at the end of the collection.

The exception that is thrown when the specified index is not valid for the collection. The index value should be greater than zero and less than the collection item count.

The exception that is thrown when the specified key is not a valid key value. The key is a string that uniquely identifies an item in the collection.

The exception that is thrown when the specified key string was not found in the collection. Keys are case-sensitive.

The exception that is thrown when the item already exists in the collection.

The exception that is thrown when the key already exists in the collection. Key strings must be unique. Keys are case-sensitive.

The exception that is thrown when a collection item cannot be null or empty.

Assigns the newly created thread's UI culture to that of the current thread. This enforces all VisionPro .NET threads to have the same UI culture of the main thread.

a delegate that allows an object to be passed to the thread when the thread is started newly created thread

Assigns the newly created thread's UI culture to that of the current thread. This enforces all VisionPro .NET threads to have the same UI culture of the main thread.

a delegate that allows an object to be passed to the thread when the thread is started the maximum stack size for the thread newly created thread

Assigns the newly created thread's UI culture to that of the current thread. This enforces all VisionPro .NET threads to have the same UI culture of the main thread.

a delegate that allows an object to be passed to the thread when the thread is started newly created thread

Assigns the newly created thread's UI culture to that of the current thread. This enforces all VisionPro .NET threads to have the same UI culture of the main thread.

a delegate that allows an object to be passed to the thread when the thread is started the maximum stack size for the thread newly created thread

The CogColor4F struct is a lightweight, immutable representation of an ARGB color with float values

Constructs CogColor4F instance with the given ARGB float values

The value of the Aplha component The value of the Red component The value of the Green component The value of the Blue component

Constructs CogColor4F instance with the given RGB byte values

The value of the Red component The value of the Green component The value of the Blue component

Constructs CogColor4F instance with the given ARGB byte values

The value of the Aplha component The value of the Red component The value of the Green component The value of the Blue component

Constructs CogColor4F instance with the given ARGB byte values

The OLE color (CogColorConstant) The value of the opacity

In a coordinate space tree each child of a given parent space must have a unique name. This enumeration specifies what action will be taken when the user attempts to add a duplicate child space name to an existing parent in the tree.

In a or each child of a given parent space must have a unique name. This enumeration specifies what action to take if you try to add a coordinate space to a parent space that already has an immediate child with the same name as the one you are trying to add. The options are to return an error, replace the named item, or do nothing.

Attempts to add a duplicate child space will fail. An error will be returned.

Attempts to add a duplicate child space will fail, and an error will be returned.

Attempts to add a duplicate child space will, instead, replace the transform of the existing child with the same name. Attempts to add a duplicate child tree will replace the entire subtree of the existing child, as well as its transform.

Attempts to add a duplicate child space will be ignored. No error will be returned.

This enumeration controls the formatting of coordinate space names that are returned from a coordinate space tree ( or ).

This enumeration controls the formatting of coordinate space names that are returned from a coordinate space tree ( or ). Express space names as a single, nonqualified name.

Returned space names will be expressed as a single, non-qualified name.

Returned space names will be expressed as a full pathname through the coordinate space tree.

Express space names as a full pathname through the coordinate space tree.

Returned space names will be expressed as a partial pathname through the coordinate space tree, starting at the space named by the first argument of the method that you called.

Express space names as a partial pathname through the coordinate space tree object, starting at the space specified by the first method argument.

This class provides data for the SpaceAdded event of a or .

Constructor for these EventArgs. You typically will not need to use this method.

n/a

The fully-qualified pathname of the added coordinate space.

Represents the method that will handle the SpaceAdded event of a or . The method must have the same parameters as this delegate.

The source of the event. An instance of CogSpaceAddedEventArgs containing the data for this event.

This class provides data for the TreeAdded event of a or .

Constructor for these EventArgs. You typically will not need to use this method.

n/a

The fully-qualified pathname of the added tree's root space.

Represents the method that will handle the TreeAdded event of a or . The method must have the same parameters as this delegate.

The source of the event. An instance of CogTreeAddedEventArgs containing the data for this event.

This class provides data for the NameChanged event of a or .

Constructor for these EventArgs. You typically will not need to use this method.

n/a n/a

The old, fully-qualified pathname of the coordinate space.

The new, fully-qualified pathname of the coordinate space.

Represents the method that will handle the NameChanged event of a or . The method must have the same parameters as this delegate.

The source of the event. An instance of CogNameChangedEventArgs containing the data for this event.

This class provides data for the TransformChanged event of a or .

Constructor for these EventArgs. You typically will not need to use this method.

n/a

The fully-qualified pathname of the child space for which the transform has changed. The new transform describes the mapping between this space and its parent space.

Represents the method that will handle the TransformChanged event or . The method must have the same parameters as this delegate.

The source of the event. An instance of CogTransformChangedEventArgs containing the data for this event.

This class provides data for the SubtreeDeleted event of a or .

Constructor for these EventArgs. You typically will not need to use this method.

n/a

The fully-qualified pathname of the deleted subtree's root space. This space no longer exists in the coordinate space tree.

Represents the method that will handle the SubtreeDeleted event of or . The method must have the same parameters as this delegate.

The source of the event. An instance of CogSubtreeDeletedEventArgs containing the data for this event.

This class provides data for the SubtreeMoved event of a or .

Constructor for these EventArgs. You typically will not need to use this method.

n/a n/a

The old, fully-qualified pathname of the subtree's root space. This space no longer exists in the coordinate space tree.

The new, fully-qualified pathname of the subtree's root space.

Represents the method that will handle the SubtreeMoved event of a or . The method must have the same parameters as this delegate.

The source of the event. An instance of CogSubtreeMovedEventArgs containing the data for this event.

The exception that is thrown when you attempt to add a duplicate nonqualified coordinate space name to a single node in a or . All nonqualified space names that share the same parent node must be unique. For more information, see the topic titled 'Coordinate Space Names' in the online User's Guide.

The exception that is thrown when a fixture tool attempts to add a space to a coordinate space tree that already has a space by that name. This exception is only generated by or .

The exception that is thrown when the syntax of the supplied coordinate space name is invalid. For more information, see the topic titled 'Coordinate Space Names' in the online User's Guide.

The exception that is thrown when the specified coordinate space name was not found in the or .

The exception that is thrown when a nonqualified coordinate space name is expected to be unique within a or , but is not unique.

This class holds one pair of feature correspondence: image position and the corresponding physical position.

This bit will be set in the EventArgs of a Changed event every time the value returned by ImageX may have been changed.

This bit will be set in the EventArgs of a Changed event every time the value returned by ImageY may have been changed.

This bit will be set in the EventArgs of a Changed event every time the value returned by PhysicalX may have been changed.

This bit will be set in the EventArgs of a Changed event every time the value returned by PhysicalY may have been changed.

Construct a default CogFeatureCrsp: ImageX = 0.0, ImageY = 0.0, PhysicalX = 0.0, PhysicalY = 0.0.

Construct this CogFeatureCrsp with the supplied components.

The x value of the image position for this feature. The y value of the image position for this feature. The x value of the physical position for this feature. The y value of the physical position for this feature.

Construct this object by making a deep copy of the supplied object.

The CogFeatureCrsp object to be copied. If is null.

Serialization construct a CogFeatureCrsp object.

The standard SerializationInfo argument. The standard StreamingContext argument.

Gets/sets the x value of image position.

Fires when this property changes.

Gets/sets the y value of image position.

Fires when this property changes.

Gets/sets the x value of physical position.

Fires when this property changes.

Gets/sets the y value of physical position.

Fires when this property changes.

This class holds the feature correspondences found from one image.

Constructs a default (empty) CogFeatureCrsps.

Copy constructs a CogFeatureCrsps object. This is a deep copy.

The CogFeatureCrsps object to be copied. If is null.

Get the ImageX, ImageY pairs in this collection as a row-major two dimensional array of double.

If Count is less than one.

Get the PhysicalX, PhysicalY pairs in this collection as a row-major two dimensional array of double.

If Count is less than one.

Serialization construct a CogFeatureCrsps object.

The standard SerializationInfo argument. The standard StreamingContext argument.

This class holds the feature correspondences found from multiple cameras at one pose. CogFeatureCrspsMCameras[cameraIndex] is a holding the feature correspondence for camera "cameraIndex" at one pose.

Constructs a default (empty) CogFeatureCrspsMCameras.

Copy constructs a CogFeatureCrspsMCameras object. This is a deep copy.

The CogFeatureCrspsMCameras object to be copied. If is null.

Serialization construct a CogFeatureCrspsMCameras object.

The standard SerializationInfo argument. The standard StreamingContext argument.

This class holds the feature correspondences found from multiple cameras at multiple poses. CogFeatureCrspsMCamerasNPoses[poseIndex][cameraIndex] is a holding the feature correspondence for camera "cameraIndex" at pose "poseIndex".

Constructs a default (empty) CogFeatureCrspsMCamerasNPoses.

Copy constructs a CogFeatureCrspsMCamerasNPoses object. This is a deep copy.

The CogFeatureCrspsMCamerasNPoses object to be copied. If is null.

Serialization construct a CogFeatureCrspsMCamerasNPoses object.

The standard SerializationInfo argument. The standard StreamingContext argument.