axom::inlet::SchemaCreator Class Reference

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

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.4.0/src/axom/inlet/SchemaCreator.hpp>

Inheritance diagram for axom::inlet::SchemaCreator:

Public Member Functions
std::shared_ptr< Table >	addTable (const std::string &name, const std::string &description)
	Add a Table to the input file schema. More...
std::shared_ptr< Field >	addBool (const std::string &name, const std::string &description)
	Add a Boolean Field to the input file schema. More...
std::shared_ptr< Field >	addDouble (const std::string &name, const std::string &description)
	Add a Double Field to the input file schema. More...
std::shared_ptr< Field >	addInt (const std::string &name, const std::string &description)
	Add a Integer Field to the input file schema. More...
std::shared_ptr< Field >	addString (const std::string &name, const std::string &description)
	Add a String Field to the input file schema. More...

Detailed Description

Abstract base class defining the interface of all SchemaCreator classes.

Concrete instances need to inherit from this class and implement these functions. This ensures that Inlet and Table follow the same function signatures.

See also

Inlet Table

Member Function Documentation

addTable()

std::shared_ptr<Table> axom::inlet::SchemaCreator::addTable	(	const std::string &	name,
		const std::string &	description
	)

Add a Table to the input file schema.

Adds a Table to the input file schema. Tables hold a varying amount Fields defined by the user. By default, it is not required unless marked with Table::required(). This creates the Sidre Group class with the given name and stores the given description.

Parameters

[in]	name	Name of the Table expected in the input file
[in]	description	Description of the Table

Returns

Shared pointer to the created Table

addBool()

std::shared_ptr<Field> axom::inlet::SchemaCreator::addBool	(	const std::string &	name,
		const std::string &	description
	)

Add a Boolean Field to the input file schema.

Adds a Boolean Field to the input file schema. It may or may not be required to be present in the input file. This creates the Sidre Group class with the given name and stores the given description. If present in the input file the value is read and stored in the datastore.

Parameters

[in]	name	Name of the Field expected in the input file
[in]	description	Description of the Field

Returns

Shared pointer to the created Field

addDouble()

std::shared_ptr<Field> axom::inlet::SchemaCreator::addDouble	(	const std::string &	name,
		const std::string &	description
	)

Add a Double Field to the input file schema.

Adds a Double Field to the input file schema. It may or may not be required to be present in the input file. This creates the Sidre Group class with the given name and stores the given description. If present in the input file the value is read and stored in the datastore.

Parameters

[in]	name	Name of the Field expected in the input file
[in]	description	Description of the Field

Returns

Shared pointer to the created Field

addInt()

std::shared_ptr<Field> axom::inlet::SchemaCreator::addInt	(	const std::string &	name,
		const std::string &	description
	)

Add a Integer Field to the input file schema.

Adds a Integer Field to the input file schema. It may or may not be required to be present in the input file. This creates the Sidre Group class with the given name and stores the given description. If present in the input file the value is read and stored in the datastore.

Parameters

[in]	name	Name of the Field expected in the input file
[in]	description	Description of the Field

Returns

Shared pointer to the created Field

addString()

std::shared_ptr<Field> axom::inlet::SchemaCreator::addString	(	const std::string &	name,
		const std::string &	description
	)

Add a String Field to the input file schema.

Adds a String Field to the input file schema. It may or may not be required to be present in the input file. This creates the Sidre Group class with the given name and stores the given description. If present in the input file the value is read and stored in the datastore.

Parameters

[in]	name	Name of the Table expected in the input file
[in]	description	Description of the Table

Returns

Shared pointer to the created Field

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.4.0/src/axom/inlet/SchemaCreator.hpp