Column::IsEvenSampling

IsEvenSampling

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Include

Description

Check if the column has even sampling and get the sampling information.

Syntax

BOOL IsEvenSampling( double * px0 = NULL, double * pxInc = NULL, string * pStrXUnits = NULL, string * pStrXLongName = NULL )

Parameters

px0: [output] an optional pointer to a double that will receive the starting X value.
pxInc: [output] an optional pointer to a double that will receive the X increment value.
pStrXUnits: [output] an optional pointer to a String that will receive the X units name.
pStrXLongName: [output] an optional pointer to a String that will receive the X long name.

Return

TRUE if column is even sampling, FALSE otherwise.

Examples

EX1

void Column_IsEvenSampling_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    Column col = wks.Columns(0);

    double dX0, dXInc;
    string strXUnits, strXLongName;
    if( col.IsEvenSampling(&dX0, &dXInc, strXUnits, strXLongName) )
    {
        printf("Column %s is even sampling.\n", col.GetName());
        printf("Start == %f\nIncrement == %f\nUnits == %s\nLong Name == %s\n",
            dX0, dXInc, strXUnits, strXLongName);
    }
    else
        printf("Column %s is not even sampling.\n", col.GetName());
}