JayBeams  0.1
Another project to have fun coding.
Public Member Functions | Public Attributes | List of all members
jb::book_depth_statistics::config Class Reference

Configure a book_depth_statistics object. More...

#include <book_depth_statistics.hpp>

Inheritance diagram for jb::book_depth_statistics::config:
jb::config_object

Public Member Functions

 config ()
 
 config_object_constructors (config)
 
void validate () const override
 Validate the configuration. More...
 
- Public Member Functions inherited from jb::config_object
 config_object ()
 Default constructor. More...
 
 config_object (config_object const &rhs)
 Copy constructor. More...
 
 config_object (config_object &&rhs)
 Move constructor. More...
 
virtual ~config_object ()
 Destructor. More...
 
config_objectoperator= (config_object rhs)
 Copy & swap assignment. More...
 
void swap (config_object &rhs)
 Derived classes should implement member by member swap. More...
 
void load_overrides (int &argc, char *argv[], std::string const &filename, char const *environment_variable_name)
 Read the configuration file and load the overrides defined therein. More...
 
void load_overrides (int &argc, char *argv[], std::string const &filename)
 Read the configuration file and load the overrides defined therein. More...
 
void load_overrides (int &argc, char *argv[], std::istream &is)
 Read the configuration file and load the overrides defined therein. More...
 
void process_cmdline (int &argc, char *argv[])
 Process the command line. More...
 
std::ostream & to_stream (std::ostream &os) const
 Print out the settings. More...
 

Public Attributes

jb::config_attribute< config, book_depth_tmax_book_depth
 No more than this value is recorded. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from jb::config_object
static attribute_descriptor desc (std::string const &name)
 Convenience function to create attribute descriptors with less typing. More...
 
static attribute_descriptor desc (std::string const &name, std::string const &class_name)
 Convenience function to create attribute descriptors with less typing. More...
 

Detailed Description

Configure a book_depth_statistics object.

Definition at line 70 of file book_depth_statistics.hpp.

Constructor & Destructor Documentation

◆ config()

jb::book_depth_statistics::config::config ( )

Definition at line 76 of file book_depth_statistics.cpp.

Member Function Documentation

◆ config_object_constructors()

jb::book_depth_statistics::config::config_object_constructors ( config  )

◆ validate()

void jb::book_depth_statistics::config::validate ( ) const
overridevirtual

Validate the configuration.

Reimplemented from jb::config_object.

Definition at line 87 of file book_depth_statistics.cpp.

References max_book_depth.

Member Data Documentation

◆ max_book_depth

jb::config_attribute<config, book_depth_t> jb::book_depth_statistics::config::max_book_depth

No more than this value is recorded.

Definition at line 79 of file book_depth_statistics.hpp.

Referenced by validate().


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