CmdArgs subclass for creativity-info script to display simulation information. More...
#include <creativity/cmdargs/Info.hpp>
Public Member Functions | |
| virtual std::string | usage () const override |
| Overridden to add " FILENAME". | |
| virtual std::string | help () const override |
| Overridden to add info about the input file. | |
| virtual std::string | versionSuffix () const override |
| Overridden to add " -- simulation detail viewer". | |
 Public Member Functions inherited from creativity::cmdargs::CmdArgs | |
| void | parse (int argc, char const *const *argv) |
| Parses options and verifies them. More... | |
| template<typename T , typename A > | |
| std::enable_if< not std::is_unsigned< T >::value, boost::program_options::typed_value< std::vector< T, A > > * >::type | value (std::vector< T, A > &store) |
| Takes a std::vector of values for options that store multiple values. More... | |
| template<typename T , typename A > | |
| std::enable_if< std::is_unsigned< T >::value, boost::program_options::typed_value< std::vector< Validation< T > > > * >::type | value (std::vector< T, A > &store) |
| Takes a std::vector of values for options that store multiple values. More... | |
| virtual std::string | version () const |
| Returns a version string. | |
Public Attributes | |
| unsigned int | output_precision = 6 |
| The number of significant digits in output values. | |
| std::string | input |
| The input file to load data from. | |
| bool | memory_xz = false |
| If true, decompress xz files into memory. | |
| std::string | tmpdir |
| If memory_xz is false, decompress files into temporary files in this directory instead of into the same directory as the input file. | |
| unsigned int | thin_periods = 10 |
Show every nth period (where this value is n). 0 means don't show any. | |
| bool | show_cli_args = false |
| Show CLI usage to recreate experiment. | |
Protected Member Functions | |
| virtual void | addOptions () override |
| Adds data collector command-line options into the option descriptions. | |
| virtual void | postParse (boost::program_options::variables_map &vars) override |
| Overridden to make sure the input file is specified and non-empty. | |
| Protected Member Functions inherited from creativity::cmdargs::CmdArgs | |
| CmdArgs ()=default | |
| Default constructor is protected; use a suitable subclass. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from creativity::cmdargs::CmdArgs | |
| template<typename T > | |
| static std::enable_if< not std::is_unsigned< T >::value and not std::is_same< T, bool >::value, boost::program_options::typed_value< T > *>::type | value (T &store) |
| Creates an option value object without any special validation wrapper class. More... | |
| template<typename T > | |
| static std::enable_if< std::is_unsigned< T >::value and not std::is_same< T, bool >::value, boost::program_options::typed_value< Validation< T > > * >::type | value (T &storage) |
| Creates an option value object around an unsigned primitive type, with automatic value storage and default value. More... | |
| static boost::program_options::typed_value< bool > * | value (bool &store) |
Creates an option value for a boolean value, that is, for an switch without an argument, with default value as given in store. | |
| template<typename V > | |
| static boost::program_options::typed_value< V > * | value (typename V::value_type &store) |
| Creates an option value object with explicit validation wrapper class V. More... | |
| template<typename V , typename A > | |
| static boost::program_options::typed_value< std::vector< V > > * | value (std::vector< typename V::value_type, A > &store) |
| Creates an option value object around a vector of options with validation wrapper class V applied to each element of the vector. More... | |
| template<long minimum, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Min< T, minimum, denom > > * | min (T &store) |
Shortcut for value<Min<T, n, d>>(val) with T last (so that it can be inferred from val) | |
| template<long maximum, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Max< T, maximum, denom > > * | max (T &store) |
Shortcut for value<Max<T, n, d>>(val) with T last (so that it can be inferred from val) | |
| template<long min, long max, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Range< T, min, max, denom > > * | range (T &store) |
Shortcut for value<Range<T, a, b, d>>(val) with T last (so that it can be inferred from val) | |
| template<long lower, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Above< T, lower, denom > > * | above (T &store) |
Shortcut for value<Above<T, a, d>>(val) with T last (so that it can be inferred from val) | |
| template<long upper, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Below< T, upper, denom > > * | below (T &store) |
Shortcut for value<Below<T, b, d>>(val) with T last (so that it can be inferred from val) | |
| Protected Attributes inherited from creativity::cmdargs::CmdArgs | |
| std::string | prog_name_ |
| The program name, populated by parse(). More... | |
| boost::program_options::options_description | options_ |
| The options descriptions variable for all options. | |
| boost::program_options::options_description | invisible_ |
| Like options_, but for hidden options that aren't to be displayed in –help output. | |
| boost::program_options::positional_options_description | positional_ |
| Positional options object. | |
Detailed Description
CmdArgs subclass for creativity-info script to display simulation information.
Inheritance diagram for creativity::cmdargs::Info:
Collaboration diagram for creativity::cmdargs::Info:
The documentation for this class was generated from the following file:
- creativity/cmdargs/Info.hpp
