Data Structure Management Routines

Function Descriptions

cgio_create_node

Creates a new empty node in the database given by cgio_num as a child of the node identified by pid. The name of the new node is given by name, and must not already exist as a child of the parent node. The node will contain no label, dimensions, or data. Use the Node Management Routines to change the properties of the node, and the Data I/O Routines to add data. Returns 0 and the identifier of the new node in id on success, else an error code.

 

cgio_new_node

Creates a new node in the database given by cgio_num as a child of the node identified by pid. The name of the new node is given by name, and must not already exist as a child of the parent node. The node label is given by label, the type of data by data_type, the dimensions of the data by ndims and dims, and the data to write to the node by data. This is equivalent to calling the routines:

    cgio_create_node
    cgio_set_label
    cgio_set_dimensions
    cgio_write_all_data
    

Returns 0 and the identifier of the new node in id on success, else an error code.

 

cgio_delete_node

Deletes the node identified by id below the parent node identified by pid in the database given by cgio_num. All children of the deleted node will also be deleted unless a link is encountered. The link node will be deleted but nothing below it. Returns 0 on success, else an error code.

 

cgio_move_node

Moves the node indentified by id below the parent node identified by pid to below the new parent node identified by new_pid in the database given by cgio_num. A node by the same name as that that for id must not already exist under new_pid. A node may only be moved if it and the parent nodes all reside in the sane physical database. Returns 0 on success, else an error code.

 

cgio_number_children

Gets the number of children of the node identified by id in the database given by cgio_num, Returns 0 and the number of children in num_child on success, else an error code.

 

cgio_children_names

Gets the names of the children of the node identified by id in the database given by cgio_num. The starting index for the array of names is given by start, and the maximum number of names to return by max_ret. Both start and max_ret should be between 1 and num_child, inclusively. The size reserved for each name in child_names is given by name_len. The array child_names should be dimensioned at least (name_len * max_ret). Since node names are limited to a length of CGIO_MAX_NAME_LENGHT (32), name_len should be at least 32 to ensure the returned names are mot truncated. In C, an additional byte should be added to name_len allow for the terminating '0' for each name. If successfull, the function returns 0; the actual number of returned names is given by num_ret, and the array of names in child_names. In C, the names are '0'-terminated within each name field. In Fortran, any unused space is padded with blanks (space character).

 

cgio_children_ids

Gets the node identifiers of the children of the node identified by id in the database given by cgio_num. The starting index for the array of ids is given by start, and the maximum ids to return by max_ret. Both start and max_ret should be between 1 and num_child, inclusively. The array child_ids should be dimensioned at least (max_ret). If successfull, the function returns 0; the actual number of returned ids is given by num_ret, and the array of identifiers in child_ids.