header.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
 *
 * SPDX-License-Identifier: MIT
 */

 
#ifndef SDFIO_HEADER_H
#define SDFIO_HEADER_H
 
#include <sdfio/sdfio_export.h>
#include <sdfio/types.h>
 
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
 
#ifdef __cplusplus
extern "C"
{
#endif

typedef struct sdfio_header sdfio_header;

SDFIO_API sdfio_status sdfio_header_create(const sdfio_allocator *allocator,
                                           sdfio_header **header);

SDFIO_API sdfio_status sdfio_header_copy(sdfio_header *dst,
                                         const sdfio_header *src);

SDFIO_API void sdfio_header_free(sdfio_header *header);

SDFIO_API sdfio_revision sdfio_header_revision(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_revision(sdfio_header *header,
                                                 sdfio_revision revision);

SDFIO_API sdfio_format sdfio_header_format(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_format(sdfio_header *header,
                                               sdfio_format format);

SDFIO_API sdfio_data_type sdfio_header_data_type(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_data_type(sdfio_header *header,
                                                  sdfio_data_type data_type);

SDFIO_API uint32_t sdfio_header_columns(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_columns(sdfio_header *header,
                                                uint32_t columns);

SDFIO_API uint32_t sdfio_header_rows(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_rows(sdfio_header *header,
                                             uint32_t rows);

SDFIO_API double sdfio_header_x_scale(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_x_scale(sdfio_header *header,
                                                double x_scale);

SDFIO_API double sdfio_header_y_scale(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_y_scale(sdfio_header *header,
                                                double y_scale);

SDFIO_API double sdfio_header_z_scale(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_z_scale(sdfio_header *header,
                                                double z_scale);

SDFIO_API double sdfio_header_z_resolution(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_z_resolution(sdfio_header *header,
                                                     double z_resolution);

SDFIO_API time_t sdfio_header_created(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_created(sdfio_header *header,
                                                time_t created);

SDFIO_API time_t sdfio_header_modified(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_modified(sdfio_header *header,
                                                 time_t modified);

SDFIO_API sdfio_status sdfio_header_set_dates(sdfio_header *header,
                                              time_t date);

SDFIO_API const char *sdfio_header_manufacturer(const sdfio_header *header);

SDFIO_API sdfio_status sdfio_header_set_manufacturer(sdfio_header *header,
                                                     const char *manufacturer);

SDFIO_API bool sdfio_revision_allows(sdfio_revision revision,
                                     sdfio_data_type type);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SDFIO_HEADER_H */