FEMSuite
Public Member Functions | List of all members
IParameter Class Referenceabstract

This interface describes the most basic methods of a parameter More...

#include <IParameter.h>

Inheritance diagram for IParameter:
Inheritance graph
[legend]

Public Member Functions

virtual std::string GetName ()=0
 
virtual std::string GetUnit ()=0
 
virtual ParameterId GetId ()=0
 Returns a generic type id pertaining to this parameter More...
 
virtual ParameterDataType GetDataType ()=0
 
virtual std::type_index GetBasicType ()=0
 
virtual std::string ToString ()=0
 
virtual void SetFromString (const std::string &s)=0
 
virtual bool IsHidden ()=0
 
virtual void Show (const bool=true)=0
 
virtual void Hide (const bool=true)=0
 
virtual bool IsDisabled ()=0
 A disabled parameter cannot have its value updated using the SetFromString method More...
 
virtual void Enable (const bool e=true)=0
 
virtual void Disable (const bool d=true)=0
 
virtual void DisableAndHide ()=0
 
virtual const Extrema< double > & GetLimits ()=0
 
virtual IParameterContainer & GetParameters ()=0
 
virtual std::shared_ptr< IParameterGetIParameter (const std::string &name)=0
 Finds a parameter by name More...
 
template<class T , typename... Args>
std::shared_ptr< Parameter< T > > GetParameter (Args...args)
 
template<class T , typename... Args>
std::shared_ptr< T > Get (Args...args)
 
virtual void AddIParameter (std::shared_ptr< IParameter >)=0
 
template<class T , typename... Args>
std::shared_ptr< Parameter< T > > AddParameter (Args...args)
 
template<class T , typename... Args>
std::shared_ptr< T > Add (Args...args)
 
virtual void RemoveParameter (const std::string &name)=0
 
virtual void ClearParameters ()=0
 
virtual void LoadFromXMLFile (const std::string &rootDir="", const bool loadFromRootNode=false)=0
 
virtual void LoadFromXMLNode (TiXmlElement *node)=0
 Loads xml from a specified root node. Will look in the root node for the exact node of this parameter More...
 
virtual void LoadFromXMLSubNode (TiXmlElement *rootNode)=0
 Loads xml from an node. Will look in the root node for the exact node of this parameter More...
 
virtual void SaveToXMLFile (const std::string &rootDir="")=0
 
virtual void SaveToXMLSubNode (TiXmlElement *root)=0
 
virtual void SaveToXMLNode (TiXmlElement *node)=0
 
virtual bool IsAlwaysUsingDefaultDir ()=0
 
virtual void AlwaysUseDefaultDir (const bool=true)=0
 Uses the default directory for loading and saving xml files. More...
 

Detailed Description

This interface describes the most basic methods of a parameter

Member Function Documentation

virtual void IParameter::AlwaysUseDefaultDir ( const bool  = true)
pure virtual

Uses the default directory for loading and saving xml files.

Implemented in ParameterBase.

virtual ParameterId IParameter::GetId ( )
pure virtual

Returns a generic type id pertaining to this parameter

Implemented in ParameterBase.

virtual std::shared_ptr< IParameter > IParameter::GetIParameter ( const std::string &  name)
pure virtual

Finds a parameter by name

Implemented in ParameterBase.

virtual bool IParameter::IsDisabled ( )
pure virtual

A disabled parameter cannot have its value updated using the SetFromString method

Implemented in ParameterBase.

virtual void IParameter::LoadFromXMLFile ( const std::string &  rootDir = "",
const bool  loadFromRootNode = false 
)
pure virtual

If loadFromRootNode is set, the parameter is loaded from the root node directly.

Implemented in ParameterBase.

virtual void IParameter::LoadFromXMLNode ( TiXmlElement *  node)
pure virtual

Loads xml from a specified root node. Will look in the root node for the exact node of this parameter

Implemented in ParameterBase, and ParameterContainer< T >.

virtual void IParameter::LoadFromXMLSubNode ( TiXmlElement *  rootNode)
pure virtual

Loads xml from an node. Will look in the root node for the exact node of this parameter

Implemented in ParameterBase.


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