axom::inlet::VariantStructCollection< Variant > Class Template Reference

Helper for defining collections whose entries are selected from a finite set of user-defined struct types. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/inlet/Container.hpp>

Public Member Functions
template<typename Alternative , typename SchemaDefiner >
VariantStructCollection &	addAlternative (const std::string &label, SchemaDefiner &&defineSchema)
	Add a struct alternative to this variant collection. More...
Container &	collection ()
template<typename Alternative , typename SchemaDefiner >
VariantStructCollection< Variant > &	addAlternative (const std::string &label, SchemaDefiner &&defineSchema)

Friends
class	Container

Detailed Description

template<typename Variant>
class axom::inlet::VariantStructCollection< Variant >

Helper for defining collections whose entries are selected from a finite set of user-defined struct types.

Member Function Documentation

addAlternative() [1/2]

template<typename Variant >

template<typename Alternative , typename SchemaDefiner >

VariantStructCollection& axom::inlet::VariantStructCollection< Variant >::addAlternative	(	const std::string &	label,
		SchemaDefiner &&	defineSchema
	)

Add a struct alternative to this variant collection.

Parameters

[in]	label	Discriminator value selecting this alternative
[in]	defineSchema	Callable accepting a Container& and defining the schema for the selected alternative

Template Parameters

Alternative

One of the types held by the Variant

collection()

template<typename Variant >

Container& axom::inlet::VariantStructCollection< Variant >::collection ( )

inline

addAlternative() [2/2]

template<typename Variant >

template<typename Alternative , typename SchemaDefiner >

VariantStructCollection<Variant>& axom::inlet::VariantStructCollection< Variant >::addAlternative	(	const std::string &	label,
		SchemaDefiner &&	defineSchema
	)

References axom::inlet::detail::collectionIndices(), axom::inlet::detail::indexToString(), and axom::inlet::Container::isUserProvided().

Friends And Related Function Documentation

Container

template<typename Variant >

friend class Container

friend

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/inlet/Container.hpp