molsim/docs/CLIParser_8h_source.html

#pragma once

#include "utils/Arguments.h"


namespace CLIParser {

void checkArgc(int argc);


void checkHelpString(int argc, char **argv);


void checkValidity(const Arguments &args);


void setDefaults(Arguments &args);


void parseArguments(int argc, char **argv, Arguments &args);

} // namespace CLIParser


Arguments.h
Configurable program and simulation arguments.

CLIParser
Namespace defining functions for parsing command line arguments.
Definition CLIParser.h:13

CLIParser::checkValidity
void checkValidity(const Arguments &args)
Checks the mathematical validity of the given arguments.

CLIParser::checkArgc
void checkArgc(int argc)
Checks if there are enough arguments passed through the command line interface.

CLIParser::setDefaults
void setDefaults(Arguments &args)
Sets default values for uninitialized Argument attributes based on the chosen Simulation type.

CLIParser::parseArguments
void parseArguments(int argc, char **argv, Arguments &args)
Parses and store CLI arguments in an Arguments struct.

CLIParser::checkHelpString
void checkHelpString(int argc, char **argv)
Checks if the help option '-h' is passed anywhere.

Arguments
Struct containing each option configurable via command line arguments.
Definition Arguments.h:31