CogToolBlockTerminalCollection Class

Cognex VisionPro 9.20

A collection of CogToolBlockTerminals

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Implementation CogSerializableCollectionBase CogToolBlockTerminal
            Cognex.VisionPro.Implementation CogTrackingCollection CogToolBlockTerminal
              Cognex.VisionPro.ToolBlock CogToolBlockTerminalCollection

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogToolBlockTerminalCollection : CogTrackingCollection<CogToolBlockTerminal>, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, IDeserializationCallback

[SerializableAttribute]
public class CogToolBlockTerminalCollection : CogTrackingCollection<CogToolBlockTerminal>, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, IDeserializationCallback

<SerializableAttribute>
Public Class CogToolBlockTerminalCollection 
	Inherits CogTrackingCollection(Of CogToolBlockTerminal)
	Implements ICogTool, ICogChangedEvent, IComponent, IDisposable, 
	IDeserializationCallback

<SerializableAttribute>
Public Class CogToolBlockTerminalCollection 
	Inherits CogTrackingCollection(Of CogToolBlockTerminal)
	Implements ICogTool, ICogChangedEvent, IComponent, IDisposable, 
	IDeserializationCallback

[SerializableAttribute]
public ref class CogToolBlockTerminalCollection : public CogTrackingCollection<CogToolBlockTerminal^>, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, IDeserializationCallback

[SerializableAttribute]
public ref class CogToolBlockTerminalCollection : public CogTrackingCollection<CogToolBlockTerminal^>, 
	ICogTool, ICogChangedEvent, IComponent, IDisposable, IDeserializationCallback

The CogToolBlockTerminalCollection type exposes the following members.

Constructors

	Name	Description
	CogToolBlockTerminalCollection
	CogToolBlockTerminalCollection(CogToolBlockTerminalCollection)	Not Supported, use CogSerializer to Copy an instance of CogToolBlockTerminalCollection.

Top

