Namespaces
	detail

Classes
class	ConduitReader
	A Reader that is able to read variables from a file compatible with one of Conduit's protocols. More...

class	Container
	Provides functions to help define how individual Container and Field variables in an input file are expected to behave. It also holds the Sidre Group to the individual Container. More...

class	Field
	Provides functions to help define how individual field variables in an input file are expected to behave. It also holds the Sidre Group to the individual field. More...

class	AggregateField
	A wrapper class that enables constraints on groups of Fields. More...

struct	FunctionType
	The types used to describe function signatures in the input file. More...

class	FunctionWrapper
	A sum type for callables with arbitrary signature. More...

class	Function

class	Inlet
	This class is the main access point for all Inlet operations from from defining the schema of the users input file to getting the values out of the Sidre DataStore. More...

struct	VerificationError
	Information on an Inlet verification error. More...

struct	InletVector
	A wrapper over Primal's Vector3D that also includes dimension information. More...

class	JSONReader
	A Reader that is able to read variables from a JSON file. More...

class	JSONSchemaWriter
	A Writer that is able to write the input file schema in JSON Schema format for a given input file. More...

class	LuaReader
	A Reader that is able to read variables from a Lua file. More...

class	Proxy
	Provides a uniform interface for access and conversion to primitive and user-defined types. More...

class	Reader
	Abstract base class defining the interface of all Reader classes. More...

class	SphinxWriter
	A Writer that is able write documentation in Sphinx RST format for a given input file. More...

class	VariantKey
	Provides a generic key type for mixed-key associative arrays/dictionaries. More...

class	Verifiable
	Interface for trivially verifiable objects - namely those that can be marked as required or checked with a user-provided lambda. More...

class	AggregateVerifiable
	Implementation of the Verifiable interface for aggregates of BaseTypes. More...

class	VerifiableScalar
	Basic interface for verifiable scalar values of Inlet primitive type, namely int, double, bool, or std::string - implementations can use this directly (inlet::Field) or forward to all elements of a collection (inlet::AggregrateField) More...

class	Writer
	Abstract base class defining the interface of all Writer classes. More...

class	YAMLReader
	A Reader that is able to read variables from a YAML file. More...

Typedefs
using	FunctionVariant = FunctionWrapper

Enumerations
enum class	FunctionTag { Vector , Double , Void , String }
	The tags used to describe function signatures in the input file. More...

enum class	ReaderResult { Success , NotFound , NotHomogeneous , WrongType }

enum class	InletType { Nothing , Bool , String , Integer , Double , Object , Collection , Function }
	Enumeration of basic types for things in inlet. More...

Functions
template<>
std::string	Field::get< std::string > () const

template<>
bool	Field::searchValidValues< std::string > (const axom::sidre::View &view, std::vector< VerificationError > *errors) const

void	setWarningFlag (axom::sidre::Group *root)
	This function is used to mark if anything went wrong during the defining phase of inlet so verify() will properly fail. More...

void	setFlag (axom::sidre::Group &target, axom::sidre::Group &root, const std::string &flag, bool value)
	This function is used to add a flag to the Inlet object corresponding to the provided Sidre group. More...

bool	checkFlag (const axom::sidre::Group &target, axom::sidre::Group &root, const std::string &flag)
	This function is used to determine the value of a flag for the Inlet object corresponding to the provided Sidre group. More...

bool	verifyRequired (const axom::sidre::Group &target, const bool condition, const std::string &type, std::vector< VerificationError > *errors=nullptr)
	This function is used to verify the required-ness of the Inlet object corresponding to the provided Sidre group. More...

bool	isCollectionGroup (const std::string &name)
	Determines whether a Container is a collection group. More...

void	markAsStructCollection (axom::sidre::Group &target)
	Marks the sidre::Group as a "struct collection" by adding a corresponding flag to the group. More...

void	markRetrievalStatus (axom::sidre::Group &target, const ReaderResult result)
	Adds a ReaderResult to a sidre::Group corresponding to an inlet object. More...

ReaderResult	collectionRetrievalResult (const bool contains_other_type, const bool contains_requested_type)
	Returns the corresponding retrieval result for a collection depending on whether the collection contained any elements of the requested or of other type. More...

bool	operator== (const InletVector &u, const InletVector &v)
	Compares two InletVectors. More...

std::ostream &	operator<< (std::ostream &os, const InletVector &v)
	"Prints" the vector to a stream More...

std::ostream &	operator<< (std::ostream &out, const VariantKey &key)
	Inserts the key into a stream. More...

Typedef Documentation

◆ FunctionVariant

using axom::inlet::FunctionVariant = typedef FunctionWrapper

Enumeration Type Documentation

◆ FunctionTag

enum axom::inlet::FunctionTag

strong

The tags used to describe function signatures in the input file.

Note: Additions to this enumeration should be propagated to FunctionType, LuaReader and func_signature_lists defined below (the mapping from enum to types); Vector corresponds to a vector with max dimension of three, Double corresponds to a floating-point scalar; A two-dimensional vector was intentionally excluded for simplicity as a 3D vector can be used in its place (with the third component being empty/zero)

Enumerator
Vector
Double
Void
String

◆ ReaderResult

enum axom::inlet::ReaderResult

strong

Enumerator
Success
NotFound
NotHomogeneous
WrongType

