Mantid
|
This class stores information about the parameters used by an algorithm. More...
#include <API/MAntidAPI/PropertyHistory.h>
Public Member Functions | |
unsigned int | direction () const |
get direction flag of algorithm parameter const More... | |
bool | isDefault () const |
get isdefault flag of algorithm parameter const More... | |
bool | isEmptyDefault () const |
get whether algorithm parameter was left as default EMPTY_INT,LONG,DBL const More... | |
const std::string & | name () const |
get name of algorithm parameter const More... | |
bool | operator== (const PropertyHistory &other) const |
this is required for boost.python More... | |
void | printSelf (std::ostream &, const int indent=0, const size_t maxPropertyLength=0) const |
print contents of object More... | |
PropertyHistory (Property const *const prop) | |
construct a property history from a property object More... | |
PropertyHistory (std::string name, std::string value, std::string type, const bool isdefault, const unsigned int direction=99) | |
Constructor. More... | |
void | setValue (const std::string &value) |
set value of algorithm parameter More... | |
const std::string & | type () const |
get type of algorithm parameter const More... | |
const std::string & | value () const |
get value of algorithm parameter const More... | |
virtual | ~PropertyHistory ()=default |
destructor More... | |
Private Attributes | |
unsigned int | m_direction |
direction of parameter More... | |
bool | m_isDefault |
flag defining if the parameter is a default or a user-defined parameter More... | |
std::string | m_name |
The name of the parameter. More... | |
std::string | m_type |
The type of the parameter. More... | |
std::string | m_value |
The value of the parameter. More... | |
This class stores information about the parameters used by an algorithm.
Definition at line 34 of file PropertyHistory.h.
Mantid::Kernel::PropertyHistory::PropertyHistory | ( | std::string | name, |
std::string | value, | ||
std::string | type, | ||
const bool | isdefault, | ||
const unsigned int | direction = 99 |
||
) |
Constructor.
Definition at line 24 of file PropertyHistory.cpp.
Mantid::Kernel::PropertyHistory::PropertyHistory | ( | Property const *const | prop | ) |
construct a property history from a property object
Definition at line 29 of file PropertyHistory.cpp.
|
virtualdefault |
destructor
|
inline |
get direction flag of algorithm parameter const
Definition at line 54 of file PropertyHistory.h.
Referenced by Mantid::API::ScriptBuilder::buildPropertyString(), and export_PropertyHistory().
|
inline |
get isdefault flag of algorithm parameter const
Definition at line 52 of file PropertyHistory.h.
Referenced by Mantid::API::ScriptBuilder::buildPropertyString(), and export_PropertyHistory().
bool Mantid::Kernel::PropertyHistory::isEmptyDefault | ( | ) | const |
get whether algorithm parameter was left as default EMPTY_INT,LONG,DBL const
Returns whether algorithm parameter was left as default EMPTY_INT,LONG,DBL.
Definition at line 64 of file PropertyHistory.cpp.
References Mantid::EMPTY_DBL(), Mantid::EMPTY_INT(), Mantid::EMPTY_LONG(), Mantid::Kernel::getUnmangledTypeName(), m_direction, m_isDefault, m_type, m_value, Mantid::Kernel::Direction::Output, and std::to_string().
|
inline |
get name of algorithm parameter const
Definition at line 44 of file PropertyHistory.h.
Referenced by Mantid::API::ScriptBuilder::buildPropertyString(), and export_PropertyHistory().
|
inline |
this is required for boost.python
Definition at line 62 of file PropertyHistory.h.
References value.
void Mantid::Kernel::PropertyHistory::printSelf | ( | std::ostream & | os, |
const int | indent = 0 , |
||
const size_t | maxPropertyLength = 0 |
||
) | const |
print contents of object
Prints a text representation of itself.
os | :: The output stream to write to |
indent | :: an indentation value to make pretty printing of object and sub-objects |
maxPropertyLength | :: the max length for any property value string (0 = full length) |
Definition at line 40 of file PropertyHistory.cpp.
References Mantid::Kernel::Direction::asText(), m_direction, m_isDefault, m_name, m_value, and Mantid::Kernel::Strings::shorten().
Referenced by Mantid::Kernel::operator<<().
|
inline |
set value of algorithm parameter
Definition at line 48 of file PropertyHistory.h.
|
inline |
get type of algorithm parameter const
Definition at line 50 of file PropertyHistory.h.
Referenced by Mantid::API::ScriptBuilder::buildPropertyString(), and export_PropertyHistory().
|
inline |
get value of algorithm parameter const
Definition at line 46 of file PropertyHistory.h.
References m_value.
Referenced by Mantid::API::ScriptBuilder::buildPropertyString(), and export_PropertyHistory().
|
private |
direction of parameter
Definition at line 77 of file PropertyHistory.h.
Referenced by isEmptyDefault(), and printSelf().
|
private |
flag defining if the parameter is a default or a user-defined parameter
Definition at line 75 of file PropertyHistory.h.
Referenced by isEmptyDefault(), and printSelf().
|
private |
The name of the parameter.
Definition at line 69 of file PropertyHistory.h.
Referenced by printSelf().
|
private |
The type of the parameter.
Definition at line 73 of file PropertyHistory.h.
Referenced by isEmptyDefault().
|
private |
The value of the parameter.
Definition at line 71 of file PropertyHistory.h.
Referenced by isEmptyDefault(), and printSelf().