Methods

	Name	Description
	Add	Adds value to the end of the collection. (Inherited from CogSerializableCollectionBase T .)
	Clear	Removes all objects from the collection. (Inherited from CogSerializableCollectionBase T .)
	Contains(T)	Returns true if value is in the collection (Inherited from CogSerializableCollectionBase T .)
	Contains(String)	Returns true if the collection contains an item with the specified Name or ID. (Inherited from CogTrackingCollection T .)
	CopyTo	Copies the collection to an array (Inherited from CogSerializableCollectionBase T .)
	CreateCurrentRecord	The CreateCurrentRecord Method for CogToolBlockTerminalCollection does not do anything.
	CreateLastRunRecord	The CreateLastRunRecord Method for CogToolBlockTerminalCollection does not do anything.
	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.)
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEnumerator	Returns an enumerator that can iterate through the collection's items. (Inherited from CogTrackingCollection T .)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetFormattedTerminalStrings	Gets a list of specially formatted strings that represent the names and paths to all the CogToolBlockTerminals in this collection. These strings are formatted such that they can be passed directly to ToolTerminals.SetToolInputTerminals(ICogTool tool, string[] terminals) or ToolTerminals.SetToolOutputTerminals(ICogTool tool, string[] terminals)
	GetFormattedTerminalStrings(String)	Gets a list of specially formatted strings that represent the names and paths to all the CogToolBlockTerminals in this collection. These strings are formatted such that they can be passed directly to ToolTerminals.SetToolInputTerminals(ICogTool tool, string[] terminals) or ToolTerminals.SetToolOutputTerminals(ICogTool tool, string[] terminals)
	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	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableObjectBase.)
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Returns a collection containing all PropertyDescriptors found in the standard fasion, augmented with property descriptors name and ID of the tracked item that can be obtained using the string overload of the item indexer. (Inherited from CogTrackingCollection T .)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Returns the index of value in the collection, or -1 if value is not in the collection. (Inherited from CogSerializableCollectionBase T .)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	Insert	Inserts the value at the specified index of the collection (Inherited from CogSerializableCollectionBase T .)
	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.)
	Move	Moves an item from one position to another. (Inherited from CogSerializableCollectionBase T .)
	OnChanged(Int64)	This method should be called internally whenever the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	OnChanged(CogChangedEventArgs)	(Overrides CogSerializableChangedEventBase OnChanged(CogChangedEventArgs).)
	OnCleared	Raises the Cleared event. (Inherited from CogSerializableCollectionBase T .)
	OnClearing	Raises the Clearing event. (Inherited from CogTrackingCollection T .)
	OnDeserialization	Runs when the entire object graph has been deserialized. (Overrides CogTrackingCollection T OnDeserialization(Object).)
	OnDisposed	Raises the Disposed event.
	OnInsertedItem	Raises the InsertedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnInsertingItem	Raises the InsertingItem event. (Inherited from CogTrackingCollection T .)
	OnMovedItem	(Inherited from CogTrackingCollection T .)
	OnMovingItem	Raises the MovingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnRemovedItem	Raises the RemovedItem event. (Inherited from CogTrackingCollection T .)
	OnRemovingItem	Raises the RemovingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnReplacedItem	Raises the ReplacedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnReplacingItem	Raises the ReplacingItem event. (Inherited from CogTrackingCollection T .)
	OnStartTracking	Called when a new item in the collection needs to be tracked (Inherited from CogTrackingCollection T .)
	OnStopTracking	Called when an item in the collection no longer needs to be tracked (Inherited from CogTrackingCollection T .)
	OnTrackedItemNameChanging	(Inherited from CogTrackingCollection T .)
	Remove(T)	Removes value from the collection (Inherited from CogSerializableCollectionBase T .)
	Remove(String)	Removes the item with the specified Name or ID from the collection. (Inherited from CogTrackingCollection T .)
	RemoveAt	Removes the element at the specified index. (Inherited from CogSerializableCollectionBase T .)
	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.)
	Run	The Run Method for CogToolBlockTerminalCollection does not do anything.
	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
	SfFailOnInvalidDataBinding	State flag for the FailOnInvalidDataBinding property.
	SfNextSf

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.)
	Count	Gets the number of elements contained in the collection. (Inherited from CogSerializableCollectionBase T .)
	DataBindings
	FailOnInvalidDataBinding	Specifies that the Run method is to fail if executed while one or more data bindings are invalid.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	InnerList	Gets the internal List containing the list of elements. (Inherited from CogSerializableCollectionBase T .)
	IsFixedSize	returns false (Inherited from CogSerializableCollectionBase T .)
	IsReadOnly	Returns true if this collection is ReadOnly (Inherited from CogSerializableCollectionBase T .)
	IsSynchronized	(Inherited from CogSerializableCollectionBase T .)
	Item Int32	Returns the T at index (Inherited from CogSerializableCollectionBase T .)
	Item String	Gets the T with the specified Name or ID. (Inherited from CogTrackingCollection T .)
	List	Gets an the IList interface of this collection. (Inherited from CogSerializableCollectionBase T .)
	Name
	Parent	Returns the Parent CogToolBlock.
	RunStatus
	Site
	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.)
	SyncRoot	(Inherited from CogSerializableCollectionBase T .)
	UserData

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.)
	Cleared	Raised after the collection is cleared. (Inherited from CogSerializableCollectionBase T .)
	Clearing	Raised before the collection is cleared. (Inherited from CogSerializableCollectionBase T .)
	Disposed	This event is raised when the Dispose method is called. It gets called before any disposing is done so the properties of this object are still valid at this point.
	InsertedItem	Raised after an item is inserted. (Inherited from CogSerializableCollectionBase T .)
	InsertingItem	Raised before an item is inserted. (Inherited from CogSerializableCollectionBase T .)
	MovedItem	Raised after an item is moved to a new index. (Inherited from CogSerializableCollectionBase T .)
	MovingItem	Raised before an item is moved to a new index. (Inherited from CogSerializableCollectionBase T .)
	Ran
	RemovedItem	Raised after an item is removed. (Inherited from CogSerializableCollectionBase T .)
	RemovingItem	Raised before an item is removed. (Inherited from CogSerializableCollectionBase T .)
	ReplacedItem	Raised after an item is replaced. (Inherited from CogSerializableCollectionBase T .)
	ReplacingItem	Raised before an item is replaced. (Inherited from CogSerializableCollectionBase T .)
	Running
	TrackedItemNameChanging	Event raised when a tracked item is about to change its name. (Inherited from CogTrackingCollection T .)

Top

Remarks

Used by CogToolBlock as a container for input and output property collections.

Note that CogToolBlockTerminal also implements ICogTool (even though the run method does not do anything). This allows DataBindings to the terminal values via the CogDataBinding mechanism supported by all VisionPro tools.