ILSortable Interface Reference

This interface represent a sortable LPV class. More...

Inheritance diagram for ILSortable:

Public Member Functions
double	GetPosX (LPVPositionMode posMode)
double	GetPosY (LPVPositionMode posMode)
double	GetScore ()

Properties
int	Index [get, set]

Detailed Description

This interface represent a sortable LPV class.

You could sort the collections of sortable classes using LSorter. The result index of sorting is set via Index.

The following lists some sortable LPV classes:

LPVCoreLib	LRectRegion, LRotRectRegion, LCircleRegion, LPolyRegion, LMaskRegion, LAnnulusRegion, LEllipseRegion, LAnnulusSectorRegion LCompoundRegion
LPVGeomLib	LPoint, LPoints, LCircle, LLine, LPolygon, LRect, LEllipse, LArc
LPVPatLib	LMatchResult, LMatchResults
LPVBlobLib	LBlob, LBlobResults
LPVLocateLib	LLineResult, LCircleResult
LPVLocateXLib	LPathResult, LContourResult
LPVGaugeLib	LShapeGaugeResult
LPVMathLib	LDataList
LPVBarcodeLib	LBarcodeResult
LPVOCRLib	LOCRChar, LOCRLine, LOCRResult

Example Code

C++

std::vector<ILSortable*> regionsSortables;
// add sortable regions to the collection
for (ILRegionPtr& region : regions) {
    regionsSortables.push_back(ILSortable::Cast(region));
}
ILSorterPtr sorter = LSorter::Create();
sorter->RowSpace = 170;
sorter->ColumnSpace = 150;
sorter->ToleranceFactor = 1;
sorter->PositionMode = LPVPositionMode::LPVPosModeCenter;
// sort into an array
ILSortedArrayPtr sortedArray;
LPVErrorCode err = sorter->SortToArray2(regionsSortables, &sortedArray);

C#

List<ILRegion> regions = new List<ILRegion>();
// ... add sortable regions to the collection
LSorter sorter = new LSorter();
sorter.RowSpace = 170;
sorter.ColumnSpace = 150;
sorter.ToleranceFactor = 1;
sorter.PositionMode = LPVPositionMode.LPVPosModeCenter;
// sort into an array
LSortedArray sortedArray;
LPVErrorCode err = sorter.SortToArray2(regions.ToArray(), out sortedArray);

COM

CComSafeArray<IDispatch*> regions;
// ... add sortable regions to the collection
ILSorterPtr sorter = LSorter::Create();
// or, ILSorterPtr sorter(__uuidof(LSorter)), for absence of built-in Create functions (before 2.2.0)
sorter->RowSpace = 170;
sorter->ColumnSpace = 150;
sorter->ToleranceFactor = 1;
sorter->PositionMode = LPVPositionMode::LPVPosModeCenter;
// sort into an array
ILSortedArrayPtr sortedArray;
LPVErrorCode err = sorter->SortToArray2(regions, &sortedArray);

Member Function Documentation

GetPosX()

double GetPosX

(

LPVPositionMode

posMode

)

The x-coordinate of the object's position, used for x-related sorting like LPVSortByX, LPVSortByColumn, etc.

Parameters

[in]

posMode

Specify the position mode, by default, it's using the center point.

GetPosY()

double GetPosY

(

LPVPositionMode

posMode

)

The y-coordinate of the object's position, used for y-related sorting like LPVSortByY, LPVSortByColumn, etc.

Parameters

[in]

posMode

Specify the position mode, by default, it's using the center point.

GetScore()

double GetScore

(

)

The score of the object, used for score sorting, aka. LPVSortByScore

Property Documentation

Index

int Index

getset

The index of the object