CogTrackedItemBase Class

Cognex VisionPro 9.20

Base class for any class that will eventually implement ICogTrackedItem

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.Implementation
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 80.0.0.0 (80.0.0.0)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
[ObsoleteAttribute("Use CogTrackedItemBaseEx instead")]
public abstract class CogTrackedItemBase : CogSerializableChangedEventBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

[SerializableAttribute]
[ObsoleteAttribute("Use CogTrackedItemBaseEx instead")]
public abstract class CogTrackedItemBase : CogSerializableChangedEventBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

<SerializableAttribute>
<ObsoleteAttribute("Use CogTrackedItemBaseEx instead")> 
Public MustInherit Class CogTrackedItemBase 
	Inherits CogSerializableChangedEventBase 
	Implements ICogTrackingCollectionTrackedItem, ICogChangedEvent

<SerializableAttribute>
<ObsoleteAttribute("Use CogTrackedItemBaseEx instead")> 
Public MustInherit Class CogTrackedItemBase 
	Inherits CogSerializableChangedEventBase 
	Implements ICogTrackingCollectionTrackedItem, ICogChangedEvent

[SerializableAttribute]
[ObsoleteAttribute(L"Use CogTrackedItemBaseEx instead")]
public ref class CogTrackedItemBase abstract : public CogSerializableChangedEventBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

[SerializableAttribute]
[ObsoleteAttribute(L"Use CogTrackedItemBaseEx instead")]
public ref class CogTrackedItemBase abstract : public CogSerializableChangedEventBase, 
	ICogTrackingCollectionTrackedItem, ICogChangedEvent

The CogTrackedItemBase type exposes the following members.

Constructors

	Name	Description
	CogTrackedItemBase(String)
	CogTrackedItemBase(SerializationInfo, StreamingContext)
	CogTrackedItemBase(String, Object)
	CogTrackedItemBase(String, Type)
	CogTrackedItemBase(String, Object, Type)

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.
	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.
	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.)
	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.)
	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 )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	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.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	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 CogSerializableChangedEventBase.)
	OnChanged(CogChangedEventArgs)	(Overrides CogSerializableChangedEventBase OnChanged(CogChangedEventArgs).)
	OnNameChanging
	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
	SfForceChangedEvent	ForceChangedEvent state flag
	SfID	ID state flag
	SfName	Name state flag
	SfNextSf
	SfValue	Value state flag
	SfValueType	ValueType 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.)
	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.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	ID	Gets the ID property of the terminal
	Name	Gets or Sets the name of the terminal.
	Parent	Returns the Parent or CogTrackingCollection that is currently tracking this Item.
	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.
	ValueType	Gets the expected value type of the terminal

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.

Top

Remarks

Provides common state flags for all ICogTrackedItem implementers