entry_t struct
Struct for storing keyword in the input deck.
Contents
- Reference
Public functions
- auto string() const -> const std::string
- auto name() const -> const std::string
- auto shortDescription() const -> const std::string
- auto longDescription() const -> const std::string
- auto alias() const -> const std::optional<std::string>
- auto expt() const -> const std::optional<std::string>
- auto lower() const -> const std::optional<std::string>
- auto upper() const -> const std::optional<std::string>
- auto choices() const -> const std::optional<std::string>
-
auto operator<(const entry_
t& en) const -> bool - Less-than operator for ordering, used by, e.g., std::set::insert.
Function documentation
const std::string tk::
| Returns | Keyword as std::string |
|---|
Accessor to keyword as std::string
const std::string tk::
| Returns | Name of keyword as std::string |
|---|
Accessor to required short name of a keyword
const std::string tk::
| Returns | Short help as std::string |
|---|
Accessor to required short description of a keyword
const std::string tk::
| Returns | Long help as std::string |
|---|
Accessor to required long description of a keyword
const std::optional<std::string> tk::
| Returns | Null. This is a punt to fit in the existing HelpFactory infrastructure; needs to be removed. |
|---|
Alias accessor for keyword
const std::optional<std::string> tk::
| Returns | Type description for keyword |
|---|
Expected type description accessor for keyword
const std::optional<std::string> tk::
| Returns | Null. |
|---|
Expected lower bound accessor for a keyword
const std::optional<std::string> tk::
| Returns | Null. |
|---|
Expected upper bound accessor for a keyword
const std::optional<std::string> tk::
| Returns | Null. |
|---|
Expected choices description accessor for a keyword