CogToolBase Class

Cognex VisionPro 9.23

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

Inheritance Hierarchy

Namespace: Cognex.VisionPro.Implementation
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 91.0.0.0 (91.0.0.0)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public abstract class CogToolBase : CogSerializableChangedEventComponentBase, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, ICloneable, 
	ICustomTypeDescriptor, IDeserializationCallback

[SerializableAttribute]
public abstract class CogToolBase : CogSerializableChangedEventComponentBase, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, ICloneable, 
	ICustomTypeDescriptor, IDeserializationCallback

<SerializableAttribute>
Public MustInherit Class CogToolBase 
	Inherits CogSerializableChangedEventComponentBase 
	Implements ICogTool, ICogChangedEvent, IComponent, IDisposable, 
	ICloneable, ICustomTypeDescriptor, IDeserializationCallback

<SerializableAttribute>
Public MustInherit Class CogToolBase 
	Inherits CogSerializableChangedEventComponentBase 
	Implements ICogTool, ICogChangedEvent, IComponent, IDisposable, 
	ICloneable, ICustomTypeDescriptor, IDeserializationCallback

[SerializableAttribute]
public ref class CogToolBase abstract : public CogSerializableChangedEventComponentBase, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, ICloneable, 
	ICustomTypeDescriptor, IDeserializationCallback

[SerializableAttribute]
public ref class CogToolBase abstract : public CogSerializableChangedEventComponentBase, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, ICloneable, 
	ICustomTypeDescriptor, IDeserializationCallback

The CogToolBase type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	CheckRunConditions	Check for run conditions including data binding.
	CheckRunConditionsNoThrow	Check for run conditions including data binding, returning an exception for the first problem encountered.
	Clone	Creates a deep copy of the tool.
	CreateCurrentRecord	Creates a new set of records that represents the tool's current state.
	CreateLastRunRecord	Creates a new set of records that represents the tool's last-run state.
	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.)
	Dispose	Releases all resources used by the Component. (Inherited from Component.)
	Dispose(Boolean)	Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
	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.)
	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.)
	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.)
	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	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableComponentBase.)
	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.)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	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.
	InternalCreateLastRunRecord	Called by the CreateLastRunRecord method to create a record containing the state of the tool after the last call to its Run method.
	InternalRun	Called by the Run method to perform the main processing of the tool.
	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
	OnRan	Raises the Ran event.
	OnRunning	Raises the Running event.
	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.
	SetRunStatus	Cognex Internal use only.
	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.)
	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.
	LastRunLastRunRecordDiagEnable_	Gets or sets the flags specifying the records to create during the next invocation of the Run method.
	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.
	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.
	ProcessingTimeAdjustment_	Gets or sets the amount to offset reported tool processing time.
	SfCreateCurrentRecord	State flag for the CurrentRecordEnable property.
	SfCreateLastRunRecord	State flag for the LastRunRecordEnable property.
	SfFailOnInvalidDataBinding	State flag for the FailOnInvalidDataBinding property.
	SfName	State flag for the Name property.
	SfNextSf	Next state flag to be used in derived classes.
	SfRunStatus	State flag for the RunStatus property.

Top

Properties

	Name	Description
	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.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	FailOnInvalidDataBinding	Specifies that the Run method is to fail if executed while one or more data bindings are invalid.
	HasChanged	(Inherited from CogSerializableChangedEventComponentBase.)
	Name	Gets or sets a user-supplied name for the tool.
	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.
	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.)
	UserData	Gets a CogDictionary object that can be used to store application-specific information.

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.
	Running	Event that is raised at the start of the tool's Run method.

Top