Arcane::ITraceMngPolicy Class Reference

Interface for the configuration manager of a trace manager. More...

#include <arcane/utils/ITraceMngPolicy.h>

Inheritance diagram for Arcane::ITraceMngPolicy:

Collaboration diagram for Arcane::ITraceMngPolicy:

Public Member Functions
virtual void	build ()=0
	Constructs the instance.
virtual void	initializeTraceMng (ITraceMng *trace, Int32 rank)=0
	Initializes trace.
virtual void	initializeTraceMng (ITraceMng *trace, ITraceMng *parent_trace, const String &file_suffix)=0
	Initializes trace with information from the parent parent_trace.
virtual void	setClassConfigFromXmlBuffer (ITraceMng *trace, ByteConstArrayView bytes)=0
	Sets the values of the TraceClassConfig of trace via the data contained in bytes.
virtual void	setIsParallel (bool v)=0
	Indicates if parallelism is active.
virtual bool	isParallel () const =0
virtual void	setIsDebug (bool v)=0
	Indicates if debug outputs are active.
virtual bool	isDebug () const =0
virtual void	setIsParallelOutput (bool v)=0
	Indicates if all ranks output traces to a file in parallel.
virtual bool	isParallelOutput () const =0
virtual void	setStandardOutputVerbosityLevel (Int32 level)=0
	Verbosity level for the standard output stream (stdout).
virtual Int32	standardOutputVerbosityLevel () const =0
virtual void	setVerbosityLevel (Int32 level)=0
	Verbosity level.
virtual Int32	verbosityLevel () const =0
virtual void	setIsMasterHasOutputFile (bool active)=0
	Indicates if a master ITraceMng outputs traces to a file in addition to standard output.
virtual bool	isMasterHasOutputFile () const =0
virtual void	setDefaultVerboseLevel (ITraceMng *trace, Int32 minimal_level)=0
virtual void	setDefaultClassConfigXmlBuffer (ByteConstSpan bytes)=0

Detailed Description

Interface for the configuration manager of a trace manager.

The properties defined by this class are used to initialize instances of ITraceMng. Modifying a property does not affect already created ITraceMngs.

Definition at line 35 of file ITraceMngPolicy.h.

Constructor & Destructor Documentation

~ITraceMngPolicy()

virtual Arcane::ITraceMngPolicy::~ITraceMngPolicy ( )

inlinevirtual

Definition at line 39 of file ITraceMngPolicy.h.

Member Function Documentation

build()

virtual void Arcane::ITraceMngPolicy::build ( )

pure virtual

Constructs the instance.

Implemented in Arcane::TraceMngPolicy.

initializeTraceMng() [1/2]

virtual void Arcane::ITraceMngPolicy::initializeTraceMng ( ITraceMng * trace, Int32 rank )

pure virtual

Initializes trace.

If rank is 0, then trace is considered the master ITraceMng. In case of listing output, the suffix will have the value rank.

Implemented in Arcane::TraceMngPolicy.

Referenced by Arcane::Application::createAndInitializeTraceMng().

Here is the caller graph for this function:

initializeTraceMng() [2/2]

virtual void Arcane::ITraceMngPolicy::initializeTraceMng ( ITraceMng * trace, ITraceMng * parent_trace, const String & file_suffix )

pure virtual

Initializes trace with information from the parent parent_trace.

If file outputs are enabled, trace will output its information into a file suffixed by file_suffix. parent_trace may be null.

Implemented in Arcane::TraceMngPolicy.

setClassConfigFromXmlBuffer()

virtual void Arcane::ITraceMngPolicy::setClassConfigFromXmlBuffer ( ITraceMng * trace, ByteConstArrayView bytes )

pure virtual

Sets the values of the TraceClassConfig of trace via the data contained in bytes.

bytes is a buffer containing a character string in XML format as described in the documentation arcanedoc_execution_traces.

The instances of TraceClassConfig of trace already registered before calling this method are deleted.

Implemented in Arcane::TraceMngPolicy.

setDefaultVerboseLevel()

virtual void Arcane::ITraceMngPolicy::setDefaultVerboseLevel ( ITraceMng * trace, Int32 minimal_level )

pure virtual

Sets the default verbosity level.

Sets the verbosity levels for trace to the level minimal_level. If the verbosity level is already higher than minimal_level, nothing is done. If minimal_level equals Arccore::Trace::UNSPECIFIED_VERBOSITY_LEVEL, it resets the verbosity level to that specified by verbosityLevel() and standardOutputVerbosityLevel().

Implemented in Arcane::TraceMngPolicy.

setIsDebug()

virtual void Arcane::ITraceMngPolicy::setIsDebug ( bool v )

pure virtual

Indicates if debug outputs are active.

This property is set by the application during initialization.

Implemented in Arcane::TraceMngPolicy.

setIsMasterHasOutputFile()

virtual void Arcane::ITraceMngPolicy::setIsMasterHasOutputFile ( bool active )

pure virtual

Indicates if a master ITraceMng outputs traces to a file in addition to standard output.

This property defaults to false.

Implemented in Arcane::TraceMngPolicy.

setIsParallel()

virtual void Arcane::ITraceMngPolicy::setIsParallel ( bool v )

pure virtual

Indicates if parallelism is active.

This property is set by the application during initialization.

Implemented in Arcane::TraceMngPolicy.

setIsParallelOutput()

virtual void Arcane::ITraceMngPolicy::setIsParallelOutput ( bool v )

pure virtual

Indicates if all ranks output traces to a file in parallel.

Implemented in Arcane::TraceMngPolicy.

setStandardOutputVerbosityLevel()

virtual void Arcane::ITraceMngPolicy::setStandardOutputVerbosityLevel ( Int32 level )

pure virtual

Verbosity level for the standard output stream (stdout).

This property is used when calling initializeTraceMng() to set the verbosity level of standard outputs.

Implemented in Arcane::TraceMngPolicy.

setVerbosityLevel()

virtual void Arcane::ITraceMngPolicy::setVerbosityLevel ( Int32 level )

pure virtual

Verbosity level.

This property is used when calling initializeTraceMng() to set the verbosity level.

Implemented in Arcane::TraceMngPolicy.

---

The documentation for this class was generated from the following file:

• ITraceMngPolicy.h