AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
|
Functions | |
std::string | indexToString (const std::string &idx) |
An overloaded utility function for converting a type to a string. More... | |
std::string | indexToString (const int idx) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
std::string | indexToString (const VariantKey &idx) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
template<typename Result , typename From > | |
Result | toIndex (const From &idx) |
An templated utility function for converting an index to the desired type. More... | |
template<> | |
int | toIndex (const std::string &idx) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
template<typename Key > | |
bool | matchesKeyType (const VariantKey &key) |
Determines whether a variant key is convertible to another type. More... | |
std::vector< VariantKey > | collectionIndices (const Container &container, bool trimAbsolute=true) |
This is an internal utility intended to be used with arrays/dicts of user-defined types that returns the indices as strings - integer indices will be converted to strings. More... | |
std::vector< std::pair< std::string, std::string > > | collectionIndicesWithPaths (const Container &container, const std::string &name) |
This is an internal utility intended to be used with arrays of user-defined types that returns the a list of pairs, each of which contain an index (a number) and a fully qualified path within the input file to the array element at the corresponding index. More... | |
void | updateUnexpectedNames (const std::string &accessedName, std::vector< std::string > &unexpectedNames) |
Updates the set of unexpected names to reflect an user-requested access. More... | |
template<typename Func > | |
void | destroy_func_inst (FunctionBuffer *function_storage) |
template<> | |
void | destroy_func_inst< void > (FunctionBuffer *) |
Variables | |
static constexpr std::size_t | MAX_NUM_ARGS = 2u |
const std::string | COLLECTION_GROUP_NAME = "_inlet_collection" |
const std::string | COLLECTION_INDICES_NAME = "_inlet_collection_indices" |
const std::string | STRUCT_COLLECTION_FLAG = "_inlet_struct_collection" |
const std::string | REQUIRED_FLAG = "required" |
const std::string | STRICT_FLAG = "strict" |
|
inline |
An overloaded utility function for converting a type to a string.
[in] | idx | The index to convert to string |
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
References indexToString(), axom::inlet::String, and axom::inlet::VariantKey::type().
|
inline |
An templated utility function for converting an index to the desired type.
[in] | idx | The index to convert |
From | The type of the idx parameter (converting from) |
Result | The type to convert to |
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
References SLIC_ERROR_IF.
bool axom::inlet::detail::matchesKeyType | ( | const VariantKey & | key | ) |
Determines whether a variant key is convertible to another type.
Key | The type to check the validity of the conversion to |
References axom::inlet::Integer, axom::inlet::String, and axom::inlet::VariantKey::type().
std::vector<VariantKey> axom::inlet::detail::collectionIndices | ( | const Container & | container, |
bool | trimAbsolute = true |
||
) |
This is an internal utility intended to be used with arrays/dicts of user-defined types that returns the indices as strings - integer indices will be converted to strings.
[in] | container | The container to retrieve indices from |
[in] | trimAbsolute | Whether to only return the "basename" if the path is absolute, e.g., an absolute path foo/0/bar will be trimmed to "bar" |
std::vector<std::pair<std::string, std::string> > axom::inlet::detail::collectionIndicesWithPaths | ( | const Container & | container, |
const std::string & | name | ||
) |
This is an internal utility intended to be used with arrays of user-defined types that returns the a list of pairs, each of which contain an index (a number) and a fully qualified path within the input file to the array element at the corresponding index.
[in] | container | The container to retrieve indices from |
[in] | name | The name of the array object in the input file |
void axom::inlet::detail::updateUnexpectedNames | ( | const std::string & | accessedName, |
std::vector< std::string > & | unexpectedNames | ||
) |
Updates the set of unexpected names to reflect an user-requested access.
[in] | accessedName | The path within the input file that will be accessed |
[in,out] | unexpectedNames | The set of input file paths that have not yet been requested by the user |
|
inline |
|
inline |
|
staticconstexpr |
const std::string axom::inlet::detail::COLLECTION_GROUP_NAME = "_inlet_collection" |
Names of the internal collection data and collection index groups/fields used for managing arrays/dictionaries
const std::string axom::inlet::detail::COLLECTION_INDICES_NAME = "_inlet_collection_indices" |
const std::string axom::inlet::detail::STRUCT_COLLECTION_FLAG = "_inlet_struct_collection" |
const std::string axom::inlet::detail::REQUIRED_FLAG = "required" |
const std::string axom::inlet::detail::STRICT_FLAG = "strict" |