CogUserTool Class

Cognex VisionPro

A base class for tools that have a collection of other tools.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    System.ComponentModel Component
      Cognex.VisionPro.Implementation CogComponentBase
        Cognex.VisionPro.Implementation CogSerializableComponentBase
          Cognex.VisionPro.Implementation CogSerializableChangedEventComponentBase
            Cognex.VisionPro.Implementation CogToolBase
              Cognex.VisionPro.Implementation.Internal CogUserTool
                Cognex.VisionPro.ToolGroup CogToolGroup

Namespace: Cognex.VisionPro.Implementation.Internal
Assembly: Cognex.VisionPro.ToolGroup (in Cognex.VisionPro.ToolGroup.dll) Version: 65.1.0.0 (65.1.0.0)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogUserTool : CogToolBase, 
	ISupportInitialize, IDeserializationCallback

[SerializableAttribute]
public class CogUserTool : CogToolBase, 
	ISupportInitialize, IDeserializationCallback

<SerializableAttribute>
Public Class CogUserTool 
	Inherits CogToolBase 
	Implements ISupportInitialize, IDeserializationCallback

<SerializableAttribute>
Public Class CogUserTool 
	Inherits CogToolBase 
	Implements ISupportInitialize, IDeserializationCallback

[SerializableAttribute]
public ref class CogUserTool : public CogToolBase, 
	ISupportInitialize, IDeserializationCallback

[SerializableAttribute]
public ref class CogUserTool : public CogToolBase, 
	ISupportInitialize, IDeserializationCallback

The CogUserTool type exposes the following members.

Constructors

	Name	Description
	CogUserTool	Constructs a new instance of the CogUserTool class.
	CogUserTool(CogUserTool)	Constructs a new instance of the CogUserTool class.
	CogUserTool(SerializationInfo, StreamingContext)	Constructs a new instance of the CogUserTool class.

Top

