HPS::Stream::File Class Reference

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

#include <hps.h>

Static Public Member Functions
static ImportNotifier	Import (char const *in_file_name, ImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified HSF file with the provided options. More...
static ImportNotifier	Import (ByteArrayArray const &in_hsf_buffers, ImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified HSF file with the provided options. More...
static ExportNotifier	Export (char const *in_file_name, SegmentKey const &in_segment, ExportOptionsKit const &in_options)
	Performs an asynchronous HSF export of the given segment with the provided options to a given filename. More...
static ExportNotifier	Export (SegmentKey const &in_segment, ExportOptionsKit const &in_options, ByteArrayArray &out_hsf_buffers)
	Performs an asynchronous HSF export of the given segment with the provided options to a list of output buffers. More...

Private Member Functions
	File ()
	Private default constructor to prevent instantiation. More...

Detailed Description

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

Constructor & Destructor Documentation

File()

HPS::Stream::File::File ( )

private

Private default constructor to prevent instantiation.

Member Function Documentation

Export() [1/2]

static ExportNotifier HPS::Stream::File::Export ( char const *  in_file_name, SegmentKey const &  in_segment, ExportOptionsKit const &  in_options  )

static

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.

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.

Export() [2/2]

static ExportNotifier HPS::Stream::File::Export ( SegmentKey const &  in_segment, ExportOptionsKit const &  in_options, ByteArrayArray &  out_hsf_buffers  )

static

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.

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.

Import() [1/2]

static ImportNotifier HPS::Stream::File::Import ( char const *  in_file_name, ImportOptionsKit const &  in_options  )

static

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.

Import() [2/2]

static ImportNotifier HPS::Stream::File::Import ( ByteArrayArray const &  in_hsf_buffers, ImportOptionsKit const &  in_options  )

static

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:

• hps.h