file_object.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2025 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of RAVE.
 
RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
RAVE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef FILEOBJECT_H
#define FILEOBJECT_H
#include "rave_object.h"
#include "rave_value.h"
#include "rave_types.h"
#include "rave_list.h"
#include "raveobject_list.h"
#include "lazy_dataset.h"
#include "rave_data2d.h"
 
typedef enum FileObjectRestrictionMode {
    FileObjectRestrictionMode_NONE=0,    
    FileObjectRestrictionMode_ODIM=1
} FileObjectRestrictionMode;

typedef struct _FileObject_t FileObject_t;

extern RaveCoreObjectType FileObject_TYPE;

FileObject_t* FileObject_createRoot(void);

int FileObject_setName(FileObject_t* self, const char* name);
    
const char* FileObject_getName(FileObject_t* self);

int FileObject_areNamesSet(FileObject_t* self);

char* FileObject_toString(FileObject_t* self);

void FileObject_setRestrictionMode(FileObject_t* self, FileObjectRestrictionMode mode);

FileObjectRestrictionMode FileObject_getRestrictionMode(FileObject_t* self);

FileObject_t* FileObject_get(FileObject_t* self, const char* name);

FileObject_t* FileObject_create(FileObject_t* self, const char* name);

size_t FileObject_numberOfGroups(FileObject_t* self);

FileObject_t* FileObject_getByIndex(FileObject_t* self, int index);

int FileObject_exists(FileObject_t* self, const char* name);

RaveObjectList_t* FileObject_groups(FileObject_t* self);

RaveValue_t* FileObject_attributes(FileObject_t* self);

int FileObject_addAttribute(FileObject_t* self, const char* name, RaveValue_t* value);

RaveData2D_t* FileObject_getData(FileObject_t* self);

int FileObject_setData(FileObject_t* self, RaveData2D_t* data);

int FileObject_isDataset(FileObject_t* self);

int FileObject_isDatasetLoaded(FileObject_t* self);

long FileObject_getDatasetX(FileObject_t* self);

long FileObject_getDatasetY(FileObject_t* self);

RaveDataType FileObject_getDatasetType(FileObject_t* self);

int FileObject_setLazyDataset(FileObject_t* self, LazyDataset_t* lazyDataset);
#endif