FDR::Option Class Reference

A setting for FDR. More...

#include <option.h>

List of all members.

Public Member Functions

virtual std::vector< std::string > allowed_values () const =0
 The values that the option is allowed to take.
virtual std::string default_value () const =0
 The default value of this option.
virtual std::string description () const =0
 A human-readable description of the option.
virtual std::string get () const =0
 The current value of this option.
virtual std::string name () const =0
 The current value of the option.
virtual void set (const std::string &new_value)=0
 Sets the value of the option.

Static Public Member Functions

static const std::shared_ptr
< Option > & 
get_option (const std::string &option_name)
 Returns the Option with the specified name.
static const std::vector
< std::shared_ptr< Option > > & 
options ()
 Returns a list of all the options available.

Detailed Description

A setting for FDR.

See https://www.cs.ox.ac.uk/projects/fdr/manual/gui/options.html for a description of the standard options that are accepted.


Member Function Documentation

virtual std::vector<std::string> FDR::Option::allowed_values (  )  const [pure virtual]

The values that the option is allowed to take.

Note that this list may be empty in the case of options for which there is no finite set of allowed values.

static const std::shared_ptr<Option>& FDR::Option::get_option ( const std::string &  option_name  )  [static]

Returns the Option with the specified name.

Exceptions:
UnknownOptionError if the option is unknown.
virtual void FDR::Option::set ( const std::string &  new_value  )  [pure virtual]

Sets the value of the option.

Parameters:
new_value The value to set it to.
Exceptions:
DisallowedOptionValueError if the option value is not allowed.

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

Generated on 27 Oct 2017 for FDR by  doxygen 1.6.1