CmdArgs subclass for creativity-data arguments (for generating data from crstate files). More...

#include <creativity/cmdargs/Data.hpp>

Public Member Functions
	Data ()
	Constructor for data arguments; takes no arguments.

virtual std::string	usage () const override
	Overridden to add " CRSTATE [CRSTATE ...]".

virtual std::string	help () const override
	Overridden to add info about input files.

virtual std::string	versionSuffix () const override
	Overridden to add " -- simulation data collector".

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
struct {
eris::eris_time_t piracy_begins = 0
	If non-zero, this verifies that given crstate data files have the same piracy_begins parameter.

eris::eris_time_t periods = 0
	If non-zero, verify the total number of simulation periods.

eris::eris_time_t policy_begins = 0
	If non-zero, verify the policy_begins of given simulations.

}	verify
	Struct for storing –verify-* options.

struct {
bool piracy = false
	Skip piracy data if true.

bool policy = false
	Skip policy phase data if true.

bool short_run = false
	Skip short-run effects.

}	skip
	Struct for storing –skip-* options.

bool	human_readable = false
	If true, produce output in human-readable format; otherwise CSV output.

bool	no_csv_header = false
	If true, suppress the CSV header (doesn't apply when `human_readable` is true).

bool	only_csv_header = false
	If true, only output the CSV header (no files may be specified).

unsigned int	data_periods = 25
	The number of periods to use to calculate average values.

unsigned int	double_precision = std::numeric_limits<double>::max_digits10
	The precision of double values. The default is full double precision.

unsigned int	threads = 0
	Number of threads to use.

unsigned int	preload = 0
	Number of files to preload from disk into memory.

std::vector< std::string >	input
	The input files to load data from.

bool	memory_xz = false
	If true, decompress xz files into memory (note that decompression into memory happens with `preload > 0` regardless of this option). More...

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.

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 change default precision to 8 if `--human-readable` is specified (and `--precision` isn't).

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.