Reference documentation for deal.II version Git e512aac53a 2019-11-15 17:29:53 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
JobIdentifier Class Reference

#include <deal.II/base/job_identifier.h>

Public Member Functions

 JobIdentifier ()
 
const std::string operator() () const
 

Static Public Member Functions

static const char * program_id ()
 
static std::string base_name (const std::string &filename)
 
static const JobIdentifierget_dealjobid ()
 

Private Attributes

std::string id
 

Detailed Description

Identification of a program run. JobIdentifier determines the start time of a program run and stores it as a program identifier. There exists a library object dealjobid of this class. This object can be accessed by all output functions to provide an id for the current job.

Definition at line 33 of file job_identifier.h.

Constructor & Destructor Documentation

◆ JobIdentifier()

JobIdentifier::JobIdentifier ( )

Constructor. Set program identifier to value of program_id concatenated with the present time.

Definition at line 36 of file job_identifier.cc.

Member Function Documentation

◆ program_id()

static const char* JobIdentifier::program_id ( )
static

This function returns an identifier for the running program. Currently, the library provides a function returning "JobID".

The user may define a replacement of this function in his source code and avoid linking the library version. Unfortunately, this mechanism does not work with shared libraries.

◆ base_name()

std::string JobIdentifier::base_name ( const std::string &  filename)
static

Obtain the base name of the filename passed as argument. That is, if the file is mypath/file.cc return just file. For example, this function can be called from a user program with argument __FILE__ to create an identifier for the program being run.

Definition at line 61 of file job_identifier.cc.

◆ operator()()

const std::string JobIdentifier::operator() ( ) const

Return the value of id.

Definition at line 54 of file job_identifier.cc.

◆ get_dealjobid()

const JobIdentifier & JobIdentifier::get_dealjobid ( )
static

Function to identify the presently running program.

Definition at line 28 of file job_identifier.cc.

Member Data Documentation

◆ id

std::string JobIdentifier::id
private

String holding the identifier of the presently running program.

Definition at line 79 of file job_identifier.h.


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