The CogToolBlock type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddCompositeLastRunRecord |
Adds all of the contained tools' last run records to the supplied
record.
(Inherited from CogUserTool.) |
 | AddGraphicToRunRecord |
Should only be called from tool group script. Adds a
graphic to a specified run record.
(Inherited from CogUserTool.) |
| AddSharedGraphics |
Shares all graphics between image records with the same space tree in the passed ICogRecord
(Inherited from CogUserTool.) |
| BeginInit |
Signals the object that initialization is starting.
(Inherited from CogUserTool.) |
| 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 |
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 .) |
| 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(CogScriptLanguageConstants) | (Overrides CogUserTool CreateNewScript(CogScriptLanguageConstants).) |
| CreateNewScript(CogScriptLanguageConstants, CogToolBlockScriptTypeConstants) |
Creates a new ToolBlock script using the specified language and type.
|
| 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) | 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).) |
| DefineScriptTerminal(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).) |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
| Dispose(Boolean) | (Overrides CogUserTool Dispose(Boolean).) |
| EditExistingScript |
Cognex internal use only.
(Inherited from CogUserTool.) |
| EndInit |
Signals the object that initialization is complete.
(Inherited from CogUserTool.) |
| Equals | (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
(Inherited from CogUserTool.) |
| 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 | (Inherited from CogUserTool.) |
| 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 | (Inherited from CogUserTool.) |
| GetScriptTerminalData(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).) |
| GetScriptTerminalData(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 ).) |
| GetService | (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 | (Overrides CogUserTool InternalCreateCurrentRecord(ICogRecord, Int32).) |
| InternalCreateLastRunRecord | (Overrides CogUserTool InternalCreateLastRunRecord(ICogRecord, Int32, Int32).) |
| InternalRun | (Overrides CogToolGroup InternalRun(String ).) |
| 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 | (Overrides CogUserTool OnDeserialization(Object).) |
| OnRan |
Raises the Ran event.
(Inherited from CogToolGroup.) |
| OnRunning |
Raises the Running event.
(Inherited from CogToolBase.) |
| PurgeOldScript | (Inherited from CogUserTool.) |
| 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.
(Inherited from CogUserTool.) |
| ScriptRefeshRequested |
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).) |
| SetRunStatus |
Cognex Internal use only.
(Inherited from CogToolBase.) |
| SetScriptTerminalData | Obsolete.
This API is obsolete, CogToolBlock does not support Script Only Terminals.
Use CogToolBlock.Inputs and CogToolBlock.Outputs collections instead.
(Overrides CogUserTool SetScriptTerminalData(String, Object).) |
| 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.
(Inherited from CogUserTool.) |
| Tools_Clearing | (Inherited from CogUserTool.) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
| Upgrade |
For internal use only.
(Inherited from CogToolGroup.) |
See Also