|
Gromacs
2022.2
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Gromacs
2022.2
|
#include <gromacs/options/filenameoption.h>
Inheritance diagram for gmx::FileNameOptionInfo: Collaboration diagram for gmx::FileNameOptionInfo:Wrapper class for accessing file name option information.
Public Types | |
| typedef std::vector< const char * > | ExtensionList |
| Shorthand for a list of extensions. | |
Public Member Functions | |
| FileNameOptionInfo (FileNameOptionStorage *option) | |
| Creates an option info object for the given option. | |
| bool | isInputFile () const |
| Whether the option specifies an input file. | |
| bool | isOutputFile () const |
| Whether the option specifies an output file. | |
| bool | isInputOutputFile () const |
| Whether the option specifies a file used for both input and output. | |
| bool | isLibraryFile () const |
| Whether the option specifies a library file. More... | |
| bool | allowMissing () const |
| Whether the (input) option allows missing files to be provided. | |
| bool | isDirectoryOption () const |
| Whether the option specifies directories. | |
| bool | isTrajectoryOption () const |
| Whether the option specifies a generic trajectory file. | |
| const char * | defaultExtension () const |
| Returns the default extension for this option. | |
| ExtensionList | extensions () const |
| Returns the list of extensions this option accepts. | |
| bool | isValidType (int fileType) const |
Returns whether fileType (from filetypes.h) is accepted for this option. | |
| ArrayRef< const int > | fileTypes () const |
| Returns the list of file types this option accepts. | |
| Public Member Functions inherited from gmx::OptionInfo | |
| template<class InfoType > | |
| bool | isType () const |
| Test whether the option is of a particular type. More... | |
| template<class InfoType > | |
| InfoType * | toType () |
| Convert the info object to a particular type if the type is correct. More... | |
| template<class InfoType > | |
| const InfoType * | toType () const |
| Convert the info object to a particular type if the type is correct. More... | |
| bool | isSet () const |
| Returns true if the option has been set. | |
| bool | isHidden () const |
| Returns true if the option is a hidden option. | |
| bool | isRequired () const |
| Returns true if the option is required. | |
| int | minValueCount () const |
| Returns the minimum number of values that this option accepts. | |
| int | maxValueCount () const |
| Returns the maximum number of values that this option accepts. | |
| const std::string & | name () const |
| Returns the name of the option. | |
| std::string | type () const |
| Returns the type of the option as a string. | |
| std::string | formatDescription () const |
| Returns the description of the option. | |
| std::vector< Any > | defaultValues () const |
| Returns the default value(s) of the option. More... | |
| std::vector< std::string > | defaultValuesAsStrings () const |
| Returns the default value(s) of the option as strings. More... | |
| std::vector< Any > | normalizeValues (const std::vector< Any > &values) const |
| Converts given values to native representation for this option. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from gmx::OptionInfo | |
| OptionInfo (AbstractOptionStorage *option) | |
| Wraps a given option object. More... | |
| AbstractOptionStorage & | option () |
| Returns the wrapped option storage object. | |
| const AbstractOptionStorage & | option () const |
| Returns the wrapped option storage object. | |
| bool gmx::FileNameOptionInfo::isLibraryFile | ( | ) | const |
Whether the option specifies a library file.
1.8.5