MatrixBerryCore
Public Member Functions | Private Attributes | List of all members
mxberry::dev::prof::ProfileInfo Class Reference

PROFILEINFO contains profiling info obtaining during exectution of some code. More...

Inheritance diagram for mxberry::dev::prof::ProfileInfo:
Inheritance graph
[legend]
Collaboration diagram for mxberry::dev::prof::ProfileInfo:
Collaboration graph
[legend]

Public Member Functions

function ProfileInfo ()
 PROFILEINFO is constructor of ProfileInfo class. More...
 
function tic (in self)
 TIC starts a stopwatch timer and begins profiling. More...
 
function toc (in self)
 TOC ends profiling and stops the timer, returning the time elapsed in seconds. More...
 
function process (in self, in profCaseName)
 PROCESS processes obtained profile info. More...
 

Private Attributes

Property tStart
 
Property tElapsed
 

Detailed Description

PROFILEINFO contains profiling info obtaining during exectution of some code.

Definition at line 5 of file ProfileInfo.m.

Constructor & Destructor Documentation

◆ ProfileInfo()

function mxberry::dev::prof::ProfileInfo::ProfileInfo ( )

PROFILEINFO is constructor of ProfileInfo class.

*  Usage: self=ProfileInfo()
* 
Author
Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Member Function Documentation

◆ process()

function mxberry::dev::prof::ProfileInfo::process ( in  self,
in  profCaseName 
)

PROCESS processes obtained profile info.

*  Usage: processProfileInfo(self,profCaseName)
* 
*  input:
*    regular:
*      self: ProfileInfo [1,1] - class object
*    optional:
*      profCaseName: char [1,] - name of profiling case
*  output:
*    regular:
*      resTime: double [1,1] - time between tic and toc
* 

◆ tic()

function mxberry::dev::prof::ProfileInfo::tic ( in  self)

TIC starts a stopwatch timer and begins profiling.

*  Usage: tic(self)
* 
*  input:
*    regular:
*      self: ProfileInfo [1,1] - class object
* 

◆ toc()

function mxberry::dev::prof::ProfileInfo::toc ( in  self)

TOC ends profiling and stops the timer, returning the time elapsed in seconds.

*  Usage: resTime=toc(self)
* 
*  input:
*    regular:
*      self: ProfileInfo [1,1] - class object
*  output:
*    regular:
*      resTime: double [1,1] - time between tic and toc
* 

Member Data Documentation

◆ tElapsed

Property mxberry::dev::prof::ProfileInfo::tElapsed
private

Definition at line 15 of file ProfileInfo.m.

◆ tStart

Property mxberry::dev::prof::ProfileInfo::tStart
private

Definition at line 12 of file ProfileInfo.m.


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