LineMaxToolBase ClassCognex VisionPro 9.21 SR1

Class that provides tool level access to LineMaxOperator functionality.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.Implementation TrackedItemBase
        Cognex.Vision.Implementation ToolBase
          Cognex.Vision.LineMax.Implementation LineMaxToolBase
            Cognex.Vision.LineMax LineMaxTool

Namespace: Cognex.Vision.LineMax.Implementation
Assembly: Cognex.Vision.LineMax.Net (in Cognex.Vision.LineMax.Net.dll) Version: 9.21.1.1
Syntax

public abstract class LineMaxToolBase : ToolBase

The LineMaxToolBase type exposes the following members.

Constructors

  NameDescription
Protected methodLineMaxToolBase
Top
Methods

  NameDescription
Public methodCheckRunConditionsSelf

Performs RunCondition check by the tool itself.

(Inherited from ToolBase.)
Public methodCopyBase

Create a copy of this tool.

(Inherited from ToolBase.)
Public methodCreateCurrentRecord

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

(Inherited from ToolBase.)
Public methodCreateLastRunRecord

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

(Inherited from ToolBase.)
Public methodEquals
Compares the equality of this object with another.
(Overrides ToolBase Equals(Object).)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetContainerAsILinkManager

Get the container which contains the Tool.

(Inherited from ToolBase.)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides ToolBase GetHashCode .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Inherited from ShareableBase.)
Public methodIsCheckRunConditionsDelegateToOwner

Check if tool checks its RunCondition by its owner.

(Inherited from ToolBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodResumeAndRaiseChangedEvent

Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent 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 ChangedEventShareableBase.)
Public methodRun

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 a string representation of that exception will be packaged in the Message property of the tool's RunStatus. Should this occur, the Result property of the tool's RunStatus will be set to Error. It is the user's responsibility to examine the tool's RunStatus after calling Run.

(Inherited from ToolBase.)
Public methodSuspendChangedEvent

Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.

(Inherited from ChangedEventShareableBase.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two LineMaxToolBase objects.
Public operatorStatic memberInequality
Compares the inequality of two LineMaxToolBase objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfCurrentRecordEnable
Public fieldStatic memberSfLastRunRecordDiagEnable
Public fieldStatic memberSfLastRunRecordEnable
Public fieldStatic memberSfResults
Public fieldStatic memberSfRunParams
Top
Properties

  NameDescription
Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Inherited from ChangedEventShareableBase.)
Public propertyCurrentRecordEnable
Get

Gets the record options used by CreateCurrentRecord.

Public propertyEnabled
Get

Whether the tool is enabled to run. If false, calling the tool's Run function will not actually run the tool and will cause no change in the tool's state.

(Inherited from ToolBase.)
Public propertyFailOnInvalidDataBinding
Get

Whether the tool's Run method is to fail if executed while one or more DataBindings (aka Links) are Invalid.

(Inherited from ToolBase.)
Public propertyHandle (Overrides ToolBase Handle.)
Public propertyID

Gets the ID of the tracked item.

(Inherited from TrackedItemBase.)
Public propertyInputs

A collection of named Input Pin values.

(Inherited from ToolBase.)
Public propertyLastRunRecordDiagEnable
Get

Gets the record diagnostic options used by CreateLastRunRecord.

Public propertyLastRunRecordEnable
Get

Gets the record options used by CreateLastRunRecord.

Public propertyName
Get

Get the name of the tracked item.

(Inherited from TrackedItemBase.)
Public propertyOutputs

A collection of named Output Pin values.

(Inherited from ToolBase.)
Public propertyParent
Get

Return a reference to the containing tracking collection. May be null.

(Inherited from TrackedItemBase.)
Public propertyResults

Gets the collection of results generated by the most recent call to Run.

Public propertyRunStatus

Gets 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.

(Inherited from ToolBase.)
Top
Events

  NameDescription
Public eventChanged

The actual event.

(Inherited from ChangedEventShareableBase.)
Public eventNameChanging

This event is raised when the Name is about to change. Note that this is a cancellable event.

(Inherited from TrackedItemBase.)
Public eventRan

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

(Inherited from ToolBase.)
Public eventRunning

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

(Inherited from ToolBase.)
Top
See Also