GAT Documentation

00001 /** @file logical_filestore.h
00002  * Header file for the logical_filestore class.
00003  *
00004  * @date Thu Oct 16 2003
00005  *
00006  * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/logicalfile/logical_filestore.h,v 1.7 2004/03/30 12:02:07 hartmutkaiser Exp $
00007  *
00008  *  Copyright (C) Hartmut Kaiser
00009  *  This file is part of the GAT Engine.
00010  *  Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>.
00011  *
00012  *  Use, modification and distribution is subject to the Gridlab Software
00013  *  License. (See accompanying file GLlicense.txt or copy at
00014  *  http://www.gridlab.org/GLlicense.txt)
00015  */
00016 
00017 #if !defined(_LOGICAL_FILESTORE_H_)
00018 #define _LOGICAL_FILESTORE_H_
00019 
00020 #include "GATLocation.h"
00021 #include "GATFile.h"
00022 #include "GATList.h"
00023 #include "GATLogicalFileCPI.h"
00024 
00025 /* this is the structure, which represents the logical_filestore object */
00026 typedef struct logical_filestore_s {
00027   GATContext context;
00028   char const *name;
00029   GATList_String files;
00030   GATBool isdirty;
00031   GATBool shouldberemoved;
00032 } *logical_filestore;
00033 
00034 /* these are the 'members' of the logical_filestore 'class' */
00035 logical_filestore logical_filestore_create(GATContext ctx, 
00036   char const *name, GATLogicalFileMode mode);
00037 void logical_filestore_destroy(GATContext ctx, logical_filestore *store);
00038 
00039 GATResult logical_filestore_addfile(GATContext ctx, logical_filestore store, 
00040   GATFile_const file);
00041 GATResult logical_filestore_removefile(GATContext ctx, logical_filestore store, 
00042   GATFile_const file);
00043 GATResult logical_filestore_replicate(GATContext ctx, logical_filestore store, 
00044   GATLocation_const target);
00045 GATResult logical_filestore_getfiles(GATContext ctx, logical_filestore store, 
00046   GATList_GATFile *files);
00047 GATResult logical_filestore_remove(logical_filestore store);
00048 
00049 #endif /* !defined(_LOGICAL_FILESTORE_H_) */