MEPP2 Project
Classes | Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
FEVV::Block Class Reference

This class may be used to draw blocks in your code. It will show the elapsed time between the begin and the end of the block. Many blocks can be used in the same time, differentiate by a unique identifier (string). More...

#include <Block.h>

Collaboration diagram for FEVV::Block:
Collaboration graph

Classes

struct  InnerData
 

Public Member Functions

 Block ()=delete
 
 Block (const Block &_Block)=delete
 
 ~Block ()=delete
 

Static Public Member Functions

static void begin (const std::string &_uid, const std::string &_message)
 
static void end (const std::string &_uid)
 

Static Protected Attributes

static std::map< std::string, Block::InnerDatablocks
 

Detailed Description

This class may be used to draw blocks in your code. It will show the elapsed time between the begin and the end of the block. Many blocks can be used in the same time, differentiate by a unique identifier (string).

class Block

The code below shows a possible use of this class.

#include "Base/Block.h"
using namespace FEVV;
// ...
{
Block::begin("my_example", "Example of Block usage.");
// ... some computation
Block::end("my_example");
}

Definition at line 40 of file Block.h.

Constructor & Destructor Documentation

◆ Block() [1/2]

FEVV::Block::Block ( )
delete

Default constructor.

Note
Disable by default.

◆ Block() [2/2]

FEVV::Block::Block ( const Block _Block)
delete

Copy constructor.

Note
Disable by default.

◆ ~Block()

FEVV::Block::~Block ( )
delete

Destructor.

Note
Disable by default.

Member Function Documentation

◆ begin()

static void FEVV::Block::begin ( const std::string &  _uid,
const std::string &  _message 
)
inlinestatic

Begin a block.

Parameters
[in]_uida unique identifier to distinguish blocks.
[in]_messagea message to draw in the standard output.

Definition at line 67 of file Block.h.

Here is the caller graph for this function:

◆ end()

static void FEVV::Block::end ( const std::string &  _uid)
inlinestatic

End a block.

Parameters
[in]_uida unique identifier to distinguish blocks.

Definition at line 100 of file Block.h.

Here is the caller graph for this function:

Member Data Documentation

◆ blocks

std::map< std::string, FEVV::Block::InnerData > FEVV::Block::blocks
staticprotected
Initial value:
=
std::map< std::string, FEVV::Block::InnerData >()

Definition at line 150 of file Block.h.


The documentation for this class was generated from the following file:
FEVV::Block::begin
static void begin(const std::string &_uid, const std::string &_message)
Definition: Block.h:67
FEVV::Block::end
static void end(const std::string &_uid)
Definition: Block.h:100
FEVV
Interfaces for plugins These interfaces will be used for different plugins.
Definition: Assert.h:16
Block.h