Next Page: Definition of SDDS Protocol

Application Programmer's Guide for SDDS Version 1

Michael Borland
Advanced Photon Source

Mon Jan 10 14:49:16 CST 1994

SDDS is a file protocol for Self Describing Data Sets. This document describes Version 1 of the SDDS protocol and the function library that supports it. It is intended for those who wish to develop programs that use SDDS files.

• Definition of SDDS Protocol
  • Structure of the SDDS Header
    • Data Set Description
    • Tabular-Data Column Definition
    • Parameter Definition
    • Array Data Definition
    • Associate File Definition
    • Header File Include Specification
    • Data Mode and Arrangement Defintion
  • Structure of SDDS ASCII Data Tables
• Overview of Library Routines
  • Input Routines
    • Setup
    • Determining File Contents
    • Column Selection
    • Row Selection
    • Access to Tabular Data
    • Access to Array Data
    • Access to Parameter Data
  • Output Routines
    • Setup
    • Defining Data Set Elements
    • Defining Data Table Contents
    • Output
  • Error Handling and Utilities
• Two Templates for SDDS Application Organization
  • Accessing Data Stored in a SDDS File
  • SDDS Output of Internally-Generated Data
• Commandline Tools for Use with SDDS Files
• Site Specific Details
• References
• Manual Pages
  • SDDS_CastValue
  • SDDS_ClearErrors
  • SDDS_ConvertToDouble
  • SDDS_CopyTable
  • SDDS_CountRowsOfInterest
  • SDDS_DefineArray
  • SDDS_DefineAssociate
  • SDDS_DefineColumn
  • SDDS_DefineParameter
  • SDDS_DeleteColumn
  • SDDS_DeleteUnsetColumns
  • SDDS_DeleteUnsetRows
  • SDDS_FilterRowsOfInterest
  • SDDS_GetArray
  • SDDS_GetArrayDefinition
  • SDDS_GetArrayIndex
  • SDDS_GetArrayInformation
  • SDDS_GetArrayNames
  • SDDS_GetArrayType
  • SDDS_GetAssociateDefinition
  • SDDS_GetAssociateInformation
  • SDDS_GetAssociateNames
  • SDDS_GetColumn
  • SDDS_GetColumnDefinition
  • SDDS_GetColumnInDoubles
  • SDDS_GetColumnIndex
  • SDDS_GetColumnInformation
  • SDDS_GetColumnNames
  • SDDS_GetColumnType
  • SDDS_GetMatrixFromColumn
  • SDDS_GetMatrixOfRows
  • SDDS_GetParameter
  • SDDS_GetParameterDefinition
  • SDDS_GetParameterIndex
  • SDDS_GetParameterInformation
  • SDDS_GetParameterNames
  • SDDS_GetParameterType
  • SDDS_GetRow
  • SDDS_GetTypeSize
  • SDDS_GetValue
  • SDDS_InitializeCopy
  • SDDS_InitializeHeaderlessInput
  • SDDS_InitializeInput
  • SDDS_InitializeOutput
  • SDDS_Logic
  • SDDS_NumberOfErrors
  • SDDS_PrintErrors
  • SDDS_PrintTypedValue
  • SDDS_ReadTable
  • SDDS_SetArray
  • SDDS_SetColumnFlags
  • SDDS_SetColumnsOfInterest
  • SDDS_SetParameters
  • SDDS_SetRowFlags
  • SDDS_SetRowsOfInterest
  • SDDS_SetRowValues
  • SDDS_StartTable
  • SDDS_Terminate
  • SDDS_WriteLayout
  • SDDS_WriteTable
• About this document ...