HPS::Stream::File

class HPS.Stream.File : public IDisposable 

The File class provides functions to import and export HSF files.

Public Functions

void Dispose ()

File (HPS.Stream.File in_that)

Public Static Functions

HPS.Stream.ExportNotifier Export (HPS.SegmentKey in_segment, HPS.Stream.ExportOptionsKit in_options, out byte[][] out_hsf_buffers)

Performs an asynchronous 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.

Param in_segment: Segment containing the data to export.
Param in_options: Options controlling the export of the HSF data.
Param out_hsf_buffers: The output buffers the exported HSF data is written to.
Return: An ExportNotifier object that can be used to query the export progress and status.

HPS.Stream.ExportNotifier Export (string in_file_name, HPS.SegmentKey in_segment, HPS.Stream.ExportOptionsKit in_options)

Performs an asynchronous 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.

Param in_file_name: Name of the file to write the HSF data to.
Param in_segment: Segment containing the data to export.
Param in_options: Options controlling the export of the HSF data.
Return: An ExportNotifier object that can be used to query the export progress and status.

HPS.Stream.ImportNotifier Import (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options)

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Param in_hsf_buffers: The buffer of HSF data to import.
Param in_options: Options controlling the import of the HSF file (e.g., segment to import into).
Return: An ImportNotfier object that can be used to query the import progress and status.

HPS.Stream.ImportNotifier Import (string in_file_name, HPS.Stream.ImportOptionsKit in_options)

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Param in_file_name: Name of HSF file to import.
Param in_options: Options controlling the import of the HSF file (e.g., segment to import into).
Return: An ImportNotfier object that can be used to query the import progress and status.