Loading...
Searching...
No Matches
profilingTrigger Class Reference

Triggers for starting/stopping code profiling. More...

#include <profilingTrigger.H>

Public Member Functions

 profilingTrigger (const profilingTrigger &)=delete
 No copy construct.
void operator= (const profilingTrigger &)=delete
 No copy assignment.
constexpr profilingTrigger () noexcept
 Default construct, no profiling trigger.
template<class... StringArgs>
 profilingTrigger (StringArgs &&... description)
 Start profiling section (if profiling is active) with given description.
 ~profilingTrigger ()
 Destructor, calls stop().
bool running () const noexcept
 True if the triggered profiling section is active.
void stop ()
 Stop triggered profiling section.

Detailed Description

Triggers for starting/stopping code profiling.

Source files

Definition at line 50 of file profilingTrigger.H.

Constructor & Destructor Documentation

◆ profilingTrigger() [1/3]

profilingTrigger ( const profilingTrigger & )
delete

No copy construct.

References profilingTrigger().

Referenced by operator=(), and profilingTrigger().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ profilingTrigger() [2/3]

profilingTrigger ( )
inlineconstexprnoexcept

Default construct, no profiling trigger.

Definition at line 124 of file profilingTrigger.H.

References Foam::noexcept.

◆ profilingTrigger() [3/3]

template<class... StringArgs>
profilingTrigger ( StringArgs &&... description)
inlineexplicit

Start profiling section (if profiling is active) with given description.

The description is generated by string concatenation of the parameters. Descriptions beginning with 'application::' are reserved for internal use.

Definition at line 136 of file profilingTrigger.H.

◆ ~profilingTrigger()

~profilingTrigger ( )

Destructor, calls stop().

Definition at line 169 of file profilingTrigger.C.

References stop().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

void operator= ( const profilingTrigger & )
delete

No copy assignment.

References profilingTrigger().

Here is the call graph for this function:

◆ running()

bool running ( ) const
noexcept

True if the triggered profiling section is active.

Definition at line 177 of file profilingTrigger.C.

References Foam::noexcept.

◆ stop()

void stop ( )

Stop triggered profiling section.

Definition at line 183 of file profilingTrigger.C.

References profiling::unstack().

Referenced by ~profilingTrigger().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: