Read a set of state variable (sv) files. More...
Inheritance diagram for carputils.carpio.sv.SVSeries:
Public Member Functions | |
| def | __init__ (self) |
| def | from_header (cls, filename) |
| Read the series of sv files described by a sv header file. More... | |
| def | append (self, svfile) |
| Add a new sv file to the series. More... | |
| def | __iter__ (self) |
| Make series iterable (usable in for loop). More... | |
| def | close (self) |
| Close all constituent files. More... | |
 Public Member Functions inherited from carputils.carpio.filelike.FileLikeMixin | |
| def | __enter__ (self) |
| def | __exit__ (self, exc_type, exc_val, exc_tb) |
Detailed Description
Read a set of state variable (sv) files.
Constructor & Destructor Documentation
◆ __init__()
| def carputils.carpio.sv.SVSeries.__init__ | ( | self | ) |
Member Function Documentation
◆ __iter__()
| def carputils.carpio.sv.SVSeries.__iter__ | ( | self | ) |
Make series iterable (usable in for loop).
◆ append()
| def carputils.carpio.sv.SVSeries.append | ( | self, | |
| svfile | |||
| ) |
Add a new sv file to the series.
- Parameters
-
svfile SVFile The sv file to add
◆ close()
| def carputils.carpio.sv.SVSeries.close | ( | self | ) |
Close all constituent files.
◆ from_header()
| def carputils.carpio.sv.SVSeries.from_header | ( | cls, | |
| filename | |||
| ) |
Read the series of sv files described by a sv header file.
- Parameters
-
filename str The path of the sv header file
- Returns
- SVSeries The series of sv files
The documentation for this class was generated from the following file:
- carputils/carpio/sv.py
