tesseract  4.0.0-1-g2a2b
tesseract::Param Class Reference

#include <params.h>

Inheritance diagram for tesseract::Param:
tesseract::BoolParam tesseract::DoubleParam tesseract::IntParam tesseract::StringParam

Public Member Functions

 ~Param ()=default
 
const char * name_str () const
 
const char * info_str () const
 
bool is_init () const
 
bool is_debug () const
 
bool constraint_ok (SetParamConstraint constraint) const
 

Protected Member Functions

 Param (const char *name, const char *comment, bool init)
 

Protected Attributes

const char * name_
 
const char * info_
 
bool init_
 
bool debug_
 

Detailed Description

Definition at line 112 of file params.h.

Constructor & Destructor Documentation

◆ ~Param()

tesseract::Param::~Param ( )
default

◆ Param()

tesseract::Param::Param ( const char *  name,
const char *  comment,
bool  init 
)
inlineprotected

Definition at line 131 of file params.h.

131  :
132  name_(name), info_(comment), init_(init) {
133  debug_ = (strstr(name, "debug") != nullptr) || (strstr(name, "display"));
134  }
const char * info_
Definition: params.h:137
const char * name_
Definition: params.h:136

Member Function Documentation

◆ constraint_ok()

bool tesseract::Param::constraint_ok ( SetParamConstraint  constraint) const
inline

Definition at line 120 of file params.h.

120  {
121  return (constraint == SET_PARAM_CONSTRAINT_NONE ||
122  (constraint == SET_PARAM_CONSTRAINT_DEBUG_ONLY &&
123  this->is_debug()) ||
124  (constraint == SET_PARAM_CONSTRAINT_NON_DEBUG_ONLY &&
125  !this->is_debug()) ||
126  (constraint == SET_PARAM_CONSTRAINT_NON_INIT_ONLY &&
127  !this->is_init()));
128  }
bool is_init() const
Definition: params.h:118
bool is_debug() const
Definition: params.h:119

◆ info_str()

const char* tesseract::Param::info_str ( ) const
inline

Definition at line 117 of file params.h.

117 { return info_; }
const char * info_
Definition: params.h:137

◆ is_debug()

bool tesseract::Param::is_debug ( ) const
inline

Definition at line 119 of file params.h.

119 { return debug_; }

◆ is_init()

bool tesseract::Param::is_init ( ) const
inline

Definition at line 118 of file params.h.

118 { return init_; }

◆ name_str()

const char* tesseract::Param::name_str ( ) const
inline

Definition at line 116 of file params.h.

116 { return name_; }
const char * name_
Definition: params.h:136

Member Data Documentation

◆ debug_

bool tesseract::Param::debug_
protected

Definition at line 139 of file params.h.

◆ info_

const char* tesseract::Param::info_
protected

Definition at line 137 of file params.h.

◆ init_

bool tesseract::Param::init_
protected

Definition at line 138 of file params.h.

◆ name_

const char* tesseract::Param::name_
protected

Definition at line 136 of file params.h.


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