Public Member Functions |
| DECLARE_STD_EXCEPTION (OPTION_ALREADY_REGISTERED) |
virtual const RegOptionsList & | RegisteredOptionsList () const |
| Giving access to iteratable representation of the registered options.
|
|
| RegisteredOptions () |
| Constructors / Destructors.
|
virtual | ~RegisteredOptions () |
| Standard Destructor.
|
|
virtual void | SetRegisteringCategory (const std::string ®istering_category) |
| Methods to interact with registered options.
|
virtual std::string | RegisteringCategory () |
| retrieve the value of the current registering category
|
virtual void | AddNumberOption (const std::string &name, const std::string &short_description, Number default_value, const std::string &long_description="") |
| Add a Number option (with no restrictions)
|
virtual void | AddLowerBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool strict, Number default_value, const std::string &long_description="") |
| Add a Number option (with a lower bound)
|
virtual void | AddUpperBoundedNumberOption (const std::string &name, const std::string &short_description, Number upper, bool strict, Number default_value, const std::string &long_description="") |
| Add a Number option (with a upper bound)
|
virtual void | AddBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool lower_strict, Number upper, bool upper_strict, Number default_value, const std::string &long_description="") |
| Add a Number option (with a both bounds)
|
virtual void | AddIntegerOption (const std::string &name, const std::string &short_description, Index default_value, const std::string &long_description="") |
| Add a Integer option (with no restrictions)
|
virtual void | AddLowerBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index default_value, const std::string &long_description="") |
| Add a Integer option (with a lower bound)
|
virtual void | AddUpperBoundedIntegerOption (const std::string &name, const std::string &short_description, Index upper, Index default_value, const std::string &long_description="") |
| Add a Integer option (with a upper bound)
|
virtual void | AddBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index upper, Index default_value, const std::string &long_description="") |
| Add a Integer option (with a both bounds)
|
virtual void | AddStringOption (const std::string &name, const std::string &short_description, const std::string &default_value, const std::vector< std::string > &settings, const std::vector< std::string > &descriptions, const std::string &long_description="") |
| Add a String option (with no restrictions)
|
virtual void | AddStringOption1 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &long_description="") |
| Methods that make adding string options with only a few entries easier.
|
virtual void | AddStringOption2 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption3 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption4 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption5 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption6 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption7 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption8 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption9 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &setting9, const std::string &description9, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual void | AddStringOption10 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &setting9, const std::string &description9, const std::string &setting10, const std::string &description10, const std::string &long_description="") |
| Methods to interact with registered options.
|
virtual SmartPtr< const
RegisteredOption > | GetOption (const std::string &name) |
| Get a registered option - this will return NULL if the option does not exist.
|
virtual void | OutputOptionDocumentation (const Journalist &jnlst, std::list< std::string > &categories) |
| Output documentation for the options - gives a description, etc.
|
virtual void | OutputLatexOptionDocumentation (const Journalist &jnlst, std::list< std::string > &categories) |
| Output documentation in Latex format to include in a latex file.
|
| ReferencedObject () |
virtual | ~ReferencedObject () |
Index | ReferenceCount () const |
void | AddRef (const Referencer *referencer) const |
void | ReleaseRef (const Referencer *referencer) const |