Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Protected Member Functions | List of all members
datatools::ocd_driver Class Reference

The OCD manual application. More...

#include <bayeux/datatools/ocd_driver.h>

Public Member Functions

 ocd_driver ()
 Constructor. More...
 
virtual ~ocd_driver ()
 Destructor. More...
 
bool is_initialized () const
 Check initialization status. More...
 
void initialize (const ocd_driver_params &params_)
 Initialization. More...
 
int run ()
 Run. More...
 
void reset ()
 Reset. More...
 

Protected Member Functions

void _run_interactive ()
 Interactive session. More...
 
int _run_action ()
 Run the requested action. More...
 
int _run_list (std::ostream &out_=std::cout, std::ostream &log_=std::clog)
 Run the 'list' action. More...
 
int _run_show (const std::string &class_id_, std::ostream &out_=std::cout)
 Run the 'show' action. More...
 
int _run_generate_skeleton (const std::string &class_id_, const std::string &path_="")
 Run the 'generate skeleton' action. More...
 
int _run_validate (const std::string &class_id_, const std::string &path_)
 Run the 'validate' action. More...
 

Detailed Description

The OCD manual application.

Constructor & Destructor Documentation

◆ ocd_driver()

datatools::ocd_driver::ocd_driver ( )

Constructor.

◆ ~ocd_driver()

virtual datatools::ocd_driver::~ocd_driver ( )
virtual

Destructor.

Member Function Documentation

◆ _run_action()

int datatools::ocd_driver::_run_action ( )
protected

Run the requested action.

◆ _run_generate_skeleton()

int datatools::ocd_driver::_run_generate_skeleton ( const std::string &  class_id_,
const std::string &  path_ = "" 
)
protected

Run the 'generate skeleton' action.

◆ _run_interactive()

void datatools::ocd_driver::_run_interactive ( )
protected

Interactive session.

◆ _run_list()

int datatools::ocd_driver::_run_list ( std::ostream &  out_ = std::cout,
std::ostream &  log_ = std::clog 
)
protected

Run the 'list' action.

◆ _run_show()

int datatools::ocd_driver::_run_show ( const std::string &  class_id_,
std::ostream &  out_ = std::cout 
)
protected

Run the 'show' action.

◆ _run_validate()

int datatools::ocd_driver::_run_validate ( const std::string &  class_id_,
const std::string &  path_ 
)
protected

Run the 'validate' action.

◆ initialize()

void datatools::ocd_driver::initialize ( const ocd_driver_params params_)

Initialization.

◆ is_initialized()

bool datatools::ocd_driver::is_initialized ( ) const

Check initialization status.

◆ reset()

void datatools::ocd_driver::reset ( )

Reset.

◆ run()

int datatools::ocd_driver::run ( )

Run.


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