Implementation of the Verifiable interface for aggregates of BaseTypes.
More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.7.0/src/axom/inlet/Verifiable.hpp>
template<typename BaseType>
class axom::inlet::AggregateVerifiable< BaseType >
Implementation of the Verifiable interface for aggregates of BaseTypes.
- Template Parameters
-
BaseType | The "base" type of the object, used for the argument type of a verifying predicate |
In practice this interface is used for the Container and Function classes.
◆ Verifier
template<typename BaseType>
A function which can verify the contents of the item being verifier. It should report any errors via INLET_VERIFICATION_WARNING, passing in the given array of errors.
◆ AggregateVerifiable()
template<typename BaseType>
◆ operator=()
template<typename BaseType>
◆ required()
template<typename BaseType>
Set the required status of this object.
Set whether this object is required, or not, to be in the input file. The default behavior is to not be required.
- Parameters
-
[in] | isRequired | Boolean value of whether object is required |
- Returns
- Reference to calling object, for chaining
Implements axom::inlet::Verifiable< BaseType >.
◆ isRequired()
template<typename BaseType>
Return the required status.
Return that this object is required, or not, to be in the input file. The default behavior is to not be required.
- Returns
- Boolean value of whether this object is required
Implements axom::inlet::Verifiable< BaseType >.
◆ registerVerifier() [1/3]
template<typename BaseType>
◆ verify()
template<typename BaseType>
Verifies the object to make sure it satisfies the imposed requirements.
- Parameters
-
[in] | errors | An optional vector of errors to append to in the case of verification failure |
Ownership is not taken of errors, the raw pointer is only used for its optional reference semantics, as opposed to something like std::optional<std::reference_wrapper<T>>
Implements axom::inlet::Verifiable< BaseType >.
◆ registerVerifier() [2/3]
template<typename BaseType>
Registers the function object that will verify this object's contents during the verification stage.
- Parameters
-
[in] | verifier | The function object. |
◆ registerVerifier() [3/3]
template<typename BaseType>
Registers the function object that will verify this object's contents during the verification stage.
- Parameters
-
[in] | verifier | The function which will verify the contents of the container. |
Implemented in axom::inlet::Container, and axom::inlet::Function.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.7.0/src/axom/inlet/Verifiable.hpp