CogDataAnalysis Class

Cognex VisionPro 9.22 SR1

The object that performs tolerancing, statistical analysis, and buffering of data values over a set of data analysis channels.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogDataAnalysis

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 87.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogDataAnalysis : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection, IDictionary, ICogKeyedCollectionEvents

[SerializableAttribute]
public class CogDataAnalysis : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection, IDictionary, ICogKeyedCollectionEvents

<SerializableAttribute>
Public Class CogDataAnalysis 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICollection, IDictionary, ICogKeyedCollectionEvents

<SerializableAttribute>
Public Class CogDataAnalysis 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICollection, IDictionary, ICogKeyedCollectionEvents

[SerializableAttribute]
public ref class CogDataAnalysis : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection, IDictionary, ICogKeyedCollectionEvents

[SerializableAttribute]
public ref class CogDataAnalysis : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICollection, IDictionary, ICogKeyedCollectionEvents

The CogDataAnalysis type exposes the following members.

Constructors

	Name	Description
	CogDataAnalysis	Constructs a new instance of this class.
	CogDataAnalysis(IntPtr)	Constructs a new instance of this class using com pointer.
	CogDataAnalysis(CogDataAnalysis)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	AddNew	Creates a new channel that may be used to set tolerance limits, compute statistics, and buffer data values. If NumBufferedValues is greater than zero, the channel will be initialized with that number of invalid values.
	attachCom
	Clear	Removes all items from this collection.
	Clone	Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject
	CopyTo	Copies the contents of this collection to an array.
	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.)
	Execute	Generate data analysis results by taking each CurrentValue, buffering it, and comparing it to the specified limits.
	Finalize	(Overrides Object Finalize .)
	GetAggregateToleranceStatuses	Gets the history of aggregate tolerance statuses produced. Each status reflects the results of the corresponding historical call to execute. Index 0 represents the oldest status. Index NumBufferedValues-1 represents the most recent status.
	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.)
	GetKey	Gets the key of the item at the specified index.
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	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.)
	IndexOf	Gets the index of the given item. If the item cannot be found -1 is returned.
	IndexOfKey	Gets the index of the item with the specified key. If the key cannot be found -1 is returned.
	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.)
	Move	Moves the selected item to a new index in this collection.
	Remove	Removes the item with the specified key.
	RemoveAt	Removes the item at the specified index.
	ResetBufferedValues	Clears the buffered values for all of the associated channel items. Each channel will have no buffered values after invoking this method.
	ResetRunningStatistics	Resets the running statistics for all of the associated channel items. Each channel's RunningNumSamples will be zero after invoking this method.
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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.
	SetKey	Sets the key of the item at the specified index.
	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.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	__com
	__disposed
	__factory
	Creator
	SfChannelBufferLength	This bit will be set in the EventArgs of a Changed event every time the value returned by ChannelBufferLength may have changed.
	SfIndividualResultsEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by IndividualResultsEnabled may have changed.
	SfNumBufferedValues	This bit will be set in the EventArgs of a Changed event every time the value returned by NumBufferedValues may have changed.
	SfRejectOnInvalidData	This bit will be set in the EventArgs of a Changed event every time the value returned by RejectOnInvalidData may have changed.

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.
	ChannelBufferLength	Returns/sets the number of values to buffer for each ICogDataAnalysisChannel item. The CurrentValue of each object will be buffered for each call to Run or Execute.
	Count	Gets the number of items contained in this collection.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	IndividualResultsEnabled	Returns/sets the flag that controls whether individual result objects are added to the Results collection by Execute. If set to false, the Results collection will only hold the aggregate results.
	IsSynchronized	Gets a value indicating whether access to this collection is synchronized (thread-safe).
	Item Int32	Gets or sets the item with the specified index or key. In C#, this property is the indexer for the collection.
	Item String	Gets or sets the item with the specified index or key. In C#, this property is the indexer for the collection.
	NumBufferedValues	Returns the number of values stored in the buffer for each ICogDataAnalysisChannel item. This includes any invalid values that may have been buffered. NumBufferedValues will always be less than or equal to the ChannelBufferLength.
	RejectOnInvalidData	Returns/sets a flag that causes any invalid data values to produce a reject AggregateToleranceStatus if set to true. If set to false, this designates that those channels will not be used to compute the aggregate tolerance status.
	SyncRoot	Gets an object that can be used to synchronize access to this collection.

Top

Events

	Name	Description
	Changed
	Cleared	Occurs after this collection is cleared.
	Clearing	Occurs before this collection is cleared.
	InsertedItem	Occurs after an item is inserted into this collection.
	InsertingItem	Occurs before an item is inserted into this collection.
	KeyChanged	Occurs after an item's key is changed.
	KeyChanging	Occurs before an item's key is changed.
	MovedItem	Occurs after an item is moved to a new index.
	MovingItem	Occurs before an item is moved to a new index.
	RemovedItem	Occurs after an item is removed from this collection.
	RemovingItem	Occurs before an item is removed from this collection.
	ReplacedItem	Occurs after an item is replaced in this collection.
	ReplacingItem	Occurs before an item is replaced in this collection.

Top

Remarks

Primary interface for CogDataAnalysis objects. Each CogDataAnalysis object holds a collection of CogStatisticss. Tolerance results are generated across the set of channels via the Execute method.