C-Munipack 1.2 / Application programming interface / API reference
C-Munipack 1.2 / Application programming interface / API reference
CmpackReadAll | Read-all configuration context. |
cmpack_readall_init | Make new configuration context for the Read-all tool. |
cmpack_readall_set_console | Attach console to the context. |
cmpack_readall_set_aperture | Set aperture index. |
cmpack_readall_get_aperture | Get aperture index. |
cmpack_readall_open | Open output read-all file. |
cmpack_readall_read | Add a frame to the read-all file. |
cmpack_readall_close | Close read-all file. |
Set of functions defined in this module allows user to make read-all file from a set of photometry files.
Read-all configuration context.
typedef struct _CmpackReadAll CmpackReadAll
This private data structure holds the parameters for making read-all file.
Make new configuration context for the Read-all tool.
CmpackReadAll * cmpack_readall_init (void)
The reference counter is set to one. The caller is responsible to call cmpack_unref() when it is no longer needed.
pointer to context or zero on failure
Attach console to the context.
void cmpack_readall_set_console (CmpackReadAll * ctx, CmpackConsole * con)
Increment console's reference counter. Only one console can be attached to a single context. If another console is attached, by calling this function dettaches it. Set console to NULL to dettach the current console.
ctx | [in] | air-mass computation context |
con | [in] | console context |
Set aperture index.
int cmpack_readall_set_aperture (CmpackReadAll * ctx, int index)
ctx | [in] | listing context |
index | [in] | aperture index (starts by 1) |
zero on success or error code on failure
Get aperture index.
int cmpack_readall_get_aperture (CmpackReadAll * ctx, int * index)
ctx | [in] | listing context |
index | [out] | aperture index (starts by 1) |
zero on success or error code on failure
Open output read-all file.
int cmpack_readall_open (CmpackReadAll * ctx, CmpackAllFile * file)
Opens new read-all file and returns its context structure. The caller is responsible to close the file and free the allocated memory by calling the cmpack_readall_close() function.
ctx | [in] | configuration context |
file | [in] | output file path + name |
zero on success or error code on failure.
Add a frame to the read-all file.
int cmpack_readall_read (CmpackReadAll * ctx, CmpackPhtFile * file)
The function reads data from specified photometry file into memory.
ctx | [in] | output file context |
file | [in] | input file path + name |
zero on success or error code on failure.
Close read-all file.
int cmpack_readall_close (CmpackReadAll * ctx)
The function closes the output file and frees allocated data.
ctx | [in] | output file context |
zero on success or error code on failure.