IpatchSLIWriter: libinstpatch Reference Manual

IpatchSLIWriter

IpatchSLIWriter — Spectralis SLI/SLC instrument file writer

Functions

IpatchSLIWriter *	ipatch_sli_writer_new ()
void	ipatch_sli_writer_set_patch ()
void	ipatch_sli_writer_set_file_handle ()
gboolean	ipatch_sli_writer_save ()
IpatchList *	ipatch_sli_writer_create_stores ()

Object Hierarchy

    GObject
    ╰── IpatchSLIWriter

Description

Writes an SLI instrument object tree (IpatchSLI) to an SLI or SLC file.

Functions

ipatch_sli_writer_new ()

IpatchSLIWriter *
ipatch_sli_writer_new (IpatchFileHandle *handle,
                       IpatchSLI *sli);

Create a new SLI file writer.

Parameters

handle	SLI file handle to save to or `NULL` to set later, taken over by writer object and will be closed on finalize.
sli	SLI object to save or `NULL` to set later

Returns

The new SLI writer

ipatch_sli_writer_set_patch ()

void
ipatch_sli_writer_set_patch (IpatchSLIWriter *writer,
                             IpatchSLI *sli);

Set the SLI patch object to save with a SLI writer.

Parameters

writer	SLI writer object
sli	SLI patch to save

ipatch_sli_writer_set_file_handle ()

void
ipatch_sli_writer_set_file_handle (IpatchSLIWriter *writer,
                                   IpatchFileHandle *handle);

Set the SLI file handle of an SLI writer.

Parameters

writer	SLI writer object
handle	SLI file handle or `NULL` to clear.	[nullable]

ipatch_sli_writer_save ()

gboolean
ipatch_sli_writer_save (IpatchSLIWriter *writer,
                        GError **err);

Write an SLI object to a file.

Parameters

writer	SLI writer object
err	Location to store error info or `NULL`

Returns

TRUE on success, FALSE on error

ipatch_sli_writer_create_stores ()

IpatchList *
ipatch_sli_writer_create_stores (IpatchSLIWriter *writer);

Create sample stores and add them to applicable IpatchSampleData objects and return object list. This function can be called multiple times, additional calls will return the same list.

Parameters

writer

SLI writer object

Returns

List of sample stores which the caller owns a reference to or NULL.

[transfer full]