◆ InletType

enum axom::inlet::InletType

strong

Enumeration of basic types for things in inlet.

Enumerator
Nothing
Bool
String
Integer
Double
Object
Collection
Function

Function Documentation

◆ Field::get< std::string >()

template<>

std::string axom::inlet::Field::get< std::string > ( ) const

◆ Field::searchValidValues< std::string >()

template<>

bool axom::inlet::Field::searchValidValues< std::string >	(	const axom::sidre::View &	view,
		std::vector< VerificationError > *	errors
	)		const

◆ setWarningFlag()

void axom::inlet::setWarningFlag ( axom::sidre::Group * root )

This function is used to mark if anything went wrong during the defining phase of inlet so verify() will properly fail.

Parameters

[in] root Pointer to the Sidre Root Group where the warning flag will be set.

◆ setFlag()

void axom::inlet::setFlag	(	axom::sidre::Group &	target,
		axom::sidre::Group &	root,
		const std::string &	flag,
		bool	value
	)

This function is used to add a flag to the Inlet object corresponding to the provided Sidre group.

Parameters

[in]	target	Reference to the Sidre group to set the required status of
[in]	root	Reference to the Sidre Root Group where the warning flag will be set on failure
[in]	flag	The name of the flag to set
[in]	value	The value of the flag

◆ checkFlag()

bool axom::inlet::checkFlag	(	const axom::sidre::Group &	target,
		axom::sidre::Group &	root,
		const std::string &	flag
	)

This function is used to determine the value of a flag for the Inlet object corresponding to the provided Sidre group.

Parameters

[in]	target	Reference to the Sidre group to check the required status of
[in]	root	Reference to the Sidre Root Group where the warning flag will be set on failure
[in]	flag	The name of the flag to check

Returns: The value of the flag

◆ verifyRequired()

bool axom::inlet::verifyRequired	(	const axom::sidre::Group &	target,
		const bool	condition,
		const std::string &	type,
		std::vector< VerificationError > *	errors = `nullptr`
	)

This function is used to verify the required-ness of the Inlet object corresponding to the provided Sidre group.

Parameters

[in]	target	Reference to the Sidre group to verify the required-ness of
[in]	condition	The condition that must be true if the object is required
[in]	type	The type of the object as a string, for use in the warning message
[in]	errors	An optional vector of errors to append to in the case of verification failure

Returns: False if the object was required but condition was false, True otherwise

Postcondition: If the function returns False, a warning message will be emitted

◆ isCollectionGroup()

bool axom::inlet::isCollectionGroup ( const std::string & name )

inline

Determines whether a Container is a collection group.

Parameters

[in] name The name of the container

References axom::inlet::detail::COLLECTION_GROUP_NAME, and axom::utilities::string::endsWith().

◆ markAsStructCollection()

void axom::inlet::markAsStructCollection ( axom::sidre::Group & target )

Marks the sidre::Group as a "struct collection" by adding a corresponding flag to the group.

Parameters

[in,out] target The group to tag

◆ markRetrievalStatus()

void axom::inlet::markRetrievalStatus	(	axom::sidre::Group &	target,
		const ReaderResult	result
	)

Adds a ReaderResult to a sidre::Group corresponding to an inlet object.

Parameters

[in,out]	target	The group to tag
[in]	result	The retrieval result

◆ collectionRetrievalResult()

ReaderResult axom::inlet::collectionRetrievalResult	(	const bool	contains_other_type,
		const bool	contains_requested_type
	)

Returns the corresponding retrieval result for a collection depending on whether the collection contained any elements of the requested or of other type.

Parameters

[in]	contains_other_type	Whether any collection elements were of type other than the requested type
[in]	contains_requested_type	Whether the collection of requested type was not empty, i.e., if any elements of the requested type were present

◆ operator==()

bool axom::inlet::operator==	(	const InletVector &	u,
		const InletVector &	v
	)

inline

Compares two InletVectors.

Parameters

[in]	u	The comparison LHS
[in]	v	The comparison RHS

Returns: Whether the two vectors are equivalent

References axom::inlet::InletVector::dim, and axom::inlet::InletVector::vec.

◆ operator<<() [1/2]

std::ostream& axom::inlet::operator<<	(	std::ostream &	os,
		const InletVector &	v
	)

inline

"Prints" the vector to a stream

Parameters

[in,out]	os	The stream to insert into
[in]	v	The vector to insert into the stream

References axom::inlet::InletVector::dim.

◆ operator<<() [2/2]

std::ostream& axom::inlet::operator<<	(	std::ostream &	out,
		const VariantKey &	key
	)

Inserts the key into a stream.

Parameters

[in,out]	out	The stream to insert into
[in]	key	The key to print

Prints the active member to the stream

Namespaces

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ FunctionVariant

Enumeration Type Documentation

◆ FunctionTag

◆ ReaderResult

◆ InletType

Function Documentation

◆ Field::get< std::string >()

◆ Field::searchValidValues< std::string >()

◆ setWarningFlag()

◆ setFlag()

◆ checkFlag()

◆ verifyRequired()

◆ isCollectionGroup()

◆ markAsStructCollection()

◆ markRetrievalStatus()

◆ collectionRetrievalResult()

◆ operator==()

◆ operator<<() [1/2]

◆ operator<<() [2/2]