preCICE v3.2.0
|
#include <XMLAttribute.hpp>
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_view 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 &¬std::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 |
Definition at line 20 of file XMLAttribute.hpp.
|
delete |
|
inlineexplicit |
|
inline |
|
default |
|
inline |
Definition at line 66 of file XMLAttribute.hpp.
|
inline |
Definition at line 83 of file XMLAttribute.hpp.
|
inline |
Definition at line 59 of file XMLAttribute.hpp.
|
inline |
Definition at line 45 of file XMLAttribute.hpp.
|
inline |
Definition at line 88 of file XMLAttribute.hpp.
|
inline |
Definition at line 71 of file XMLAttribute.hpp.
|
inline |
Definition at line 76 of file XMLAttribute.hpp.
|
inline |
Definition at line 98 of file XMLAttribute.hpp.
|
default |
void precice::xml::XMLAttribute< ATTRIBUTE_T >::readValue | ( | const std::map< std::string, std::string > & | aAttributes | ) |
|
private |
Sets non Eigen::VectorXd type values.
Definition at line 201 of file XMLAttribute.hpp.
|
private |
Sets Eigen::VectorXd type values by clearing and copy.
XMLAttribute< ATTRIBUTE_T > & precice::xml::XMLAttribute< ATTRIBUTE_T >::setDefaultValue | ( | const ATTRIBUTE_T & | defaultValue | ) |
XMLAttribute< ATTRIBUTE_T > & precice::xml::XMLAttribute< ATTRIBUTE_T >::setDocumentation | ( | std::string_view | documentation | ) |
Sets a documentation string for the attribute.
Definition at line 136 of file XMLAttribute.hpp.
|
inline |
XMLAttribute< ATTRIBUTE_T > & precice::xml::XMLAttribute< ATTRIBUTE_T >::setOptions | ( | std::vector< ATTRIBUTE_T > | options | ) |
|
inline |
Definition at line 93 of file XMLAttribute.hpp.
|
private |
Definition at line 116 of file XMLAttribute.hpp.
|
private |
Definition at line 108 of file XMLAttribute.hpp.
|
private |
Definition at line 114 of file XMLAttribute.hpp.
|
private |
Definition at line 118 of file XMLAttribute.hpp.
|
private |
Definition at line 104 of file XMLAttribute.hpp.
|
private |
Definition at line 106 of file XMLAttribute.hpp.
|
private |
Definition at line 120 of file XMLAttribute.hpp.
|
private |
Definition at line 110 of file XMLAttribute.hpp.
|
private |
Definition at line 112 of file XMLAttribute.hpp.