Public Member Functions | Static Public Member Functions | Private Attributes

JobIdentifier Class Reference
[Utility functions and classes]

List of all members.

Public Member Functions

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

Static Public Member Functions

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

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 29 of file job_identifier.h.


Constructor & Destructor Documentation

JobIdentifier::JobIdentifier (  )

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


Member Function Documentation

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.

static std::string JobIdentifier::base_name ( const char *  filename ) [static]

Obtain the base name of the file currently being compiled. That is, if the file is mypath/file.cc return just file. Typically, this can be called from a program with the argument __FILE__ and is used in the deal.II test suite.

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

Return the value of id.


Member Data Documentation

std::string JobIdentifier::id [private]

String holding the identifier of the presently running program.

Definition at line 82 of file job_identifier.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:09 by doxygen 1.7.2