Falaise
4.0.1
SuperNEMO Software Toolkit
falaise
common
user_profile.h
Go to the documentation of this file.
1
//! \file falaise/common/user_profile.h - User profile
2
//
3
// Copyright (c) 2017 by François Mauger <mauger@lpccaen.in2p3.fr>
4
// Copyright (c) 2017 by Université de Caen Normandie
5
6
// Distributed under the OSI-approved BSD 3-Clause License (the "License");
7
// see accompanying file License.txt for details.
8
//
9
// This software is distributed WITHOUT ANY WARRANTY; without even the
10
// implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11
// See the License for more information.
12
13
#ifndef FALAISE_COMMON_USER_PROFILE_H
14
#define FALAISE_COMMON_USER_PROFILE_H
15
16
// Standard Library:
17
#include <set>
18
#include <string>
19
20
namespace
falaise
{
21
22
namespace
common {
23
24
//! Return the set of supported user profiles. User profiles offer differents
25
//! guarantees on data production.
26
//!
27
//! Use case for Monte Carlo data production (FLSimulate):
28
//! - "expert" : This mode gives access to all configuration parameters
29
//! and command line switches. It is reserved for very experienced users
30
//! with a very good knowledge of the Bayeux/Falaise simulation framework.
31
//! It is supposed to be used to explore, debug, commission new simulation contexts.
32
//! No Monte Carlo data produced with this mode should be accepted in the official
33
//! datasets. Use it at your own risk!
34
//! - "normal" : This mode gives access to a limited, but still rich, set of
35
//! configuration parameters and command line switches. Users have the
36
//! possibility to setup his/her own simulation setup for investigating and/or
37
//! testing new Monte-Carlo configurations. This is the default mode.
38
//! No Monte Carlo data produced with this mode should be accepted in the official
39
//! datasets but each configuration provided within this mode could be promoted
40
//! to an official one, after validation and acceptation by the Board!
41
//! - "production" : This mode gives access to a more limited set of configuration parameters
42
//! and command line switches. Users have only the possibility to use blessed
43
//! setups (registered through URNs). Strict rules for data production are used.
44
//! This is the profile for production of 'blessed' Monte Carlo datasets. Only Monte Carlo
45
//! data produced with this mode should be accepted as official ones.
46
//!
47
const
std::set<std::string>&
supported_user_profiles
();
48
49
}
// namespace common
50
51
}
// namespace falaise
52
53
#endif // FALAISE_COMMON_USER_PROFILE_H
54
55
// Local Variables: --
56
// mode: c++ --
57
// c-file-style: "gnu" --
58
// tab-width: 2 --
59
// End: --
falaise::common::supported_user_profiles
const std::set< std::string > & supported_user_profiles()
falaise
Definition:
metadata_utils.h:35
Generated by
1.8.15