1.2.1
CCC
 
OptDbg Class Reference

#include <OptDbg.hpp>

Static Public Member Functions

static void reset ()
 
static bool queryByKey (const String &name)
 
static void defineByKey (const String &name)
 
static void undefineByKey (const String &name)
 
static bool query (const EDbg &option, bool discardForce=false)
 
static void define (const EDbg &option)
 
static void undefine (const EDbg &option)
 
static void defineAll ()
 
static void undefineAll ()
 
static void display ()
 
static void setCurrentIndex (int cur_index)
 
static bool isReferenceDefined ()
 
static void setReference (int index)
 
static int getReference ()
 
static bool force ()
 
static int getCurrentIndex ()
 

Detailed Description

Operate the list of active Debug options

Member Function Documentation

void OptDbg::define ( const EDbg &  option)
static

Switching ON a option

Parameters
optionDescription of the option (Keyword)
void OptDbg::defineAll ( void  )
static
void OptDbg::defineByKey ( const String name)
static

Switching ON a option

Parameters
nameDescription of the option (Name)
void OptDbg::display ( )
static
bool OptDbg::force ( void  )
static
static int OptDbg::getCurrentIndex ( )
inlinestatic
static int OptDbg::getReference ( )
inlinestatic
static bool OptDbg::isReferenceDefined ( )
inlinestatic
bool OptDbg::query ( const EDbg &  option,
bool  discardForce = false 
)
static

Check if a DEBUG option has been switched ON or NOT

Parameters
optionType of the option to be searched for
discardForceWhen TRUE, does not consider the "forcing" option (see remarks)
Remarks
The use of gstlearn enables the user to FORCE the switch ON of one or several debugging options. This is the case for example when you want to trace the processing of a specific target (defined using setReference). When this option is switched OFF, this specific case is not taken into account
Returns
TRUE if the option is switch ON, FALSE otherwise
bool OptDbg::queryByKey ( const String name)
static
void OptDbg::reset ( )
static
static void OptDbg::setCurrentIndex ( int  cur_index)
inlinestatic
static void OptDbg::setReference ( int  index)
inlinestatic
void OptDbg::undefine ( const EDbg &  option)
static

Switching OFF an option

Parameters
optionDescription of the Option (Keyword)
void OptDbg::undefineAll ( void  )
static
void OptDbg::undefineByKey ( const String name)
static

Switching OFF a option

Parameters
nameDescription of the option (Name)

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