CogToolBlock ClassCognex VisionPro 9.7
Similar to CogToolGroup, A VisionPro tool that contains a set of VisionPro tools. Running the CogToolBlock runs each of the tools it contains. The run status and records of the CogToolBlock are based on the aggregate of all its contained tools. Exposed Inputs and Outputs collection properties provide customization and storage for graphically linked terminals.
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
                  Cognex.VisionPro.ToolBlock CogToolBlock

Namespace: Cognex.VisionPro.ToolBlock
Assembly: Cognex.VisionPro.ToolGroup (in Cognex.VisionPro.ToolGroup.dll) Version: 73.0.0.0 (73.0.0.0)
Syntax

[SerializableAttribute]
public class CogToolBlock : CogToolGroup

The CogToolBlock type exposes the following members.

Constructors

  NameDescription
Public methodCogToolBlock 
Public methodCogToolBlock(CogToolBlock)
CogToolBlock does not support copy construction. Please use DeepCopyObject(Object) to copy a CogToolBlock.
Protected methodCogToolBlock(SerializationInfo, StreamingContext)
Top
Methods

  NameDescription
Protected methodAddCompositeLastRunRecord
Adds all of the contained tools' last run records to the supplied record.
(Inherited from CogUserTool.)
Public methodAddGraphicToRunRecord
Should only be called from tool group script. Adds a graphic to a specified run record.
(Inherited from CogUserTool.)
Protected methodAddSharedGraphics
Shares all graphics between image records with the same space tree in the passed ICogRecord
(Inherited from CogUserTool.)
Public methodBeginInit
Signals the object that initialization is starting.
(Inherited from CogUserTool.)
Protected methodCheckRunConditions
Check for run conditions including data binding.
(Inherited from CogToolBase.)
Protected methodCheckRunConditionsNoThrow
Check for run conditions including data binding, returning an exception for the first problem encountered.
(Inherited from CogToolBase.)
Protected methodClone
CogToolBlock does not support Clone(). It's not well defined if Clone should return a deep or shallow copy. Please use DeepCopyObject(Object) to create a copy of a CogToolBlock.
(Overrides CogToolGroup Clone .)
Public methodCreateCurrentRecord
Creates a new set of records that represents the tool's current state.
(Inherited from CogToolBase.)
Public methodCreateLastRunRecord
Creates a new set of records that represents the tool's last-run state.
(Inherited from CogToolBase.)
Public methodCreateNewScript(CogScriptLanguageConstants) (Overrides CogUserTool CreateNewScript(CogScriptLanguageConstants).)
Public methodCreateNewScript(CogScriptLanguageConstants, CogToolBlockScriptTypeConstants)
Creates a new ToolBlock script using the specified language and type.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDefineScriptTerminal(Object, String, Boolean)Obsolete.
This API is obsolete, CogToolBlock does not support Script Only Terminals. Use CogToolBlock.Inputs and CogToolBlock.Outputs collections instead.
(Overrides CogUserTool DefineScriptTerminal(Object, String, Boolean).)
Public methodDefineScriptTerminal(String, Object, String, Boolean)Obsolete.
This API is obsolete, CogToolBlock does not support Script Only Terminals. Use CogToolBlock.Inputs and CogToolBlock.Outputs collections instead.
(Overrides CogUserTool DefineScriptTerminal(String, Object, String, Boolean).)
Public methodDispose 
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean) (Overrides CogUserTool Dispose(Boolean).)
Public methodEditExistingScript
Cognex internal use only.
(Inherited from CogUserTool.)
Public methodEndInit
Signals the object that initialization is complete.
(Inherited from CogUserTool.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodFindRunRecord
Finds a specific run record in a tree of run records
(Inherited from CogUserTool.)
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData (Inherited from CogUserTool.)
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.)
Protected methodGetScriptData (Inherited from CogUserTool.)
Public methodGetScriptTerminalData(String)Obsolete.
This API is obsolete, CogToolBlock does not support Script Only Terminals. Use CogToolBlock.Inputs and CogToolBlock.Outputs collections instead.
(Overrides CogUserTool GetScriptTerminalData(String).)
Public methodGetScriptTerminalData(String, Object )Obsolete.
This API is obsolete, CogToolBlock does not support Script Only Terminals. Use CogToolBlock.Inputs and CogToolBlock.Outputs collections instead.
(Overrides CogUserTool GetScriptTerminalData(String, Object ).)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodInternalCreateCurrentRecord (Overrides CogUserTool InternalCreateCurrentRecord(ICogRecord, Int32).)
Protected methodInternalCreateLastRunRecord (Overrides CogUserTool InternalCreateLastRunRecord(ICogRecord, Int32, Int32).)
Protected methodInternalRun (Overrides CogToolGroup InternalRun(String ).)
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnChanged(Int64)
This method should be called internally whenever the object's state may have changed.
(Inherited from CogSerializableChangedEventComponentBase.)
Protected methodOnChanged(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.)
Public methodOnDeserialization (Overrides CogUserTool OnDeserialization(Object).)
Protected methodOnRan
Raises the Ran event.
(Inherited from CogToolGroup.)
Protected methodOnRunning
Raises the Running event.
(Inherited from CogToolBase.)
Protected methodPurgeOldScript (Inherited from CogUserTool.)
Public methodResumeAndRaiseChangedEvent
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.)
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 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.)
Public methodRunTool
Should only be called from tool group script. Runs a single tool. Will not run the tool if it is currently disabled.
(Inherited from CogUserTool.)
Protected methodScriptRefeshRequested
Refreshes the auto-generated section of the script (if any exist) to update for changes made to the ToolBlock. Should only be called from the ScriptEditor, as this only updates the text... The script editor still needs to recompile and replace the actual script object.
(Overrides CogUserTool ScriptRefeshRequested(Object, EventArgs).)
Protected methodSetRunStatus
Cognex Internal use only.
(Inherited from CogToolBase.)
Public methodSetScriptTerminalDataObsolete.
This API is obsolete, CogToolBlock does not support Script Only Terminals. Use CogToolBlock.Inputs and CogToolBlock.Outputs collections instead.
(Overrides CogUserTool SetScriptTerminalData(String, Object).)
Public methodSuspendChangedEvent
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.)
Protected methodTool_Changed
Called when one of the contained tools raises its Changed event.
(Inherited from CogUserTool.)
Protected methodTools_Clearing (Inherited from CogUserTool.)
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Public methodUpgrade
For internal use only.
(Inherited from CogToolGroup.)
Top
Fields

  NameDescription
