IpatchSLI

IpatchSLI — Spectralis instrument file object

Functions

Object Hierarchy

    GObject
    ╰── IpatchItem
        ╰── IpatchContainer
            ╰── IpatchBase
                ╰── IpatchSLI

Description

Object type for Spectralis format instruments.

Functions

ipatch_sli_new ()

IpatchSLI *
ipatch_sli_new (void);

Create a new Spectralis base object.

Returns

New Spectralis base object with a reference count of 1. Caller owns the reference and removing it will destroy the item.


ipatch_sli_get_insts()

#define             ipatch_sli_get_insts(sli)

ipatch_sli_get_samples()

#define             ipatch_sli_get_samples(sli)

ipatch_sli_set_file ()

void
ipatch_sli_set_file (IpatchSLI *sli,
                     IpatchSLIFile *file);

Sets the file object of a SLI object. SLI files are kept open for sample data that references the file. This function sets a Spectralis object's authoritive file. A convenience function, as ipatch_base_set_file() does the same thing (albeit without more specific type casting).

Parameters

sli

SLI object to set file object of

 

file

File object to use with the SLI object

 

ipatch_sli_get_file ()

IpatchSLIFile *
ipatch_sli_get_file (IpatchSLI *sli);

Gets the file object of a SLI object. The returned SLI file object's reference count has been incremented. The caller owns the reference and is responsible for removing it with g_object_unref. A convenience function as ipatch_base_get_file() does the same thing (albeit without more specific type casting).

Parameters

sli

SLI object to get file object of

 

Returns

The SLI file object or NULL if sli is not open. Remember to unref the file object with g_object_unref() when done with it.

[transfer full]


ipatch_sli_make_unique_name ()

char *
ipatch_sli_make_unique_name (IpatchSLI *sli,
                             GType child_type,
                             const char *name,
                             const IpatchItem *exclude);

Generates a unique name for the given child_type in sli . The name parameter is used as a base and is modified, by appending a number, to make it unique (if necessary). The exclude parameter is used to exclude an existing sli child item from the search.

MT-Note: To ensure that an item is actually unique before being added to a SLI object, ipatch_container_add_unique() should be used.

Parameters

sli

SLI object

 

child_type

A child type of sli to search for a unique name in

 

name

An initial name to use or NULL.

[nullable]

exclude

An item to exclude from search or NULL.

[nullable]

Returns

A new unique name which should be freed when finished with it.


ipatch_sli_find_inst ()

IpatchSLIInst *
ipatch_sli_find_inst (IpatchSLI *sli,
                      const char *name,
                      const IpatchSLIInst *exclude);

Find an instrument by name in an SLI object. If a matching instrument is found, its reference count is incremented before it is returned. The caller is responsible for removing the reference with g_object_unref() when finished with it.

Parameters

sli

SLI to search in

 

name

Name of Instrument to find

 

exclude

An instrument to exclude from the search or NULL.

[nullable]

Returns

The matching instrument or NULL if not found. Remember to unref the item when finished with it.

[transfer full]


ipatch_sli_find_sample ()

IpatchSLISample *
ipatch_sli_find_sample (IpatchSLI *sli,
                        const char *name,
                        const IpatchSLISample *exclude);

Find a sample by name in a SLI object. If a sample is found its reference count is incremented before it is returned. The caller is responsible for removing the reference with g_object_unref() when finished with it.

Parameters

sli

SLI to search in

 

name

Name of sample to find

 

exclude

A sample to exclude from the search or NULL.

[nullable]

Returns

The matching sample or NULL if not found. Remember to unref the item when finished with it.

[transfer full]


ipatch_sli_get_zone_references ()

IpatchList *
ipatch_sli_get_zone_references (IpatchSLISample *sample);

Get list of zones referencing an IpatchSLISample.

Parameters

sample

Sample to locate referencing zones of.

 

Returns

New item list containing IpatchSLIZone objects that refer to sample . The returned list has a reference count of 1 which the caller owns, unreference to free the list.

[transfer full]