axom::inlet::Function Class Reference

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

Inheritance diagram for axom::inlet::Function:

Public Member Functions
	Function (axom::sidre::Group *sidreGroup, axom::sidre::Group *root, FunctionVariant &&func, bool docEnabled=true)
template<typename FuncType >
std::function< FuncType >	get () const
	Returns a function of requested type. More...
template<typename Ret , typename... Args>
Ret	call (Args &&... args) const
const axom::sidre::Group *	sidreGroup () const
	Returns pointer to the Sidre Group class for this Function. More...
	operator bool () const
	Checks whether the function exists. More...
std::string	name () const
bool	verify () const
	This will be called by Inlet::verify to verify the contents of this Function. More...
Function &	required (bool isRequired=true)
	Set the required status of this Container. More...
bool	isRequired () const
	Return the required status of this Container. More...
Function &	registerVerifier (std::function< bool(const Function &)> lambda)
	Registers the function object that will verify this function during the verification stage. More...

Constructor & Destructor Documentation

Function()

axom::inlet::Function::Function ( axom::sidre::Group *  sidreGroup, axom::sidre::Group *  root, FunctionVariant &&  func, bool  docEnabled = true  )

inline

Member Function Documentation

get()

template<typename FuncType >

std::function<FuncType> axom::inlet::Function::get ( ) const

inline

Returns a function of requested type.

Returns

The value

Template Parameters

T	The type to retrieve

Referenced by axom::inlet::Proxy::get().

call()

template<typename Ret , typename... Args>

Ret axom::inlet::Function::call ( Args &&...  args ) const

inline

Referenced by axom::inlet::Proxy::call().

sidreGroup()

const axom::sidre::Group* axom::inlet::Function::sidreGroup ( ) const

inline

Returns pointer to the Sidre Group class for this Function.

Provides access to the Sidre Group class that holds all the stored information for this Function instance.

operator bool()

axom::inlet::Function::operator bool ( ) const

inline

Checks whether the function exists.

name()

std::string axom::inlet::Function::name

(

)

const

Returns

The full name for this Function.

verify()

bool axom::inlet::Function::verify ( ) const

virtual

This will be called by Inlet::verify to verify the contents of this Function.

Implements axom::inlet::Verifiable< Function >.

required()

Function& axom::inlet::Function::required ( bool  isRequired = true )

virtual

Set the required status of this Container.

Set whether this Container 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 Container is required

Returns

Reference to this instance of Container

Implements axom::inlet::Verifiable< Function >.

isRequired()

bool axom::inlet::Function::isRequired ( ) const

virtual

Return the required status of this Container.

Return that this Function is required, or not, to be in the input file. The default behavior is to not be required.

Returns

Boolean value of whether this Function is required

Implements axom::inlet::Verifiable< Function >.

registerVerifier()

Function& axom::inlet::Function::registerVerifier ( std::function< bool(const Function &)>  lambda )

virtual

Registers the function object that will verify this function during the verification stage.

Parameters

[in]

The

function object that will be called by Container::verify().

Implements axom::inlet::Verifiable< Function >.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/inlet/Function.hpp