CogToolBlockTerminal Class

Cognex VisionPro 9.7

Class cooresponding to an individual ToolBlock terminal, usually a member of a ToolBlock Inputs or Outputs collection.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Implementation CogTrackedItemBase
            Cognex.VisionPro.ToolBlock CogToolBlockTerminal

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public sealed class CogToolBlockTerminal : CogTrackedItemBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

[SerializableAttribute]
public sealed class CogToolBlockTerminal : CogTrackedItemBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

<SerializableAttribute>
Public NotInheritable Class CogToolBlockTerminal 
	Inherits CogTrackedItemBase 
	Implements ICogTrackingCollectionTrackedItem, ICogChangedEvent

<SerializableAttribute>
Public NotInheritable Class CogToolBlockTerminal 
	Inherits CogTrackedItemBase 
	Implements ICogTrackingCollectionTrackedItem, ICogChangedEvent

[SerializableAttribute]
public ref class CogToolBlockTerminal sealed : public CogTrackedItemBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

[SerializableAttribute]
public ref class CogToolBlockTerminal sealed : public CogTrackedItemBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

The CogToolBlockTerminal type exposes the following members.

Constructors

	Name	Description
	CogToolBlockTerminal(SerializationInfo, StreamingContext)	Standard Serialization Constructor
	CogToolBlockTerminal(String, Object)	Creates a new CogToolBlockTerminal with the supplied name and value.
	CogToolBlockTerminal(String, Type)	Creates a new CogToolBlockTerminal with the supplied name and valueType.
	CogToolBlockTerminal(String, Object, Type)	Creates a new CogToolBlockTerminal with the supplied name, value, and valueType.
	CogToolBlockTerminal(String, Type, Boolean)	Creates a new CogToolBlockTerminal with the supplied name and valueType.

Top

Methods

	Name	Description
	BeginForceChangedEvent	Called at the begining of a section of code that must raise a changed event containing the given state flags. (Inherited from CogTrackedItemBase.)
	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.)
	EndForceChangedEvent	Called at the end of a section of code that must raise a changed event with the given state flags... If a changed event with these state flags has not been raised "naturally" since the coresponding call to BeginForceChangedEvents was called, this call will raise the event. (Inherited from CogTrackedItemBase.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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.)
	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.)
	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 CogSerializableChangedEventBase.)
	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 CogSerializableChangedEventBase.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfDescription	Description state flag

Top

Properties

	Name	Description
	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 CogSerializableChangedEventBase.)
	Description	A short description of this terminal
	ForceChangedEvent	Gets/Sets whether a CogToolBlock containing this terminal in its Outputs collection will force a changed event with the SfValue state flag set every time the CogToolBlock is run (even if the value did not change). Use this property when linking to a CogDataAnyalysisTool to prevent the CogDataAnyalysisTool from giving a reject result due to the Data Analysis Channels not being updated. (Inherited from CogTrackedItemBase.)
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	ID	Gets the ID property of the terminal (Inherited from CogTrackedItemBase.)
	Name	Gets or Sets the name of the terminal. (Inherited from CogTrackedItemBase.)
	Parent	Returns the Parent or CogTrackingCollection that is currently tracking this Item. (Inherited from CogTrackedItemBase.)
	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 CogSerializableChangedEventBase.)
	Value	Gets or Sets the value of the terminal. (Inherited from CogTrackedItemBase.)
	ValueType	Gets the expected value type of the terminal (Inherited from CogTrackedItemBase.)

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	NameChanging	Event raised when the name of a terminal is about to change. Gives a listener an oportuity to cancel the name change. (Inherited from CogTrackedItemBase.)

Top

Remarks

ToolBlock terminals are different from "regular" tool terminals. ToolBlock terminals are storage objects unto themselves. Regular tool terminals represent a path to an existing tool's member or property.