File
====

.. currentmodule:: bapsflib._hdf.utils.file

.. autoclass:: File
   :show-inheritance:

   
     
   

   
   

   .. rubric:: Attributes Summary

   .. autosummary::
   
      ~File.attrs
      ~File.controls
      ~File.digitizers
      ~File.driver
      ~File.file
      ~File.file_map
      ~File.filename
      ~File.id
      ~File.info
      ~File.libver
      ~File.meta_block_size
      ~File.mode
      ~File.msi
      ~File.name
      ~File.overview
      ~File.parent
      ~File.ref
      ~File.regionref
      ~File.swmr_mode
      ~File.userblock_size
      ~File.CONTROL_PATH
      ~File.DIGITIZER_PATH
      ~File.MSI_PATH

   
   

   
   

   .. rubric:: Methods Summary

   .. autosummary::
   
      ~File.build_virtual_dataset
      ~File.clear
      ~File.close
      ~File.copy
      ~File.create_dataset
      ~File.create_dataset_like
      ~File.create_group
      ~File.create_virtual_dataset
      ~File.flush
      ~File.get
      ~File.get_digitizer_specs
      ~File.get_time_array
      ~File.in_memory
      ~File.items
      ~File.keys
      ~File.move
      ~File.pop
      ~File.popitem
      ~File.read_controls
      ~File.read_data
      ~File.read_msi
      ~File.require_dataset
      ~File.require_group
      ~File.setdefault
      ~File.update
      ~File.values
      ~File.visit
      ~File.visit_links
      ~File.visititems
      ~File.visititems_links

   
   

   
   

   .. rubric:: Attributes Documentation

   
   .. autoattribute:: attrs
   .. autoattribute:: controls
   .. autoattribute:: digitizers
   .. autoattribute:: driver
   .. autoattribute:: file
   .. autoattribute:: file_map
   .. autoattribute:: filename
   .. autoattribute:: id
   .. autoattribute:: info
   .. autoattribute:: libver
   .. autoattribute:: meta_block_size
   .. autoattribute:: mode
   .. autoattribute:: msi
   .. autoattribute:: name
   .. autoattribute:: overview
   .. autoattribute:: parent
   .. autoattribute:: ref
   .. autoattribute:: regionref
   .. autoattribute:: swmr_mode
   .. autoattribute:: userblock_size
   .. autoattribute:: CONTROL_PATH
   .. autoattribute:: DIGITIZER_PATH
   .. autoattribute:: MSI_PATH

   
   

   
   

   .. rubric:: Methods Documentation

   
   .. automethod:: build_virtual_dataset
   .. automethod:: clear
   .. automethod:: close
   .. automethod:: copy
   .. automethod:: create_dataset
   .. automethod:: create_dataset_like
   .. automethod:: create_group
   .. automethod:: create_virtual_dataset
   .. automethod:: flush
   .. automethod:: get
   .. automethod:: get_digitizer_specs
   .. automethod:: get_time_array
   .. automethod:: in_memory
   .. automethod:: items
   .. automethod:: keys
   .. automethod:: move
   .. automethod:: pop
   .. automethod:: popitem
   .. automethod:: read_controls
   .. automethod:: read_data
   .. automethod:: read_msi
   .. automethod:: require_dataset
   .. automethod:: require_group
   .. automethod:: setdefault
   .. automethod:: update
   .. automethod:: values
   .. automethod:: visit
   .. automethod:: visit_links
   .. automethod:: visititems
   .. automethod:: visititems_links