#include <XMLAttribute.hpp>

Collaboration diagram for precice::xml::XMLAttribute< ATTRIBUTE_T >:

Public Member Functions
	XMLAttribute ()=delete

	XMLAttribute (std::string name)

	XMLAttribute (std::string name, ATTRIBUTE_T defaultValue)

	XMLAttribute (const XMLAttribute< ATTRIBUTE_T > &other)=default

XMLAttribute &	operator= (const XMLAttribute< ATTRIBUTE_T > &other)=default

XMLAttribute &	setDocumentation (std::string documentation)
	Sets a documentation string for the attribute.

const std::string &	getUserDocumentation () const

XMLAttribute &	setOptions (std::vector< ATTRIBUTE_T > options)

template<class T >
XMLAttribute &	setOptions (std::initializer_list< T > &&options)

const std::vector< ATTRIBUTE_T > &	getOptions () const

XMLAttribute &	setDefaultValue (const ATTRIBUTE_T &defaultValue)

const ATTRIBUTE_T &	getDefaultValue () const

bool	hasDefaultValue () const

bool	hasValidation () const

void	readValue (const std::map< std::string, std::string > &aAttributes)

const std::string &	getName () const

const ATTRIBUTE_T &	getValue () const

void	setRead (bool read)

bool	isRead () const

Private Member Functions
template<typename VALUE_T >
std::enable_if< std::is_same< VALUE_T, ATTRIBUTE_T >::value &&notstd::is_same< VALUE_T, Eigen::VectorXd >::value, void >::type	set (ATTRIBUTE_T &toSet, const VALUE_T &setter)
	Sets non Eigen::VectorXd type values.

template<typename VALUE_T >
std::enable_if< std::is_same< VALUE_T, ATTRIBUTE_T >::value &&std::is_same< VALUE_T, Eigen::VectorXd >::value, void >::type	set (ATTRIBUTE_T &toSet, const VALUE_T &setter)
	Sets Eigen::VectorXd type values by clearing and copy.

Private Attributes
logging::Logger	_log {"xml::XMLAttribute"}

std::string	_name

std::string	_doc

bool	_read = false

ATTRIBUTE_T	_value {}

bool	_hasDefaultValue = false

ATTRIBUTE_T	_defaultValue {}

bool	_hasValidation = false

std::vector< ATTRIBUTE_T >	_options

Detailed Description

template<typename ATTRIBUTE_T>
class precice::xml::XMLAttribute< ATTRIBUTE_T >

Definition at line 20 of file XMLAttribute.hpp.

Constructor & Destructor Documentation

◆ XMLAttribute() [1/4]

template<typename ATTRIBUTE_T >

precice::xml::XMLAttribute< ATTRIBUTE_T >::XMLAttribute ( )

delete

◆ XMLAttribute() [2/4]

template<typename ATTRIBUTE_T >

precice::xml::XMLAttribute< ATTRIBUTE_T >::XMLAttribute ( std::string name )

inlineexplicit

Definition at line 26 of file XMLAttribute.hpp.

◆ XMLAttribute() [3/4]

template<typename ATTRIBUTE_T >

precice::xml::XMLAttribute< ATTRIBUTE_T >::XMLAttribute	(	std::string	name,
		ATTRIBUTE_T	defaultValue )

inline

Definition at line 29 of file XMLAttribute.hpp.

◆ XMLAttribute() [4/4]

template<typename ATTRIBUTE_T >

precice::xml::XMLAttribute< ATTRIBUTE_T >::XMLAttribute ( const XMLAttribute< ATTRIBUTE_T > & other )

default

Member Function Documentation

◆ getDefaultValue()

template<typename ATTRIBUTE_T >

const ATTRIBUTE_T & precice::xml::XMLAttribute< ATTRIBUTE_T >::getDefaultValue ( ) const

inline

Definition at line 60 of file XMLAttribute.hpp.

◆ getName()

template<typename ATTRIBUTE_T >

const std::string & precice::xml::XMLAttribute< ATTRIBUTE_T >::getName ( ) const

inline

Definition at line 77 of file XMLAttribute.hpp.

◆ getOptions()

template<typename ATTRIBUTE_T >

const std::vector< ATTRIBUTE_T > & precice::xml::XMLAttribute< ATTRIBUTE_T >::getOptions ( ) const

inline

Definition at line 53 of file XMLAttribute.hpp.

◆ getUserDocumentation()

template<typename ATTRIBUTE_T >

const std::string & precice::xml::XMLAttribute< ATTRIBUTE_T >::getUserDocumentation ( ) const

inline

Definition at line 39 of file XMLAttribute.hpp.

◆ getValue()

template<typename ATTRIBUTE_T >

const ATTRIBUTE_T & precice::xml::XMLAttribute< ATTRIBUTE_T >::getValue ( ) const

inline

Definition at line 82 of file XMLAttribute.hpp.

◆ hasDefaultValue()

template<typename ATTRIBUTE_T >

bool precice::xml::XMLAttribute< ATTRIBUTE_T >::hasDefaultValue ( ) const

inline

Definition at line 65 of file XMLAttribute.hpp.

◆ hasValidation()

template<typename ATTRIBUTE_T >

bool precice::xml::XMLAttribute< ATTRIBUTE_T >::hasValidation ( ) const

inline

Definition at line 70 of file XMLAttribute.hpp.

◆ isRead()

template<typename ATTRIBUTE_T >

bool precice::xml::XMLAttribute< ATTRIBUTE_T >::isRead ( ) const

inline

Definition at line 92 of file XMLAttribute.hpp.

◆ operator=()

template<typename ATTRIBUTE_T >

XMLAttribute & precice::xml::XMLAttribute< ATTRIBUTE_T >::operator= ( const XMLAttribute< ATTRIBUTE_T > & other )

default

◆ readValue()

template<typename ATTRIBUTE_T >

void precice::xml::XMLAttribute< ATTRIBUTE_T >::readValue ( const std::map< std::string, std::string > & aAttributes )

Definition at line 155 of file XMLAttribute.hpp.

Here is the call graph for this function:

◆ set() [1/2]

template<typename ATTRIBUTE_T >

template<typename VALUE_T >

std::enable_if< std::is_same< VALUE_T, ATTRIBUTE_T >::value &&std::is_same< VALUE_T, Eigen::VectorXd >::value, void >::type precice::xml::XMLAttribute< ATTRIBUTE_T >::set	(	ATTRIBUTE_T &	toSet,
		const VALUE_T &	setter )

private

Sets non Eigen::VectorXd type values.

Definition at line 195 of file XMLAttribute.hpp.

Here is the call graph for this function:

◆ set() [2/2]

template<typename ATTRIBUTE_T >

template<typename VALUE_T >

std::enable_if< std::is_same< VALUE_T, ATTRIBUTE_T >::value &&std::is_same< VALUE_T, Eigen::VectorXd >::value, void >::type precice::xml::XMLAttribute< ATTRIBUTE_T >::set	(	ATTRIBUTE_T &	toSet,
		const VALUE_T &	setter )