2.1 Input Routines

2.1.1 Setup

• SDDS_InitializeInput — Opens a file and initializes the SDDS_TABLE structure used to access the data set.
• SDDS_InitializeHeaderlessInput — Opens a file and initializes the SDDS_TABLE structure used to access the data set, but does not attempt to read the header, which is assumed not to exist. The caller must define the header using the SDDS_Define X routines. This method of using SDDS is not recommended, as it defeats the purpose of having a self-describing data set by imbedding the description in a program.
• SDDS_ReadTable — Reads the next data table from a data set.

2.1.2 Determining File Contents

• SDDS_GetArrayInformation — Returns information about the fields of an array definition. This is the preferred way to get this information.
• SDDS_GetColumnInformation — Returns information about the fields of a column definition. This is the preferred way to get this information.
• SDDS_GetParameterInformation — Returns information about the fields of a parameter definition. This is the preferred way to get this information.
• Other routines:
  • SDDS_GetArrayDefinition — Returns a pointer to the ARRAY_DEFINITION structure for a named array.
  • SDDS_GetArrayNames — Returns a pointer to an array of strings giving the names of all arrays.
  • SDDS_GetArrayIndex — Returns the index of a named array in the table structure. This can be used for fast access to the data.
  • SDDS_GetArrayType — Returns the data type of a named array in the table structure.
  • SDDS_GetColumnDefinition — Returns a pointer to the COLUMN_DEFINITION structure for a named column.
  • SDDS_GetColumnNames — Returns a pointer to an array of strings giving the names of all columns.
  • SDDS_GetColumnIndex — Returns the index of a named column in the table structure. This can be used for fast access to the data.
  • SDDS_GetColumnType — Returns the data type of a named column in the table structure.
  • SDDS_GetParameterDefinition — Returns a pointer to the PARAMETER_DEFINITION structure for a named parameter.
  • SDDS_GetParameterNames — Returns a pointer to an array of strings giving the names of all parameters.
  • SDDS_GetParameterIndex — Returns the index of a named parameter in the table structure. This can be used for fast access to the data.
  • SDDS_GetParameterType — Returns the data type of a named parameter in the table structure.
  • SDDS_VerifyArrayExists — Returns the index of a named array if it exists as the specified data type.
  • SDDS_VerifyColumnExists — Returns the index of a named column if it exists as the specified data type.
  • SDDS_VerifyParameterExists — Returns the index of a named Parameter if it exists as the specified data type.

2.1.3 Column Selection

• SDDS_SetColumnFlags — Sets all column-selection flags to a given value, indicating whether columns are initially “of interest” or not). By default, all columns are initially of interest.
• SDDS_SetColumnsOfInterest — Modifies the “of interest” status of columns using lists of column names, wildcard matching, and so forth. General two-term logic is possible using the previous status of each column and the results of newly-requested matching.
• SDDS_DeleteColumn — Deletes a named column from the current data table of a data set.
• SDDS_DeleteUnsetColumns — Deletes all “unset” columns–i.e., those not declared as “of interest”.

2.1.4 Row Selection

• SDDS_SetRowFlags — Set all row-selection flags to a given value, indicating whether all rows are initially “of interest” or not. By default, all rows are initially of interest.
• SDDS_SetRowsOfInterest — Modifies row-selection flags based on string matching to the data in a named column, with general two-term logic supported using the previous status of each row and the results of the newly-requested matching.
• SDDS_FilterRowsOfInterest — Modifies row-selection flags based on whether the numeric entries in a named column are within a specified interval, with general two-term logic supported using the previous status of each row and the results of the newly-requested matching.
• SDDS_CountRowsOfInterest — Counts the number of rows in the current data table that are currently “of interest”, i.e., those with non-zero row-selection flags.
• SDDS_DeleteUnsetRows — Deletes all rows of the current data table that are not currently of interest.

2.1.5 Access to Tabular Data

• SDDS_GetColumn — Returns a pointer to an array of data values from a single column of the tabular portion of the current data table. Only rows that are “of interest” are returned.
• SDDS_GetColumnInDoubles — Returns a pointer to an array of doubles containing the numeric data values (converted to double if necessary) from a single column of the tabular portion of the current data table. Only rows that are “of interest” are returned.
• SDDS_GetMatrixFromColumn — Returns a pointer to a two-dimensional array of data values from a single column of the tabular portion of the current data table. Only rows that are “of interest” are included. The dimensions of the array are supplied by the caller (from parameters stored in the data set, for example).
• SDDS_GetMatrixOfRows — Returns a pointer to a two-dimensional array of data values from the rows and columns “of interest”. The columns are ordered as defined by calls to SDDS_SetColumnsOfInterest, and must have the same data type.
• SDDS_GetRow — Returns a pointer to a single row containing data values from the columns “of interest”. Only the rows “of interest” are returned. The columns are ordered as defined by calls to SDDS_SetColumnsOfInterest, and must have the same data type.
• SDDS_GetValue — Returns a pointer to a single value from the tabular data. The data is requested by giving the column name and the row number. Only values from the rows “of interest” are returned.

2.1.6 Access to Array Data

• SDDS_GetArray — Returns a pointer to an SDDS_ARRAY structure containing the current data and other information for a named array of a data set.

2.1.7 Access to Parameter Data

• SDDS_GetParameter — Returns a pointer to the current value of a named parameter of a data set.