RunStatus Class

Cognex VisionPro 9.21 SR1

This class provides an implementation of the IRunStatus interface. A tool's RunStatus property is of type IRunStatus. This property provides 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.

Inheritance Hierarchy

System Object
Cognex.Vision ShareableBase
Cognex.Vision.Implementation RunStatus

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

Syntax

C++

Copy to Clipboard Print

public sealed class RunStatus : ShareableBase, 
	IRunStatus, IObject

public sealed class RunStatus : ShareableBase, 
	IRunStatus, IObject

Public NotInheritable Class RunStatus 
	Inherits ShareableBase 
	Implements IRunStatus, IObject

Public NotInheritable Class RunStatus 
	Inherits ShareableBase 
	Implements IRunStatus, IObject

public ref class RunStatus sealed : public ShareableBase, 
	IRunStatus, IObject

public ref class RunStatus sealed : public ShareableBase, 
	IRunStatus, IObject

The RunStatus type exposes the following members.

Constructors

	Name	Description
	RunStatus	Constructs a new instance of this class.
	RunStatus(ToolResultConstants, String, Double, Double)	Constructs a new instance of the RunStatus class.

Top

Methods

	Name	Description
	Equals	Compares the equality of this object with another. (Overrides ShareableBase Equals(Object).)
	GetHashCode	Returns the hash code of this object. (Overrides ShareableBase GetHashCode .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeMeta	Get the TypeMeta that describes the type of this object. (Overrides ShareableBase GetTypeMeta .)
	ToString	Returns a human readable string that represents the object. (Overrides Object ToString .)

Top

Operators

	Name	Description
	Equality	Compares the equality of two RunStatus objects.
	Inequality	Compares the inequality of two RunStatus objects.

Top

Properties

	Name	Description
	Handle	(Overrides ShareableBase Handle.)
	Message	Returns an empty string if the result was Accept, and otherwise returns a string that provides additional information about the Warning, Reject, or Error condition.
	ProcessingTime	Returns the time in milliseconds taken to perform the tool's processing when its Run function was called. This excludes the time taken by event handlers connected to the tool.
	Result	Gets a result code that indicates the overall result of running the tool.
	TotalTime	Returns the total time in milliseconds taken by the tool's Run function. This includes the time taken by event handlers connected to the tool.

Top