XMM-Newton Science Analysis System


dal (dal-1.199) [xmmsas_20230412_1735-21.0.0]

C API

C interface definition for DAL

Pointers rather than handles. No default values.

typedef enum Read = 1, Create, Modify, Temp, AsParent AccessMode; typedef enum High = 1, HighLow, Low, UseEnvironment MemoryModel; /*typedef enum Bool = 1, Int8, Uint16, Int16, Uint32, Int32, Real32, Real64, DString DataType; */ typedef enum TableType = 1, ArrayType BlockType; typedef enum EraseAllFirst = 1, Merge CopyMode; typedef enum Fixed = 1, Variable CellType; typedef void Array; typedef void Block; typedef void Column; typedef void DataSet; typedef void Table; typedef void SubTable; typedef void Row; typedef void Attribute; typedef void Attributable; typedef void Labelled; typedef void DataComponent; typedef void * TableIteratorFunction; /* typedef void(*TableIteratorFunction)( Table * ); */

• NAME
  addArray( dataSet, name, dataType, numberofDimensions, dimensions, units, label, position ); PURPOSE
  Create and add an array to a dataset.
• ARGUMENTS
  • DataSet * dataSet
    A pointer to the dataset which the new array is to be added.
  • const char * name
    The name of the new array.
  • DataType dataType
    The type of the data. It must be one of the values: Int8, Int16, Int32, Real32, Real64.
  • int numberOfDimensions
    The number of dimensions of the array. This must be in the range 1 <= numberOfDimensions <= 3.
  • unsigned long * dimensions
    A vector with numberOfDimensions elements. Each element describes the size along each dimension, of the array, respectively.
  • const char * units
    The units of the array.
  • const char * label
    A short description (i.e. a user defined comment) to be attached to the array.
  • int position
    The ordinal position, within the dataset, which the new array will occupy.
• RETURNS
  • Array *
    A pointer to the newly created array.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  String and Boolean types are not supported.

• NAME
  addColumn( table, name, dataType, units, label, numberofDimensions, dimensions, position ) PURPOSE
  Create and add a column to a table.
• ARGUMENTS
  • Table * table
    A pointer to the table to which the new column will be added.
  • const char * name
    The name of the new column.
  • DataType dataType
    The data type of the new column. It can be any of the values in the enumeration type DataType.
  • const char * units
    The units of the column.
  • const char * label
    A short description (i.e. a user-defined comment) of the column.
  • int numberofDimensions
    The number of dimensions of the column.
  • const unsigned long * dimensions
    The size along each dimension of the column.
  • int position
    The ordinal position wihtin the table which the new column will occupy.
• RETURNS
  • Column *
    A pointer to the new column.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  addCommentTo<type>( object, comment ) PURPOSE
  Add a comment record to an object.
• ARGUMENTS
  • type * object
    A pointer to the object to which the comment is to be added. The supported types are: Array, Attributable, Block, DataSet, Table
  • const char * comment
    The comment which is to be to be added to the object.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  addHistoryTo<type>( object, history ) PURPOSE
  Add a history record to an object.
• ARGUMENTS
  • type * object
    A pointer to the object to which the history record is to be added. The supported types are: Array, Attributable, Block, DataSet, Table
  • char * history
    The history record which is to be to be added to the object.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  addTable( dataSet, name, numberOfRows, label, position ) PURPOSE
  Create and add a table to a dataset.
• ARGUMENTS
  • DataSet * dataSet
    A handle of the dataset to which the new table is to be added.
  • char * name
    The name of the new table.
  • int numberOfRows
    The nmber of rows of the new table.
  • const char * label
    A short textual description (i.e. user-defined comment) to be attached to the table.
  • int position
    The ordinal position of the new table within the dataset.
• RETURNS
  • Table *
    A pointer to the newly created table.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>AttributeComment( object, name ) PURPOSE
  Get the comment associated with an attribute, from an attributable object.
• ARGUMENTS
  • const type * object
    The object containing the attribute. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • const char * name
    The name of the attribute.
