carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | List of all members
carputils.carpio.limpetguihdf5.LimpetGUIHDF5File Class Reference

limpetgui HDF5 file IO class. More...

Inheritance diagram for carputils.carpio.limpetguihdf5.LimpetGUIHDF5File:
carputils.carpio.filelike.FileLikeMixin

Public Member Functions

def __init__ (self, filename, mode='r', title=DEFAULT_TITLE)
 
def close (self)
 Close the file object. More...
 
def write (self, times=None, traces=[], named_traces={})
 Write data to the file. More...
 
- Public Member Functions inherited from carputils.carpio.filelike.FileLikeMixin
def __enter__ (self)
 
def __exit__ (self, exc_type, exc_val, exc_tb)
 

Detailed Description

limpetgui HDF5 file IO class.

Class derived from carpio.filelike.FileLikeMixin

Constructor & Destructor Documentation

◆ __init__()

def carputils.carpio.limpetguihdf5.LimpetGUIHDF5File.__init__ (   self,
  filename,
  mode = 'r',
  title = DEFAULT_TITLE 
)
Parameters
filename(str) The filename to open.
mode(str) 'r' for read mode (default), 'w' for write mode
title(str) data title used in hdf5 file

Member Function Documentation

◆ close()

def carputils.carpio.limpetguihdf5.LimpetGUIHDF5File.close (   self)

Close the file object.

◆ write()

def carputils.carpio.limpetguihdf5.LimpetGUIHDF5File.write (   self,
  times = None,
  traces = [],
  named_traces = {} 
)

Write data to the file.

Parameters
times(array-like) Array of times for the traces
traces(list of array-like) List of unnamed traces to write to file
named_traces(dict of array-like) Dict of name-trace pairs to write to file

The documentation for this class was generated from the following file: