MeVisLab Toolbox Reference
mlMultiFileVolumeAdditionalOptions.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
6 
11 //----------------------------------------------------------------------------------
12 
13 #pragma once
14 
16 #include <mlModuleIncludes.h>
17 
18 ML_START_NAMESPACE
19 
25 public:
28 
30 
32  void reset();
33 
35  bool operator==(const MultiFileVolumeAdditionalOptions& other) const;
36 
38  bool operator!=(const MultiFileVolumeAdditionalOptions& other) const;
39 
41  size_t getNumberOfOptions() const;
42 
52  size_t findOption(const std::string &optionName, bool optionNameMustMatch,
53  const std::string &optionType, bool optionTypeMustMatch,
54  const std::string &optionValue, bool optionValueMustMatch) const;
55 
64  void appendOption(const std::string& optionName,
65  const std::string& optionType,
66  const std::string& optionValue);
67 
80  MLErrorCode getOption(size_t index,
81  std::string& optionName,
82  std::string& optionType,
83  std::string& optionValue) const;
84 
86  std::string toString() const;
87 
96  MLErrorCode fromString(const std::string& state, size_t& readPos);
97 
98 private:
100  std::vector< std::vector< std::string > > _options;
101 };
102 
103 ML_END_NAMESPACE
Project global and OS specific declarations.
#define MLMULTI_FILE_VOLUME_EXPORT
Only for diagnostic purposes.
Container which stores additional options for MultiFileVolumes which can have an arbitrary number of ...
MLErrorCode getOption(size_t index, std::string &optionName, std::string &optionType, std::string &optionValue) const
Return contents of the option at position index from the container.
size_t findOption(const std::string &optionName, bool optionNameMustMatch, const std::string &optionType, bool optionTypeMustMatch, const std::string &optionValue, bool optionValueMustMatch) const
Returns the index of the first option matching the method arguments.
MultiFileVolumeAdditionalOptions()
Creates an empty container.
size_t getNumberOfOptions() const
Returns number of options currently stored in the container.
bool operator!=(const MultiFileVolumeAdditionalOptions &other) const
Compares *this and other, returns true on inequality, false otherwise.
std::string toString() const
Converts *this to a std::string and returns it.
MLErrorCode fromString(const std::string &state, size_t &readPos)
Reads a complete instance of this from state at position readPos; readPos is incremented to position ...
bool operator==(const MultiFileVolumeAdditionalOptions &other) const
Compares *this and other, returns true on equality, false otherwise.
void appendOption(const std::string &optionName, const std::string &optionType, const std::string &optionValue)
Appends a new option to the container.
void reset()
Clears all options and resets the instance to the construction state.
MLint32 MLErrorCode
Type of an ML Error code.
Definition: mlTypeDefs.h:818