BALL::ParameterDescription Struct Reference

#include <BALL/FORMAT/paramFile.h>

Public Member Functions
	ParameterDescription ()

Public Attributes
String	name
String	description
String	category
bool	mandatory
bool	advanced
ParameterType	type
String	output_format_source
list< String >	allowed_values
list< String >	supported_formats
bool	hidden

Detailed Description

Definition at line 42 of file paramFile.h.

Constructor & Destructor Documentation

BALL::ParameterDescription::ParameterDescription ( )

inline

Definition at line 45 of file paramFile.h.

Member Data Documentation

bool BALL::ParameterDescription::advanced

Definition at line 63 of file paramFile.h.

list<String> BALL::ParameterDescription::allowed_values

If this list is empty, then there are no restrictions on the value of the parameter

Definition at line 71 of file paramFile.h.

String BALL::ParameterDescription::category

Definition at line 61 of file paramFile.h.

String BALL::ParameterDescription::description

Definition at line 60 of file paramFile.h.

bool BALL::ParameterDescription::hidden

Definition at line 78 of file paramFile.h.

bool BALL::ParameterDescription::mandatory

Definition at line 62 of file paramFile.h.

String BALL::ParameterDescription::name

Definition at line 57 of file paramFile.h.

String BALL::ParameterDescription::output_format_source

In case of ouput-files, this variable allows to specify the name of an input-parameter, whose format should be used as ouput-format.
Note, that this variable will be used only for the creation of config-files for workflow-systems (Galaxy, Knime, etc.) and not for the command-line interface, where the user will directly specify output-filenames.

Definition at line 68 of file paramFile.h.

list<String> BALL::ParameterDescription::supported_formats

In case of input-/output-files, this list should contain the supported file-extensions.
If the list is empty, no format restrictions are set.

Definition at line 75 of file paramFile.h.

ParameterType BALL::ParameterDescription::type

Definition at line 64 of file paramFile.h.