Table of Contents

Class: pyADF CGNS/wrap.py

pyADF: wrapper to ADF calls

  • pyADF creation opens a database

  • Each method or attribute use actually runs the ADF library functions

  • ADF calls to DB have the same name without the ADF_ prefix and with a lowercase name. Argument list always try to be as close as possible to the ADF original argument list

Methods   
__eq__
__getattr__
__init__
__ne__
__nonzero__
__repr__
children
children_names
create
database_close
database_delete
database_garbage_collection
database_get_format
database_set_format
database_version
delete
error_message
flush_to_disk
get_data_type
get_dimension_values
get_error_state
get_label
get_link_path
get_name
get_node_id
get_number_of_dimensions
get_root_id
is_link
library_version
link
move_child
nodeAsDict
number_of_children
put_dimension_information
put_name
read_all_data
read_data
root
set_error_state
set_label
str
write_all_data
write_data
  __eq__ 
__eq__ ( self,  value )

  __getattr__ 
__getattr__ ( self,  name )

Purpose:

Returns the allowed attributes on this object.

Attributes:

  • rootid:Double, the ADF root node id of the current database

  • error:Integer, the last ADF error code

  __init__ 
__init__ (
        self,
        name,
        status,
        format,
        )

Purpose:

Opens a CGNS database, returns the instance required for subsequent calls on this database. To close the database, use the Python del statement or the database_close method.

Arguments:

  • name-of-file:String

  • open-mode:ADF_OPENSTATUS

  • file-format:ADF_OPENFORMAT)

Return:

  • a pyADF instance

Exceptions   
ADF_X_EMPTYFILENAME
ADF_X_NOSUCHOPENFORMAT, format
ADF_X_NOSUCHOPENSTATUS, status
  __ne__ 
__ne__ ( self,  value )

  __nonzero__ 
__nonzero__ ( self )

  __repr__ 
__repr__ ( self )

  children 
children ( self,  node=0 )

  children_names 
children_names ( self,  node )

  create 
create (
        self,
        parent,
        name,
        )

  database_close 
database_close ( self )

  database_delete 
database_delete ( self,  filename )

  database_garbage_collection 
database_garbage_collection ( self,  node )

  database_get_format 
database_get_format ( self,  rootid=0 )

  database_set_format 
database_set_format (
        self,
        rootid,
        format,
        )

Exceptions   
ADF_X_NOSUCHOPENFORMAT
  database_version 
database_version ( self,  rootid=0 )

  delete 
delete (
        self,
        parent,
        node,
        )

  error_message 
error_message ( self,  code )

  flush_to_disk 
flush_to_disk ( self,  node )

  get_data_type 
get_data_type ( self,  node )

  get_dimension_values 
get_dimension_values ( self,  node )

  get_error_state 
get_error_state ( self )

  get_label 
get_label ( self,  node )

  get_link_path 
get_link_path ( self,  node )

  get_name 
get_name ( self,  node )

  get_node_id 
get_node_id (
        self,
        parent,
        name,
        )

  get_number_of_dimensions 
get_number_of_dimensions ( self,  node )

  get_root_id 
get_root_id ( self,  node )

  is_link 
is_link ( self,  node )

  library_version 
library_version ( self )

  link 
link (
        self,
        parent,
        name,
        destfile,
        destnode,
        )

  move_child 
move_child (
        self,
        parent,
        node,
        newparent,
        )

  nodeAsDict 
nodeAsDict ( self,  node )

  number_of_children 
number_of_children ( self,  node )

  put_dimension_information 
put_dimension_information (
        self,
        node,
        datatype,
        dims,
        )

  put_name 
put_name (
        self,
        parent,
        node,
        name,
        )

  read_all_data 
read_all_data ( self,  node )

  read_data 
read_data ( self )

  root 
root ( self )

  set_error_state 
set_error_state ( self,  state )

  set_label 
set_label (
        self,
        node,
        label,
        )

  str 
str ( self,  nodeid )

  write_all_data 
write_all_data (
        self,
        node,
        array,
        )

  write_data 
write_data ( self )


Table of Contents

This document was automatically generated on Fri Feb 27 13:12:59 2004 by HappyDoc version 2.0.1