Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
ITraceMngPolicy.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ITraceMngPolicy.h (C) 2000-2019 */
9/* */
10/* Interface for trace management policy. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_UTILS_ITRACEMNGPOLICY_H
13#define ARCANE_UTILS_ITRACEMNGPOLICY_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/ArrayView.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
35class ARCANE_UTILS_EXPORT ITraceMngPolicy
36{
37 public:
38
39 virtual ~ITraceMngPolicy() {}
40
41 public:
42
44 virtual void build() = 0;
50 virtual void initializeTraceMng(ITraceMng* trace, Int32 rank) = 0;
51
59 virtual void initializeTraceMng(ITraceMng* trace, ITraceMng* parent_trace,
60 const String& file_suffix) = 0;
72
78 virtual void setIsParallel(bool v) = 0;
79 virtual bool isParallel() const = 0;
80
86 virtual void setIsDebug(bool v) = 0;
87 virtual bool isDebug() const = 0;
88
92 virtual void setIsParallelOutput(bool v) = 0;
93 virtual bool isParallelOutput() const = 0;
94
101 virtual void setStandardOutputVerbosityLevel(Int32 level) = 0;
102 virtual Int32 standardOutputVerbosityLevel() const = 0;
103
110 virtual void setVerbosityLevel(Int32 level) = 0;
111 virtual Int32 verbosityLevel() const = 0;
112
119 virtual void setIsMasterHasOutputFile(bool active) = 0;
120 virtual bool isMasterHasOutputFile() const = 0;
121
132 virtual void setDefaultVerboseLevel(ITraceMng* trace, Int32 minimal_level) = 0;
133
134 virtual void setDefaultClassConfigXmlBuffer(ByteConstSpan bytes) = 0;
135};
136
137/*---------------------------------------------------------------------------*/
138/*---------------------------------------------------------------------------*/
139
140} // End namespace Arcane
141
142/*---------------------------------------------------------------------------*/
143/*---------------------------------------------------------------------------*/
144
145#endif
Interface for the configuration manager of a trace manager.
virtual void setIsParallelOutput(bool v)=0
Indicates if all ranks output traces to a file in parallel.
virtual void initializeTraceMng(ITraceMng *trace, Int32 rank)=0
Initializes trace.
virtual void setIsDebug(bool v)=0
Indicates if debug outputs are active.
virtual void setIsParallel(bool v)=0
Indicates if parallelism is active.
virtual void setClassConfigFromXmlBuffer(ITraceMng *trace, ByteConstArrayView bytes)=0
Sets the values of the TraceClassConfig of trace via the data contained in bytes.
virtual void setIsMasterHasOutputFile(bool active)=0
Indicates if a master ITraceMng outputs traces to a file in addition to standard output.
virtual void setVerbosityLevel(Int32 level)=0
Verbosity level.
virtual void setStandardOutputVerbosityLevel(Int32 level)=0
Verbosity level for the standard output stream (stdout).
virtual void setDefaultVerboseLevel(ITraceMng *trace, Int32 minimal_level)=0
virtual void build()=0
Constructs the instance.
virtual void initializeTraceMng(ITraceMng *trace, ITraceMng *parent_trace, const String &file_suffix)=0
Initializes trace with information from the parent parent_trace.
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
ConstArrayView< Byte > ByteConstArrayView
C equivalent of a 1D array of characters.
Definition UtilsTypes.h:476
std::int32_t Int32
Signed integer type of 32 bits.