Simple struct to hold information about correlation parameters. More...

#include <DICe.h>

Public Member Functions
	Correlation_Parameter (const std::string &name, const Correlation_Parameter_Type &type, const bool expose_to_user=true, const std::string &desc="No description", const char **stringNames=0, const int_t size=0)
	Only constructor with several optional arguments. More...

Public Attributes
std::string	name_
	Name of the parameter (what will be used from the input file if specified)

Correlation_Parameter_Type	type_
	Type of parameter (bool, size, real, string)

const char **	stringNamePtr_
	Pointer to the string names of all the options.

int_t	size_
	The number of potential options.

std::string	desc_
	Short description of the correlation parameter.

bool	expose_to_user_
	Determines if this param shows up in the template input files exposed to the user.

Detailed Description

Simple struct to hold information about correlation parameters.

Constructor & Destructor Documentation

DICe::Correlation_Parameter::Correlation_Parameter	(	const std::string &	name,
		const Correlation_Parameter_Type &	type,
		const bool	expose_to_user = `true`,
		const std::string &	desc = `"No description"`,
		const char **	stringNames = `0`,
		const int_t	size = `0`
	)

inline

Only constructor with several optional arguments.

Parameters

name	The string name of the correlation parameter
type	Defines if this is a bool, string, integer value, etc.
expose_to_user	Signifies that this should be included when template input files are made
desc	Correlation parameter description
stringNames	Pointer to the array of string names for this parameter if this is a string parameter, otherwise null pointer
size	The number of available options for this correlation parameter