LArray Class Reference

Detailed Description

An array of numeric values (integer, double, etc.), or LPV objects. The array is resolved as the following in different languages APIs.

Input Parameter

C++

// boolean
void Function(... const std::vector<bool>& x, ...);
// integer
void Function(... const std::vector<int>& x, ...);
// double
void Function(... const std::vector<double>& x, ...);
// LPV object, for example: LImage
void Function(... const std::vector<ILImagePtr>& x, ...);

C#

// for all types, either boolean, integer, double, or LPV objects
void Function(... System.Array x, ...);

COM

// for all types, either boolean, integer, double, or LPV objects
void Function(... SAFEARRAY* x, ...);

Output Parameter

C++

// boolean
void Function(... std::vector<bool>& x, ...);
// integer
void Function(... std::vector<int>& x, ...);
// double
void Function(... std::vector<double>& x, ...);
// LPV object, for example: LImage
void Function(... std::vector<ILImagePtr>& x, ...);

C#

// for all types, either boolean, integer, double, or LPV objects
void Function(... out System.Array x, ...);

COM

// for all types, either boolean, integer, double, or LPV objects
void Function(... SAFEARRAY** x, ...);

Return Value

C++

// boolean
std::vector<bool> Function(...);
// integer
std::vector<int> Function(...);
// double
std::vector<double> Function(...);
// LPV object, for example: LImage
std::vector<ILImagePtr> Function(...);

C#

// for all types, either boolean, integer, double, or LPV objects
System.Array Function(...);

COM

// for all types, either boolean, integer, double, or LPV objects
SAFEARRAY* Function(...);

Example Code

C++

// input double array
std::vector<double> xs = { 0, 1, 2 };
std::vector<double> ys = { 3, 4, 5 };
polyRegion->SetPlacement(xs, ys);
 
// output double array
std::vector<double> xs2, ys2;
points->GetPoints(xs2, ys2);
 
// input image array
std::vector<ILImagePtr> imgs = { img1, img2 };
imglist->Adds(imgs);
 
// output polygon array
std::vector<ILPolygonPtr> polys = polyClipper->Union(poly1, poly2);
for (ILPolygonPtr poly : polys) {
    // handle each polygon object ...
}

C#

// input double array
double[] xs = new double[] { 0, 1, 2 };
double[] ys = new double[] { 3, 4, 5 };
polyRegion.SetPlacement(xs, ys);
 
// output double array
Array xArr, yArr;
points->GetPoints(xArr, yArr);
// convert to double[]
double[] xs2 = xArr.OfType<double>().ToArray();
double[] ys2 = yArr.OfType<double>().ToArray();
 
// input image array
LImage[] imgs = new LImage[] { img1, img2 };
imglist.Adds(imgs);
 
// output polygon array
Array polys = polyClipper.Union(poly1, poly2);
foreach (LPolygon poly in polys) {
    // handle each polygon object ...
}

COM

// input double array
CComSafeArray<double> xs, ys;
xs.Add(0); xs.Add(1); xs.Add(2);
ys.Add(3); ys.Add(4); ys.Add(5);
polyRegion->SetPlacement(xs, ys);
 
// output double array
SAFEARRAY* xArr = NULL;
SAFEARRAY* yArr = NULL;
points->GetPoints(&xArr, &yArr);
CComSafeArray<double> xs2, yx2;
if (xArr) xs2.Attach(xArr);
if (yArr) ys2.Attach(yArr);
 
// input image array
CComSafeArray<IDispatch*> imgs;
imgs.Add(img1); imgs.Add(img2);
imglist->Adds(imgs);
 
// output polygon array
SAFEARRAY* polyArr = polyClipper->Union(poly1, poly2);
if (polyArr) {
   CComSafeArray<IDispatch*> polys;
   polys.Attach(polyArr);
   for (int i = 0; i < polys.GetCount(); ++i) {
       ILPolygonPtr poly = polys.GetAt(i).p;
       // handle each polygon object ...
   }
}