• RETURNS
  • const char *
    A pointer to the comment.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>AttributeUnits( object, name ) PURPOSE
  Get the comment associated with an attribute, from an attributable object.
• ARGUMENTS
  • const type * object
    The object containing the attribute. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • const char * name
    The name of the attribute.
• RETURNS
  • const char *
    A pointer to the units.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>AttributeWithName( object, name ) PURPOSE
  Get an attribute from an attributable object.
• ARGUMENTS
  • const type * object
    A pointer to the object which contains the required attribute. Supported types are: Array, Attributable, Block, Column, DataSet, Table
  • const char * name
    The name of the required attribute.
• RETURNS
  • Attribute *
    A pointer to the required attribute.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  arrayDataType( array ) PURPOSE
  Get the type of an array.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • DataType
    The type of the array. It will be one of the values: Int8, Int16, Int32, Real32, Real64.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  bool8 <type>HasAttribute( attributable, name ) PURPOSE
  Determine if an attributable object contains an attribute with a given name.
• ARGUMENTS
  • const <type> * attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • const char * name
    The name of an attribute.
• RETURNS
  • bool8
    Returns true if an attribute with the given name was found, otherwise falise is returned.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>Label( object ) PURPOSE
  Get the label associated with an object.
• ARGUMENTS
  • const <type> * object
    A pointer to an object. Supported types are: Array, Block, Column.
• RETURNS
  • const char *
    A pointer to the array's label.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>ToAttributable( attributable ) PURPOSE
  Convert an attributable object to the Attributable type.
• ARGUMENTS
  • <type> * attributable
    A pointer to the attributable object to be converted. Supported types are: Array, Block, Column, DataSet, Table.
• RETURNS
  • Attributable * A pointer to Attributable.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  arrayUnits( array ) PURPOSE
  Get the units associated with an array.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • const char *
    A pointer to the array's units.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  arrayWithName( dataSet, name ) PURPOSE
  Get the array with a given name from a dataset.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the data set which contains the required array.
  • const char * name
    The name of the required array.
• RETURNS
  • Array *
    A pointer to the array.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  Array * arrayWithNumber( dataSet, position ) PURPOSE
  Get the array with a given ordinal position from a dataset.
• ARGUMENTS
  • const DataSet * dataSet,
    A pointer to the data set which contains the required array.
  • unsigned int position
    The ordinal position of the required array.
• RETURNS
  • Array *
    A pointer to the array.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  attributeDataType( attribute ) PURPOSE
  Get the type of an attribute.
• ARGUMENTS
  • Attribute * attribute
    A pointer to the attribute.
• RETURNS
  • DataType
    The data type of the attribute.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  attributeLabel( attribute ) PURPOSE
  Get the label associated with an attribute.
• ARGUMENTS
  • const Attribute * attribute
    A pointer to the attribute.
• RETURNS
  • const char *
    A pointer to the attribute's label.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  attributeUnits( attribute ) PURPOSE
  Get the units associated with an attribute.
• ARGUMENTS
  • const Attribute * attribute
    A pointer to the attribute.
