2.2.4.38.24 Project::GetDatasetPlotList

GetDatasetPlotList

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

Description

find all the graphing layers where the named dataset is used to construct a plot

Syntax

int GetDatasetPlotList( LPCSTR lpcszDatasetName, vector<string> & vsGraphNames = NULL, vector<int> & vnLayers = NULL, vector<int> & vnPlotDesignations = NULL, BOOL bExcluldeModifiers = false )

Parameters

lpcszDatasetName: [input] Dataset name, like Book1_B
vsGraphNames: [input] short names of all the graphs that the dataset is used
vnLayers: [input] corresponding layer index (0 offset) for each of the graphs in vsGraphNames
vnPlotDesignations: [output] corresponding plot designations, COLDESIG_X, COLDESIG_Y, COLDESIG_SIZE, etc for each of the graphs in vsGraphNames and vnLayers
bExcluldeModifiers: to exclude modifiers like COLDESIG_SIZE, COLDESIG_COLOR, so only X, Y, Z, Error, Labels will be considered part of a plot

Return

number of graph layers this dataset is used

Examples

EX1

//Output the specified Dataset's GraphName, Layer, and designation.
//You can Call this function using synax: "Project_GetDatasetPlotList_ex1("Book2_b")"
void Project_GetDatasetPlotList_ex1(string str)
{
    vector<string> vsGraphNames;
    vector<int> vnLayers;
    vector<int> vnPlotDesignations;
    
    int nn= Project.GetDatasetPlotList(str, vsGraphNames, vnLayers, vnPlotDesignations);
    if(nn < 0)
    {
        printf("%s not a valid dataset\n", str);
        return;
    }
    if(nn == 0)
    {
        printf("%s not in any plot\n", str);
        return;
    }        
    
    for(int ii = 0; ii < nn; ii++)
    {
        char szTemp[NAME_SIZE];
        if(!get_plot_designation_str(vnPlotDesignations[ii], szTemp, NAME_SIZE))
            lstrcpy(szTemp, "Unknown");

        printf("%s : layer = %d, designation=%s\n", vsGraphNames[ii], vnLayers[ii], szTemp);
    }
}