ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/util/eplus_idf.h
Revision: 2.5
Committed: Sun Feb 9 22:19:30 2014 UTC (10 years, 2 months ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.4: +2 -1 lines
Log Message:
Partial implementation of eplus_adduvf

File Contents

# User Rev Content
1 greg 2.5 /* RCSid $Id: eplus_idf.h,v 2.4 2014/02/09 05:49:21 greg Exp $ */
2 greg 2.1 /*
3     * eplus_idf.h
4     *
5     * EnergyPlus Input Data File i/o declarations
6     *
7     * Created by Greg Ward on 1/31/14.
8     */
9    
10     #ifndef _RAD_EPLUS_IDF_H_
11     #define _RAD_EPLUS_IDF_H_
12    
13     #include "lookup.h"
14    
15     #ifdef __cplusplus
16     extern "C" {
17     #endif
18    
19     #define IDF_MAXLINE 512 /* maximum line length */
20 greg 2.2 #define IDF_MAXARGL 104 /* maximum argument length */
21 greg 2.1
22     /* Input Data File parameter argument list */
23     typedef struct s_idf_field {
24     struct s_idf_field *next; /* next in parameter list */
25     char *rem; /* string following argument */
26     char arg[2]; /* argument (extends struct) */
27     } IDF_FIELD;
28    
29     /* Input Data File parameter */
30     typedef struct s_idf_parameter {
31     const char *pname; /* parameter name (type) */
32     struct s_idf_parameter *pnext; /* next parameter same type */
33     struct s_idf_parameter *dnext; /* next parameter in IDF */
34 greg 2.5 int nfield; /* field count */
35 greg 2.1 IDF_FIELD *flist; /* field list */
36     char rem[1]; /* comment (extends struct) */
37     } IDF_PARAMETER;
38    
39     /* Input Data File w/ dictionary */
40     typedef struct {
41     char *hrem; /* header remarks */
42     IDF_PARAMETER *pfirst; /* first parameter in file */
43     IDF_PARAMETER *plast; /* last parameter loaded */
44 greg 2.3 LUTAB ptab; /* parameter hash table */
45 greg 2.1 } IDF_LOADED;
46    
47 greg 2.3 /* Create a new parameter with empty field list (comment & prev optional) */
48 greg 2.1 extern IDF_PARAMETER *idf_newparam(IDF_LOADED *idf, const char *pname,
49 greg 2.3 const char *comm, IDF_PARAMETER *prev);
50 greg 2.1
51     /* Add a field to the given parameter and follow with the given text */
52     extern int idf_addfield(IDF_PARAMETER *param, const char *fval,
53     const char *comm);
54    
55 greg 2.3 /* Retrieve the indexed field from parameter (first field index is 1) */
56     extern IDF_FIELD *idf_getfield(IDF_PARAMETER *param, int fn);
57    
58 greg 2.4 /* Delete the specified parameter from the IDF */
59 greg 2.1 extern int idf_delparam(IDF_LOADED *idf, IDF_PARAMETER *param);
60    
61 greg 2.4 /* Move the specified parameter to the given position in the IDF */
62     extern int idf_movparam(IDF_LOADED *idf, IDF_PARAMETER *param,
63     IDF_PARAMETER *prev);
64    
65 greg 2.1 /* Get a named parameter list */
66     extern IDF_PARAMETER *idf_getparam(IDF_LOADED *idf, const char *pname);
67    
68     /* Read a parameter and fields from an open file and add to end of list */
69     extern IDF_PARAMETER *idf_readparam(IDF_LOADED *idf, FILE *fp);
70    
71     /* Initialize an IDF struct */
72     extern IDF_LOADED *idf_create(const char *hdrcomm);
73    
74 greg 2.4 /* Add comment(s) to header */
75     extern int idf_add2hdr(IDF_LOADED *idf, const char *hdrcomm);
76    
77 greg 2.1 /* Load an Input Data File */
78     extern IDF_LOADED *idf_load(const char *fname);
79    
80     /* Write a parameter and fields to an open file */
81 greg 2.4 int idf_writeparam(IDF_PARAMETER *param, FILE *fp,
82     int incl_comm);
83 greg 2.1
84     /* Write out an Input Data File */
85 greg 2.4 extern int idf_write(IDF_LOADED *idf, const char *fname,
86     int incl_comm);
87 greg 2.1
88     /* Free a loaded IDF */
89     extern void idf_free(IDF_LOADED *idf);
90    
91     #ifdef __cplusplus
92     }
93     #endif
94     #endif /* ! _RAD_EPLUS_IDF_H_ */