Methods

	Name	Description
	AddCompositeLastRunRecord	Adds all of the contained tools' last run records to the supplied record.
	AddGraphicToRunRecord	Should only be called from tool group script. Adds a graphic to a specified run record.
	AddSharedGraphics	Shares all graphics between image records with the same space tree in the passed ICogRecord
	BeginInit	Signals the object that initialization is starting.
	CheckRunConditions	Check for run conditions including data binding. (Inherited from CogToolBase.)
	CheckRunConditionsNoThrow	Check for run conditions including data binding, returning an exception for the first problem encountered. (Inherited from CogToolBase.)
	Clone	Creates a deep copy of the user tool. (Overrides CogToolBase Clone .)
	CreateCurrentRecord	Creates a new set of records that represents the tool's current state. (Inherited from CogToolBase.)
	CreateLastRunRecord	Creates a new set of records that represents the tool's last-run state. (Inherited from CogToolBase.)
	CreateNewScript	Cognex internal use only.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	DefineScriptTerminal(Object, String, Boolean)	Called from a script's initialize() funciton to define a tool group terminal associated with the script.
	DefineScriptTerminal(String, Object, String, Boolean)	Called from a script's initialize() funciton to define a tool group terminal associated with the script.
	Dispose	Releases all resources used by the Component. (Inherited from Component.)
	Dispose(Boolean)	Releases the resources used by the CogUserTool instance. (Overrides Component Dispose(Boolean).)
	EditExistingScript	Cognex internal use only.
	EndInit	Signals the object that initialization is complete.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	FindRunRecord	Finds a specific run record in a tree of run records
	GetAllTools
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetContainedDataBindings(ICogTool)	Cognex Internal Use Only.
	GetContainedDataBindings(ICogTool, ICogTool)	Cognex Internal Use Only.
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetDisabledSubTools	Returns the publicly visible collection of disabled tools.
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData	(Overrides CogSerializableComponentBase GetObjectData(SerializationInfo, StreamingContext).)
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogComponentBase.)
	GetScriptData
	GetScriptTerminalData(String)	Retrieves the data associated with a terminal. Can be called on both input and output terminals.
	GetScriptTerminalData(String, Object )	Retrieves the data associated with a terminal. Can be called on both input and output terminals.
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	GetSubTools	Returns the publicly visible collection of tools.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	InternalCreateCurrentRecord	Called by the CreateCurrentRecord method to create a record containing the current state of the tool. (Overrides CogToolBase InternalCreateCurrentRecord(ICogRecord, Int32).)
	InternalCreateLastRunRecord	Called by the CreateLastRunRecord method to create a record containing the state of the tool after the last call to its Run method. (Overrides CogToolBase InternalCreateLastRunRecord(ICogRecord, Int32, Int32).)
	InternalRun	Called by the Run method to perform the main processing of the tool. (Overrides CogToolBase InternalRun(String ).)
	IsOrIsDescendentOf(CogToolCollection, ICogTool)	Determines if a tool or one of its descendents ownes a specific scope.
	IsOrIsDescendentOf(ICogTool, ICogTool)
	IsOrIsDescendentOf(ICogTool, ICogTool, Boolean)	Determines if a tool is the same as or is contained by another tool or one of the other tool's descendents.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnChanged(Int64)	This method should be called internally whenever the object's state may have changed. (Inherited from CogSerializableChangedEventComponentBase.)
	OnChanged(CogChangedEventArgs)	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. (Inherited from CogSerializableChangedEventComponentBase.)
	OnDeserialization	Runs when the entire object graph has been deserialized. (Overrides CogToolBase OnDeserialization(Object).)
	OnRan	Raises the Ran event. (Inherited from CogToolBase.)
	OnRunning	Raises the Running event. (Inherited from CogToolBase.)
	PurgeOldScript
	RemoveAnonymousDatabindings(ICogTool)	Cognex Internal Use Only.
	RemoveAnonymousDatabindings( ICogTool )	Cognex Internal Use Only.
	RemoveAnonymousDatabindings(ICogTool, ICogTool)	Cognex Internal Use Only.
	RemoveAnonymousDatabindings(ICogTool, ICogTool )	Cognex Internal Use Only.
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. (Inherited from CogSerializableChangedEventComponentBase.)
	Run	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. (Inherited from CogToolBase.)
	RunTool	Should only be called from tool group script. Runs a single tool. Will not run the tool if it is currently disabled.
	ScriptRefeshRequested	Allows a derived class to be notified when a user requests the auto-genereated portion of the script to be refreshed.
	SetRunStatus	Cognex Internal use only. (Inherited from CogToolBase.)
	SetScriptTerminalData	Sets the data associated with a terminal.
	SuspendChangedEvent	Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. (Inherited from CogSerializableChangedEventComponentBase.)
	Tool_Changed	Called when one of the contained tools raises its Changed event.
	Tools_Clearing
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Fields

	Name	Description
	CurrentRecordEnable_	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. (Inherited from CogToolBase.)
	LastRunLastRunRecordDiagEnable_	Gets or sets the flags specifying the records to create during the next invocation of the Run method. (Inherited from CogToolBase.)
	LastRunRecordDiagEnable_	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. (Inherited from CogToolBase.)
	LastRunRecordEnable_	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. (Inherited from CogToolBase.)
	ProcessingTimeAdjustment_	Gets or sets the amount to offset reported tool processing time. (Inherited from CogToolBase.)
	SfAbortRunOnToolFailure	State flag for the AbortRunOnToolFailure property.
	SfLastRunRecordEnable	State flag for the LastRunRecordEnable property.
	SfNextSf	Next state flag to be used in derived classes.
	SfScript	State flag for the Script property.

Top

Properties

	Name	Description
	AbortRunOnToolFailure	Gets or sets a flag indicating if the Run invocation should abort if the Run method of any of its contained tools fails.
	AllTools	All the Tools owned by this user tool, includes tools that aren't part of the main tools collection but are still tools owned by this user tool... like ToolBlock Inputs and Outputs.
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	ChangedEventSuspended	If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called. (Inherited from CogSerializableChangedEventComponentBase.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	DataBindings	Gets the data bindings for the tool. (Inherited from CogToolBase.)
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	DisabledTools	Gets the collection of tools that are omitted from those run by this user tool.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	ExtraTools	Tools that aren't part of the main tools collection but are still tools owned by this user tool... like ToolBlock Inputs and Outputs. These tools may or may not show up in main ToolTreeView.
	FailOnInvalidDataBinding	Specifies that the Run method is to fail if executed while one or more data bindings are invalid. (Inherited from CogToolBase.)
	HasChanged	(Inherited from CogSerializableChangedEventComponentBase.)
	LastRunRecordEnable	Enable creation of records by bitwise ORing the appropriate CogUserToolLastRunRecordConstants.
	Name	Gets or sets a user-supplied name for the tool. (Inherited from CogToolBase.)
	RunStatus	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. (Inherited from CogToolBase.)
	Script	Cognex Internal Use Only.
	ScriptError	Cognex Internal Use Only.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	StateFlags	Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... } (Inherited from CogSerializableChangedEventComponentBase.)
	Tools	Gets the collection of tools within this user tool.
	UserData	Gets a CogDictionary object that can be used to store application-specific information. (Inherited from CogToolBase.)

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventComponentBase.)
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	Ran	Event that is raised at the end of the tool's Run method. (Inherited from CogToolBase.)
	Running	Event that is raised at the start of the tool's Run method. (Inherited from CogToolBase.)

Top