• RETURNS
  • const char *
    Get the units associated with an attribute.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  blockNumber( dataSet, name ) PURPOSE
  Get the number of a block (ordinal position within it's dataset) with a given name.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the dataset containing the block with the given name.
  • const char * name
    The name of the block.
• RETURNS
  • unsigned int
    The ordinal position of the blockj within the dataset.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  blockType( block ) PURPOSE
  Get the type of a block.
• ARGUMENTS
  • const Block * block
    A pointer to the block.
• RETURNS
  • BlockType
    The block type.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  blockWithName( dataSet, name ) PURPOSE
  Get a block with a given name from a dataset.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the dataset containing the required block.
  • const char * name
    The name of the required block.
• RETURNS
  • Block *
    A pointer to the block.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  blockWithNumber( dataSet, position ) PURPOSE
  Get a block with a given number (ordinal position) from a dataset.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the dataset containing the required block.
  • int position
    The ordinal position of the block within the dataset.
• RETURNS
  • Block *
    A pointer to the block.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type><attributable>Attribute( object, name ); PURPOSE
  Get the value of an attribute contained in an attributable object.
• ARGUMENTS
  • const <attributable> * object
    A pointer to the attributable object containing the required attribute. Supported types are: Array, Attributable, Block, Column, DataSet, and Table.
  • const char * name
    The name of the required attribute.
• RETURNS
  • <type>
    Supported types are: bool, int8, int16, int32, real32, real64, string
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>ArrayData( array ) PURPOSE
  Get the data from an array.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • <type> *
    A pointer to the data of the appropriate type.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>Attribute( attribute ) PURPOSE
  Get an attribute's data.
• ARGUMENTS
  • const Attribute * attribute
    A pointer to the attribute.
• RETURNS
  • <type>
    A value of the appropriate type. Supported types are Bool, Inter, Real, String.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>CellData( column, rowNumber ) PURPOSE
  Get the data from a cell in a variable length column.
• ARGUMENTS
  • const Column * column
    A pointer to the variable length column.
  • unsigned long rowNumber
    The number of the column cell to be accessed.
• RETURNS
  • <type> * A pointer, of the appropriate type, to the data. Supported types are: Bool, Int8, Int16, Int32, Real32, Real64, String.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  <type>ColumnData( column ) PURPOSE
  Get the data from a fixed length column.
• ARGUMENTS
  • const Column * column
    A pointer to the fixed length column.
• RETURNS
  • <type> * A pointer, of the appropriate type, to the column's data. Supported types are: Bool, Int8, Int16, Int32, Real32, Real64, String.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  int cellSize( column, rowNumber ) PURPOSE
  Get the size of a cell in a variable-length column.
• ARGUMENTS
  • Column * column
    A pointer to the variable-length column.
  • int rowNumber
    The cell number.
• RETURNS
  • int
    The size of the cell in bytes.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  cellType( column ) PURPOSE
  Get the cell-type of a column.
• ARGUMENTS
  • Column * column
    A pointer to the cell.
• RETURNS
  • CellType
    
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  clobber() PURPOSE
  Get the clobber setting.
• ARGUMENTS
• RETURNS
  • bool8
    
• DESCRIPTION
  The clobber setting is determined by the environment variable SAS_CLOBBER.
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  unsigned long columnDataIndex( column, rowNumber, numberOfDimensions, dimensions ) PURPOSE
  Get the memory offset of a column's row.
• ARGUMENTS
  • const Column * column
    
  • unsigned long rowNumber
    
  • unsigned int numberOfDimensions
    
  • const unsigned long * dimensions
    
• RETURNS
  • unsigned long
    The omemory offset.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  columnDataType( column ) PURPOSE
  Get the data type of a column.
• ARGUMENTS
  • const Column * column
    A pointer to the column.
• RETURNS
  • DataType
    
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  columnNumber( table, name ) PURPOSE
  Get the number of a column with a given name (i.e. the ordinal position of the column with it's table).
• ARGUMENTS
  • const Table * table
    A pointer to the table containing the required column.
  • const char * name
    The name of the required column.
• RETURNS
  • int The ordinal position of the column within the given table.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  columnUnits( column ) PURPOSE
  Get the units associated with a column.
• ARGUMENTS
  • const Column * column
    A pointer to the column.
• RETURNS
  • const char *
    A pointer to the column's units.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  columnWithName( table, name ) PURPOSE
  Get a column with the given name from a table.
• ARGUMENTS
  • const Table * table
    A pointer to the table containing the required column.
  • const char * name
    The name of the required column.
• RETURNS
  • Column *
    A pointer to the column.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  columnWithNumber( table, position ) PURPOSE
  Get the column with the given ordinal position from a table.
• ARGUMENTS
  • const Table * table
    A pointer to the table containing the required column.
  • unsigned int position
    The ordinal position of the required column.
• RETURNS
  • Column *
    A pointer to the column.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  const char * commentOf<object>( attributable, number) PURPOSE
  Get a comment record from an attributable object.
• ARGUMENTS
  • <object> attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet and Table.
  • unsigned int number
    The ordinal number of the comment record to be retrieved.
• RETURNS
  • const char *
    A pointer to the comment record.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  copyAttributesOf<object>( to, from, copyMode ) PURPOSE
  
• ARGUMENTS
  • <object> * to
    A pointer to the destination object.
  • const <object> * from
    A pointer to the source object.
  • CopyMode copyMode
    The mode to be used for the copy.
• RETURNS
  void
• DESCRIPTION
  Supported types are: Array, Block, Column, DataSet, Table
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  The source and destination must be of the same attributable type.

• NAME
  copyAttributeTo<object>( attributable, attribute ) PURPOSE
  Copy an attribute to an attributable object.
• ARGUMENTS
  • <object> * attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • const Attribute * attribute
    
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  copyRows( table, from, to, count ) PURPOSE
  Copy rows in a table.
• ARGUMENTS
  • Table * table
    A pointer to the table within which the rows are to be copied.
  • unsigned int from
    The row number (starting at 0) from which to begin the copying.
  • unsigned int to
    The row number (starting at 0) to which to begin the copying.
  • unsigned int count
    The number of rows to copy.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  dataServerClient( clientName ) PURPOSE
  Set the name of the dataset server client.
• ARGUMENTS
  • const char * clientName
    
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  DataSet * dataSet( dataSetName, openMode, memoryModel ) PURPOSE
  Open a dataset.
• ARGUMENTS
  • const char * dataSetName
    
  • AccessMode openMode
    
  • MemoryModel memoryModel
    
• RETURNS
  • DataSet *
    A pointer to the dataset.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  dataSetHasBlock( dataSet, name) PURPOSE
  Determine if a dataset has a block with the given name.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the dataset.
  • const char * name
    The name of the desired block.
• RETURNS
  • bool8
    Returns true if a block with the given name was found in the specified dataset, otherwise false is returned.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  delete<type>AttributeWithName( attributable, name ) PURPOSE
  Delete the named attribute from an attributable object.
• ARGUMENTS
  • <type> * attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • const char * name
    The name of the attribute to delete.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  delete<type>AttributeWithNumber( attributable, number ) PURPOSE
  Delete the attribute with the given ordimal position from an attributable object.
• ARGUMENTS
  • <type> * attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • unsigned int number
    The ordinal position of the attribute to delete.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  deleteAttribute( attribute ) PURPOSE
  Delete the given attribute.
• ARGUMENTS
  • const Attribute * attribute
    A pointer to the attribute to be deleted.
• RETURNS
  void
• DESCRIPTION
  The attribute is deleted from it's parent attributable.
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  deleteBlockWithName( dataSet, name ) PURPOSE
  Delete the block with the given name from the specified dataset.
• ARGUMENTS
  • DataSet * dataSet
    A pointer to the dataset containing the block to be deleted.
  • const char * name
    The name of the block to be deleted.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  deleteBlockWithNumber( dataSet, position ) PURPOSE
  Delete the block with the specified ordinal position from the given dataset.
• ARGUMENTS
  • DataSet * dataSet
    
  • unsigned int position
    
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  deleteColumnWithName( table, name ) PURPOSE
  Delete the column with the specified name from the given table.
• ARGUMENTS
  • Table * table
    A pointer to the table containing the column to be deleted.
  • const char * name
    The name of the column to delete.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  deleteColumnWithNumber( table, position ) PURPOSE
  Delete the column with the specified ordinal position from the given table.
• ARGUMENTS
  • Table * table
    A pointer to the table containing the column to be deleted.
  • unsigned int position
    The ordinal position of the column to be deleted.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  deleteRows( table, from, count ) PURPOSE
  Delete a range of rows from a table.
• ARGUMENTS
  • Table * table
    A pointer to the table from which the rows are to be deleted.
  • unsigned int from
    The row number (starting at 0) from which to begin the deleting.
  • unsigned int count
    The number of rows to delete.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  dimensionsOfArray( array ) PURPOSE
  Get the dimensions of an array.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • unsigned long *
    The dimensions are returned in a vector, each element of which describes the size along each axis.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  dimensionsOfArray( column ) PURPOSE
  
• ARGUMENTS
  • const Column * column
    A pointer to the column.
• RETURNS
  • unsigned long *
    The dimensions are returned in a vector, each element of which describes the size along each axis.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  discardDataSet( dataSetName ) PURPOSE
  Tell the dataset server object to discard the named dataset.
• ARGUMENTS
  • const char * dataSetName
    The name of the dataset.
• RETURNS
  void
• DESCRIPTION
  This function must only be called by Meta Tasks.
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  keepDataSet
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  forEachSubTable( table, callThisFunction ) PURPOSE
  Subtable iteration.
• ARGUMENTS
  • const Table * table
    A pointer to the table for which subtable iteration is required.
  • TableIteratorFunction callThisFunction
    The function to be called for each subtable iteration.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  hasScalingOfArray( array ) PURPOSE
  Determine if an array has been scaled.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • bool8
    Returns true if the array has been scaled, otherwise false is returned.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  bool8 hasScalingOfColumn( column ) PURPOSE
  Determine if a column has been scaled.
• ARGUMENTS
  • const Column * column
    A pointer to the column.
• RETURNS
  • bool8
    Returns true if the column has been scaled, otherwise false is returned.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  historyOf<type>( attributable, number ) PURPOSE
  Get a history record from an attributable object.
• ARGUMENTS
  • <type> * attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • unsigned int number
    The ordinal number of the history record to be retrieved.
• RETURNS
  • const char *
    A pointer to the history record.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  insertRows( table, pos, count ) PURPOSE
  Insert rows in a table.
• ARGUMENTS
  • Table * table
    A pointer to the table within which the rows are to be inserted.
  • unsigned int from
    The row number (starting at 0) from which to begin the insertion.
  • unsigned int count
    The number of rows to insert.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  keepDataSet( dataSetName ) PURPOSE
  Tell the dataset server object not to discard the named dataset.
• ARGUMENTS
  • const char * dataSetName
    The name of the dataset.
• RETURNS
  void
• DESCRIPTION
  This function must only be called by Meta Tasks.
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  discardDataSet
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  mode( dataSet ) PURPOSE
  Get the access mode of a dataset.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the dataset.
• RETURNS
  • AccessMode
    The access mode with which the dataset was opened.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  nameOf<object>( labelled ) PURPOSE
  Get the named of a labelled object.
• ARGUMENTS
  • const <object> * attributable
    A pointer to the labelled object. Supported types are: Array, Attributable, Column, Attribute, DataSet, Table, Block.
• RETURNS
  • const char *
    A pointer to the name of the object.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfBlocks( dataSet ) PURPOSE
  Get the number of blocks in a dataset.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to the dataset.
• RETURNS
  • unsigned int
    The number of blocks in the dataset.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfColumns( table ) PURPOSE
  Get the number of columns in a table.
• ARGUMENTS
  • const Table * table
    A pointer to the table.
• RETURNS
  • unsigned int
    The number of columns in the table.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfCommentsOf<object>( attributable ) PURPOSE
  Get the number of comments in an attributable object.
• ARGUMENTS
  • <object> * attributable
    A pointer to the attributable object. Supported types are: Attributable, Array, Block, Column, DataSet, Table
• RETURNS
  • unsigned int
    The number of comments in the attributable object.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfDimensionsOfArray( array ) PURPOSE
  Get the number of dimensions of an array.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • unsigned int
    The number of dimensions of the array.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfDimensionsOfColumn( column ) PURPOSE
  Get the number of dimensions of a column.
• ARGUMENTS
  • const Column * column
    A pointer to the column.
• RETURNS
  • unsigned int
    The number of dimensions of the column.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfElementsOfArray( array ) PURPOSE
  Get the total number of elements in an array.
• ARGUMENTS
  • const Array * array
    A pointer to the array.
• RETURNS
  • unsigned long
    The total number of elements in the array.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfElementsOfColumn( column ) PURPOSE
  Get the total number of elements in a column's (fixed length column only) cell.
• ARGUMENTS
  • const Column * column
    A pointer to the column.
• RETURNS
  • unsigned long
    The total number of elements in the column's cells.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfHistorysOf<object>( attributable ) PURPOSE
  Get the number of history records in an attributable object.
• ARGUMENTS
  • <object> * attributable
    A pointer to the attributable object. Supported types are: Attributable, Array, Block, Column, Array, DataSet, Table.
• RETURNS
  • unsigned int
    The number of history records in the attributable object.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfRowsOfTable( table ) PURPOSE
  Get the number of rows in a table.
• ARGUMENTS
  • const Table * table
    A pointer to the table.
• RETURNS
  • unsigned long
    The number of rows in the table.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  numberOfRowsOfColumn( column ) PURPOSE
  Get the number of rows in a column.
• ARGUMENTS
  • const Column * column
    
• RETURNS
  • unsigned long
    The number of rows in the column.
• DESCRIPTION
  Same as the number of rows in the column's (parent) table.
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  relabel<object>( labelled, newLabel ) PURPOSE
  Relabel an labelled object.
• ARGUMENTS
  • <object> * labelled
    A pointer to the labelled object. Supported types are: Attributable, Attribute, Array, Block, Column, DataSet, Table.
  • const char * newLabel
    The new label.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  void release<object>( releasable ) PURPOSE
  Release an object.
• ARGUMENTS
  • <object> * releasable
    A pointer to the object to be released. Supported types are: Array, Block, Column, DataSet, Table
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  rename<object>( labelled, newName ) PURPOSE
  Rename a labelled object.
• ARGUMENTS
  • <object> * labelled
    A pointer to the labelled object. Supported types are: Attribute, Array, Attributable, Block, Column, DataSet, Table.
  • const char * newName
    The new name for the object.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  set<type><object>Attribute( attributable, name, value, comment ); PURPOSE
  Set the value of an attribute.
• ARGUMENTS
  • <object> * attributable
    A pointer to the attributable object. Supported types are: Array, Attributable, Block, Column, DataSet, Table.
  • const char * name
    The name of the attribute.
  • <type> value
    The value of the attribute. Supported types are bool8, Int8, Int16, Int32, Real32, Real64, String.
  • const char * comment
    The comment to associate with the attribute.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  set<type>Attribute( attribute, value, comment ) PURPOSE
  
• ARGUMENTS
  • Attribute * attribute
    A pointer to the attribute.
  • <type> value
    The value to assign to the attribute. Supported types are: Bool8, Int8, Int16, Int32, Real32, Real64, String.
  • const char * comment
    The comment to associate with the attribute.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  setCellSize( column, rowNumber, size ) PURPOSE
  Set the size of a cell in a variable-length column.
• ARGUMENTS
  • Column * column
    A pointer to the column.
  • int rowNumber
    The number of the cell to be sized.
  • int size
    The size to set the cell-size to.
• RETURNS
  void
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  setExists( setName ) PURPOSE
  Determine if a set exists.
• ARGUMENTS
  • const char * setName
    The name of the set.
• RETURNS
  • bool
    Returns true if the set exists, otherwise false is returned.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  tableHasColumn( table, name) PURPOSE
  Determine if a table contains a column with the given name.
• ARGUMENTS
  • const Table * table
    A pointer to the table.
  • const char * name
    The name of the desired column.
• RETURNS
  • bool8
    Returns true if the column with the given name was found in the table, otherwise false is returned.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  tableWithName( dataSet, name ) PURPOSE
  Get the table with the specified name from a given dataSet.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to a dataset.
  • const char * name
    The name of the desired table.
• RETURNS
  • Table *
    A pointer to the table.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

• NAME
  tableWithNumber( dataSet, position ) PURPOSE
  Get the table with the specified ordinal position in a given dataset.
• ARGUMENTS
  • const DataSet * dataSet
    A pointer to a dataset.
  • unsigned int position
    The ordinal position of the table within the dataset.
• RETURNS
  • Table *
    A pointer to the table.
• DESCRIPTION
  
• ERRORS
  
• EXAMPLES
  

• SEE ALSO
  
• BUGS AND LIMITATIONS
  
  None known.

/* forEachBlock forEachColumn forEachSubTable setStringCell subTable table */