Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
CommandLineArguments.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef COMMANDLINEARGUMENTS_HPP_
37#define COMMANDLINEARGUMENTS_HPP_
38
39#include "Exception.hpp"
40#include <vector>
41#include <boost/utility.hpp>
42
62class CommandLineArguments : private boost::noncopyable
63{
64private:
65
68
71
78 int GetIndexForArgument(std::string rOption);
79
85 void TestOptionFormat(const std::string& rOption);
86
87public:
88
90 int* p_argc;
91
93 char*** p_argv;
94
97
103 bool OptionExists(const std::string& rOption);
104
114 int GetNumberOfArgumentsForOption(const std::string& rOption, bool throwIfNone=false);
115
130 char* GetValueCorrespondingToOption(const std::string& rOption, int valueNumber=1);
131
140 double GetDoubleCorrespondingToOption(const std::string& rOption, int valueNumber=1);
141
150 int GetIntCorrespondingToOption(const std::string& rOption, int valueNumber=1);
151
161 unsigned GetUnsignedCorrespondingToOption(const std::string& rOption, int valueNumber=1);
162
171 std::string GetStringCorrespondingToOption(const std::string& rOption, int valueNumber=1);
172
180 std::vector<std::string> GetStringsCorrespondingToOption(const std::string& rOption);
181
189 std::vector<double> GetDoublesCorrespondingToOption(const std::string& rOption);
190
198 std::vector<int> GetIntsCorrespondingToOption(const std::string& rOption);
199
207 std::vector<unsigned> GetUnsignedsCorrespondingToOption(const std::string& rOption);
208
216 bool GetBoolCorrespondingToOption(const std::string& rOption);
217};
218
219#endif // COMMANDLINEARGUMENTS_HPP_
bool OptionExists(const std::string &rOption)
static CommandLineArguments * Instance()
static CommandLineArguments * mpInstance
std::vector< double > GetDoublesCorrespondingToOption(const std::string &rOption)
std::string GetStringCorrespondingToOption(const std::string &rOption, int valueNumber=1)
int GetIndexForArgument(std::string rOption)
std::vector< std::string > GetStringsCorrespondingToOption(const std::string &rOption)
int GetIntCorrespondingToOption(const std::string &rOption, int valueNumber=1)
std::vector< unsigned > GetUnsignedsCorrespondingToOption(const std::string &rOption)
double GetDoubleCorrespondingToOption(const std::string &rOption, int valueNumber=1)
unsigned GetUnsignedCorrespondingToOption(const std::string &rOption, int valueNumber=1)
bool GetBoolCorrespondingToOption(const std::string &rOption)
char * GetValueCorrespondingToOption(const std::string &rOption, int valueNumber=1)
int GetNumberOfArgumentsForOption(const std::string &rOption, bool throwIfNone=false)
std::vector< int > GetIntsCorrespondingToOption(const std::string &rOption)
void TestOptionFormat(const std::string &rOption)