This class provides easy access to line-level properties and methods of the CogOCVMaxPattern object. With this class you can navigate amongst all of the lines within a single paragraph. You may NOT directly construct this object. Instead, use the CreateLineIterator method on either the containing paragraph's iterator or on the top level CogOCVMaxPattern object. Also note that this class can not be persistedo.
Inheritance Hierarchy
Cognex.VisionPro.OCVMax CogOCVMaxLineIterator
Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 75.0.0.0
Syntax
The CogOCVMaxLineIterator type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Copy | Return a newly created line iterator that is functionally identical to this one - it will have the same line position within the same enclosing paragraph. |
| Copy(Int32) | Return a newly created line iterator corresponding to the specified line position within the same enclosing paragraph as this line iterator. The argument is a positional offset from the current line position, so a value of zero will yield a new line iterator that is functionally identical to this one. |
| CreateCharacterIterator | Return a newly created character iterator corresponding to the initial character position of this line. |
| CreateParagraphIterator | Return a newly created paragraph iterator corresponding to the containing paragraph. This provides access to this line iterator's parent. |
| Equals | (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.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MoveToNext | Move the line iterator to the next line position within the containing paragraph. If the iterator is already at the end position before this call, MoveToNext generates an exception. You may wish to check the IsEnd property before calling MoveToNext in order to avoid errors. |
| MoveToPosition | Move the line iterator to the specified position within the containing paragraph. If the argument is zero, move to the first line position in the paragraph. If the argument is -1, move to the end line position in the paragraph. An exception is generated if the argument is not valid. |
| MoveToPrevious | Move the line iterator to the previous line position within the containing paragraph. If the iterator is already at the initial position before this call, MoveToPrevious generates an exception. You may wish to check the IsFirst property before calling MoveToPrevious in order to avoid errors. |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | CharacterCount | The number of characters currently contained in the line referenced by this iterator. |
| IsEnd | Whether or not this iterator is positioned past the last line in the containing paragraph. |
| IsFirst | Whether or not this line position is the initial line position within the containing paragraph. |
| IsInvalid | Whether or not this iterator is NOT positioned at a valid line. If true, attempting to access line-level properties or methods will produce an error. |
| ParagraphPosition | Indicates the relative position of the containing paragraph within the CogOCVMaxPattern object. Numbering is zero based, so a value of zero indicates that this line resides in the initial paragraph of the CogOCVMaxPattern object. |
| Position | Indicates the relative position of this line within the containing paragraph. Numbering is zero based, so a value of zero indicates that this is the initial line of the containing paragraph. |
See Also