Protected fieldCurrentRecordEnable_
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.)
Protected fieldLastRunLastRunRecordDiagEnable_
Gets or sets the flags specifying the records to create during the next invocation of the Run method.
(Inherited from CogToolBase.)
Protected fieldLastRunRecordDiagEnable_
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.)
Protected fieldLastRunRecordEnable_
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.)
Protected fieldProcessingTimeAdjustment_
Gets or sets the amount to offset reported tool processing time.
(Inherited from CogToolBase.)
Top
Properties

  NameDescription
Public propertyAbortRunOnToolFailure
Gets or sets a flag indicating if the Run invocation should abort if the Run method of any of its contained tools fails.
(Inherited from CogUserTool.)
Protected propertyAllTools (Overrides CogUserTool AllTools.)
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Public propertyChangedEventSuspended
If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventComponentBase.)
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyDataBindings
Gets the data bindings for the tool.
(Inherited from CogToolBase.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Public propertyDisabledTools
Gets the collection of tools that are omitted from those run by this tool group.
(Inherited from CogToolGroup.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Protected propertyExtraTools
Tools that aren't part of the main tools collection but are still tools owned by this user tool... like ToolBlock Inputs and Outputs.
(Overrides CogUserTool ExtraTools.)
Public propertyFailOnInvalidDataBinding
Specifies that the Run method is to fail if executed while one or more data bindings are invalid.
(Inherited from CogToolBase.)
Public propertyGarbageCollectionEnabled
Gets or sets the flag indicating that garbage collection is to be run periodically.
(Inherited from CogToolGroup.)
Public propertyGarbageCollectionFrequency
Gets or sets the frequency at which garbage collection is to be run.
(Inherited from CogToolGroup.)
Public propertyHasChanged (Inherited from CogSerializableChangedEventComponentBase.)
Public propertyInputs
A CogToolBlockTerminalCollection of input terminals. The default is an empty collection.
Public propertyLastRunRecordEnable
Enable creation of records by bitwise ORing the appropriate CogUserToolLastRunRecordConstants.
(Inherited from CogUserTool.)
Public propertyName
Gets or sets a user-supplied name for the tool.
(Inherited from CogToolBase.)
Public propertyOutputs
CogToolBlockTerminalCollection of output terminals. The default is an empty collection.
Public propertyRunStatus
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.)
Public propertyScript
Cognex Internal Use Only.
(Inherited from CogUserTool.)
Public propertyScriptData
Cognex internal use only.
(Inherited from CogToolGroup.)
Public propertyScriptError
Cognex Internal Use Only.
(Inherited from CogUserTool.)
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertyStateFlags
Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventComponentBase.)
Public propertyTools
Gets the collection of tools within this tool block.
Public propertyUserData
Gets a CogDictionary object that can be used to store application-specific information.
(Inherited from CogToolBase.)
Top
Events

  NameDescription
Public eventChanged
This event is raised when one or more parts of the object's state may have changed.
(Inherited from CogSerializableChangedEventComponentBase.)
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose  method.
(Inherited from Component.)
Public eventRan
Event that is raised at the end of the tool's Run method.
(Inherited from CogToolBase.)
Public eventRunning
Event that is raised at the start of the tool's Run method.
(Inherited from CogToolBase.)
Top
See Also