The File class provides functions to import and export HSF files.
More...
The File class provides functions to import and export HSF files.
Performs an asychronous HSF export of the given segment with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.
- Parameters
-
in_file_name | Name of the file to write the HSF data to. |
in_segment | Segment containing the data to export. |
in_options | Options controlling the export of the HSF data. |
- Returns
- An ExportNotifier object that can be used to query the export progress and status.
Performs an asychronous HSF export of the given segment with the provided options to a list of output buffers. An exception will be thrown if a problem is encountered during export.
- Parameters
-
in_segment | Segment containing the data to export. |
in_options | Options controlling the export of the HSF data. |
out_hsf_buffers | The output buffers the exported HSF data is written to. |
- Returns
- An ExportNotifier object that can be used to query the export progress and status.
Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.
- Parameters
-
in_file_name | Name of HSF file to import. |
in_options | Options controlling the import of the HSF file (e.g., segment to import into). |
- Returns
- An ImportNotfier object that can be used to query the import progress and status.
Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.
- Parameters
-
in_hsf_buffers | The buffer of HSF data to import. |
in_options | Options controlling the import of the HSF file (e.g., segment to import into). |
- Returns
- An ImportNotfier object that can be used to query the import progress and status.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Stream.cs