CogPMRedLineResults Class

Cognex VisionPro

Class that holds a collection of PMRedLine search results. An instance of this class is created by every run of PMRedLine. Results are stored in order of decreasing score.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogReadOnlyCollectionWithCustomSerialization CogPMRedLineResult
          Cognex.VisionPro.PMRedLine CogPMRedLineResults

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogPMRedLineResults : CogReadOnlyCollectionWithCustomSerialization<CogPMRedLineResult>, 
	IDisposable

[SerializableAttribute]
public class CogPMRedLineResults : CogReadOnlyCollectionWithCustomSerialization<CogPMRedLineResult>, 
	IDisposable

<SerializableAttribute>
Public Class CogPMRedLineResults 
	Inherits CogReadOnlyCollectionWithCustomSerialization(Of CogPMRedLineResult)
	Implements IDisposable

<SerializableAttribute>
Public Class CogPMRedLineResults 
	Inherits CogReadOnlyCollectionWithCustomSerialization(Of CogPMRedLineResult)
	Implements IDisposable

[SerializableAttribute]
public ref class CogPMRedLineResults : public CogReadOnlyCollectionWithCustomSerialization<CogPMRedLineResult^>, 
	IDisposable

[SerializableAttribute]
public ref class CogPMRedLineResults : public CogReadOnlyCollectionWithCustomSerialization<CogPMRedLineResult^>, 
	IDisposable

The CogPMRedLineResults type exposes the following members.

Constructors

	Name	Description
	CogPMRedLineResults(CogPMRedLineResults)	Constructs a deep copy of the supplied CogPMRedLineResults object.
	CogPMRedLineResults(SerializationInfo, StreamingContext)	Serialization constructor for CogPMRedLineResults object.

Top

Methods

	Name	Description
	Contains	Determines whether an element is in the collection. (Inherited from CogReadOnlyCollectionWithCustomSerialization T .)
	CopyTo	Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CogReadOnlyCollectionWithCustomSerialization T .)
	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	Releases all resources used by this CogPMRedLineResults object.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Releases all unmanaged resources used by this CogPMRedLineResults object. (Overrides Object Finalize .)
	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	Populates the provided SerializationInfo with the data needed to serialize the object. (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
	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 )	Causes the list of items to show up in the property grid. (Inherited from CogReadOnlyCollectionWithCustomSerialization 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	Searches the collection for the specified object and returns the zero-based index of the first occurrence. (Inherited from CogReadOnlyCollectionWithCustomSerialization T .)
	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.)
	ToArray	Calls CopyTo() and returns a new array which contains the members of this collection. (Inherited from CogReadOnlyCollectionWithCustomSerialization T .)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	mInnerList	(Inherited from CogReadOnlyCollectionWithCustomSerialization T .)

Top

Properties

	Name	Description
	AcceptedCount	Gets the number of results in this collection that have their Accepted property set to "true".
	Count	The number of elements contained in the Collection. (Inherited from CogReadOnlyCollectionWithCustomSerialization T .)
	Item	Gets the element at the specified index. (Inherited from CogReadOnlyCollectionWithCustomSerialization T .)

Top

Remarks

An instance of this class is returned by the Execute(ICogImage, ICogRegion, CogPMRedLineRunParams) method of the CogPMRedLinePattern class. The Execute() method is called automatically every time you call the Run method of the CogPMRedLineTool class, causing the tool to search the InputImage for instances of the pattern.