2.2.4.5.29 Column::GetType

Description

Get the type designator of a column (X, Y, Z, YErr, XErr, L or disregard).

Syntax

int GetType( )

Parameters

Return

The column type enum {OKDATAOBJ_DESIGNATION_Y = 0,

OKDATAOBJ_DESIGNATION_NONE,

OKDATAOBJ_DESIGNATION_ERROR,

OKDATAOBJ_DESIGNATION_X,

OKDATAOBJ_DESIGNATION_L,

OKDATAOBJ_DESIGNATION_Z,

OKDATAOBJ_DESIGNATION_X_ERROR};

Examples

EX1

// Assume a worksheet exists in the project
void    Column_GetType_Ex1()
{
    WorksheetPage wp = Project.WorksheetPages(0);
    if(!wp)
        return;
    
    Worksheet wks(wp.GetName());
    for(int ii = 0 ; ii < wks.GetNumCols() ; ii++)
    {
        printf("Column %u type is %u\n", ii + 1, wks.Columns(ii).GetType());
    }
}

Remark

Get the type designator of a column (Y, disregard, Y Err, X, Label, Z or X Err).

See Also

Column::SetType, Worksheet::GetColDesignations, Worksheet::SetColDesignations

Header to Include

origin.h