axom::inlet Namespace Reference

Classes
class	DocWriter
	Abstract base class defining the interface of all DocWriter classes. 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	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...
class	LuaReader
	A Reader that is able to read variables from a Lua file. More...
class	Reader
	Abstract base class defining the interface of all Reader classes. More...
class	SchemaCreator
	Abstract base class defining the interface of all SchemaCreator classes. More...
class	SphinxDocWriter
	A DocWriter that is able write documentation in Sphinx RST format for a given input file. More...
class	Table
	Provides functions to help define how individual Table and Field variables in an input file are expected to behave. It also holds the Sidre Group to the individual Table. More...

Functions
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...
std::string	appendPrefix (const std::string &prefix, const std::string &name)
	This function appends the prefix name to the ending name. More...
std::string	removePrefix (const std::string &prefix, const std::string &name)
	This function extracts the Table name from the full name. More...

Function Documentation

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.

appendPrefix()

std::string axom::inlet::appendPrefix	(	const std::string &	prefix,
		const std::string &	name
	)

This function appends the prefix name to the ending name.

Parameters

[in]	The	prefix string name.
[in]	The	ending string name.

Returns

The appended string.

removePrefix()

std::string axom::inlet::removePrefix	(	const std::string &	prefix,
		const std::string &	name
	)

This function extracts the Table name from the full name.

Parameters

[in]	The	prefix of the name, to be removed.
[in]	The	full name.

Returns

The extracted string.