libarmutils  1.4
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Groups
dsenv.h
Go to the documentation of this file.
1 /*******************************************************************************
2 *
3 * COPYRIGHT (C) 2010 Battelle Memorial Institute. All Rights Reserved.
4 *
5 ********************************************************************************
6 *
7 * Author:
8 * name: Brian Ermold
9 * phone: (509) 375-2277
10 * email: brian.ermold@pnl.gov
11 *
12 ********************************************************************************
13 *
14 * REPOSITORY INFORMATION:
15 * $Revision: 55592 $
16 * $Author: ermold $
17 * $Date: 2014-07-19 23:21:50 +0000 (Sat, 19 Jul 2014) $
18 *
19 ********************************************************************************
20 *
21 * NOTE: DOXYGEN is used to generate documentation for this file.
22 *
23 *******************************************************************************/
24 
25 /** @file dsenv.h
26  * DataSystem Environment Functions
27  */
28 
29 #ifndef _DSENV_H
30 #define _DSENV_H
31 
32 /**
33  * @defgroup ARMUTILS_DSENV DataSystem Environment
34  */
35 /*@{*/
36 
37 char *dsenv_get_hostname(void);
38 
39 int dsenv_getenv(const char *name, char **value);
40 int dsenv_setenv(const char *name, const char *format, ...);
41 
42 int dsenv_get_apps_conf_root(
43  const char *proc_name,
44  const char *proc_type,
45  char **path);
46 
47 int dsenv_get_apps_conf_dir(
48  const char *proc_name,
49  const char *proc_type,
50  const char *site,
51  const char *facility,
52  const char *name,
53  const char *level,
54  char **path);
55 
56 int dsenv_get_collection_root(char **path);
57 int dsenv_get_collection_dir(
58  const char *site,
59  const char *facility,
60  const char *name,
61  const char *level,
62  char **path);
63 
64 int dsenv_get_data_conf_root(char **path);
65 int dsenv_get_data_conf_dir(
66  const char *site,
67  const char *facility,
68  const char *name,
69  const char *level,
70  char **path);
71 
72 int dsenv_get_datastream_root(char **path);
73 int dsenv_get_datastream_dir(
74  const char *site,
75  const char *facility,
76  const char *name,
77  const char *level,
78  char **path);
79 
80 int dsenv_get_input_datastream_root(char **path);
81 int dsenv_get_input_datastream_dir(
82  const char *site,
83  const char *facility,
84  const char *name,
85  const char *level,
86  char **path);
87 
88 int dsenv_get_output_datastream_root(char **path);
89 int dsenv_get_output_datastream_dir(
90  const char *site,
91  const char *facility,
92  const char *name,
93  const char *level,
94  char **path);
95 
96 int dsenv_get_tmp_root(char **path);
97 int dsenv_get_logs_root(char **path);
98 int dsenv_get_quicklook_root(char **path);
99 
100 /*@}*/
101 
102 #endif /* _DSENV_H */