profilingTrigger Class Reference

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

Public Member Functions

 profilingTrigger (const profilingTrigger &)=delete
 No copy construct. More...
 
void operator= (const profilingTrigger &)=delete
 No copy assignment. More...
 
 profilingTrigger () noexcept
 Default construct, no profiling trigger. More...
 
 profilingTrigger (const char *name)
 Construct profiling with given description. More...
 
 profilingTrigger (const std::string &name)
 Construct profiling with given description. More...
 
 ~profilingTrigger ()
 Destructor. More...
 
bool running () const noexcept
 True if the triggered profiling is active. More...
 
void stop ()
 Stop triggered profiling. More...
 

Detailed Description

Triggers for starting/stopping code profiling.

Source files

Definition at line 50 of file profilingTrigger.H.

Constructor & Destructor Documentation

◆ profilingTrigger() [1/4]

profilingTrigger ( const profilingTrigger )
delete

No copy construct.

◆ profilingTrigger() [2/4]

profilingTrigger ( )
noexcept

Default construct, no profiling trigger.

Definition at line 138 of file profilingTrigger.C.

◆ profilingTrigger() [3/4]

profilingTrigger ( const char *  name)
explicit

Construct profiling with given description.

Descriptions beginning with 'application::' are reserved for internal use.

Definition at line 144 of file profilingTrigger.C.

◆ profilingTrigger() [4/4]

profilingTrigger ( const std::string &  name)
explicit

Construct profiling with given description.

Descriptions beginning with 'application::' are reserved for internal use.

Definition at line 150 of file profilingTrigger.C.

References Foam::name().

Here is the call graph for this function:

◆ ~profilingTrigger()

Destructor.

Definition at line 162 of file profilingTrigger.C.

Member Function Documentation

◆ operator=()

void operator= ( const profilingTrigger )
delete

No copy assignment.

◆ running()

bool running ( ) const
noexcept

True if the triggered profiling is active.

Definition at line 170 of file profilingTrigger.C.

◆ stop()

void stop ( )

Stop triggered profiling.

Definition at line 176 of file profilingTrigger.C.

References profiling::unstack().

Here is the call graph for this function:

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