Each of the terms (factor*LoadPattern) of the combination. More...
#include <LoadPatternCombination.h>
Inheritance diagram for XC::LoadPatternCombination::summand:
Collaboration diagram for XC::LoadPatternCombination::summand:
Public Member Functions | |
| summand (const float &f=1.0, LoadPattern *lp=nullptr) | |
| constructor. | |
| const float & | getFactor (void) const |
| Returns the factor that multiplies the load pattern. More... | |
| const LoadPattern * | getLoadPattern (void) const |
| Returns the LoadPattern corresponding to the summand. | |
| LoadPattern * | getLoadPattern (void) |
| Returns the LoadPattern corresponding to the summand. | |
| const std::string & | getLoadPatternName (const MapLoadPatterns &lps) const |
| Returns the name of the load case corresponding to the summand. | |
| bool | set_gamma_f (void) |
| Assigns the weightings for the load pattern. | |
| summand | getNeg (void) const |
| Returns the summand with sign changed. | |
| const summand & | add (const summand &) |
| Add to this summand the argument. | |
| const summand & | subtract (const summand &) |
| Subtract from this summand the argument. | |
| const summand & | multiplica (const float &) |
| Multiplies the summand by the value being passed as parameter. | |
| const summand & | divide (const float &) |
| Divides the summand by the value being passed as parameter. | |
| std::string | getString (const MapLoadPatterns &, const std::string &fmt) const |
| Returns a string representation of the combination i.e. More... | |
| void | Print (std::ostream &os) const |
| Imprime. | |
 Public Member Functions inherited from CommandEntity | |
| CommandEntity (CommandEntity *owr=nullptr) | |
| Default constructor. | |
| CommandEntity * | Owner (void) |
| Return a pointer to the object owner. | |
| const CommandEntity * | Owner (void) const |
| Return un puntero al objeto propietario de ESTE. | |
| const StandardOutputWrapper & | getStandardOutputWrapper (void) const |
| Return the regular output stream wrapper. | |
| StandardOutputWrapper & | getStandardOutputWrapper (void) |
| Return the regular output stream wrapper. | |
| const std::string & | getLogFileName (void) const |
| Returns log file name. | |
| void | setLogFileName (const std::string &) |
| Sets log file name. | |
| const std::string & | getErrFileName (void) const |
| Returns err file name. | |
| void | setErrFileName (const std::string &) |
| Sets error file name. | |
| const std::string & | getOutputFileName (void) const |
| Returns regular output file name. | |
| void | setOutputFileName (const std::string &) |
| Sets regular output file name. | |
| boost::python::object | evalPy (boost::python::object dict, const std::string &) |
| Return the Python object that results from evaluating the argument. | |
| boost::python::object | execPy (boost::python::object dict, const std::string &) |
| Return the Python objects that results from executing the code in the string argument. | |
| boost::python::object | execFilePy (boost::python::object dict, const std::string &) |
| Return the Python object that results from executing the code in the file. | |
| Public Member Functions inherited from EntityWithProperties | |
| EntityWithProperties (EntityWithProperties *owr=nullptr) | |
| Default constructor. | |
| void | clearPyProps (void) |
| Clear python properties map. | |
| bool | hasPyProp (const std::string &) |
| Returns true if property exists. | |
| boost::python::object | getPyProp (const std::string &str) |
| Return the Python object with the name being passed as parameter. | |
| void | setPyProp (std::string str, boost::python::object val) |
| Sets/appends a value tho the Python object's dictionary. | |
| void | copyPropsFrom (const EntityWithProperties &) |
| Copy the properties from the argument. | |
| boost::python::list | getPropNames (void) const |
| Return the names of the object properties weightings. | |
| const PythonDict & | getPropertiesDict (void) const |
| Return a std::map container with the properties of the object. | |
| boost::python::dict | getPyDict (void) const |
| Return a Python dictionary containing the object members values. | |
| void | setPyDict (const boost::python::dict &) |
| Set the values of the object members from a Python dictionary. | |
| Public Member Functions inherited from EntityWithOwner | |
| EntityWithOwner (EntityWithOwner *owr=nullptr) | |
| Default constructor. | |
| EntityWithOwner (const EntityWithOwner &) | |
| Copy constructor. | |
| EntityWithOwner & | operator= (const EntityWithOwner &) |
| Assignment operator. | |
| virtual bool | operator== (const EntityWithOwner &) const |
| Comparison operator. | |
| virtual | ~EntityWithOwner (void) |
| Virtual destructor. | |
| virtual std::string | getClassName (void) const |
| Returns demangled class name. | |
| void | set_owner (EntityWithOwner *owr) |
| Assigns the owner of the object. | |
| EntityWithOwner * | Owner (void) |
| const EntityWithOwner * | Owner (void) const |
Additional Inherited Members | |
| Public Types inherited from EntityWithProperties | |
| typedef std::map< std::string, boost::python::object > | PythonDict |
| Static Public Member Functions inherited from CommandEntity | |
| static void | resetStandardOutput (void) |
| Reset the standard output streams to its defaults buffers. | |
| Static Public Member Functions inherited from EntityWithOwner | |
| static int | getVerbosityLevel (void) |
| Get the value of the verbosity level. | |
| static void | setVerbosityLevel (const int &) |
| Set the value of the verbosity level. | |
| Protected Member Functions inherited from CommandEntity | |
| template<class T > | |
| void | string_to (T &, const std::string &) const |
| Protected Member Functions inherited from EntityWithProperties | |
| bool | isEqual (const EntityWithProperties &) const |
| Return true if both objects are equal. | |
| Protected Member Functions inherited from EntityWithOwner | |
| virtual bool | isEqual (const EntityWithOwner &) const |
| Return true if both objects are equal. | |
| Static Protected Member Functions inherited from CommandEntity | |
| static CommandEntity * | entcmd_cast (boost::any &data) |
| Static Protected Attributes inherited from EntityWithOwner | |
| static int | verbosity = 1 |
| Object that owns THIS ONE. More... | |
Detailed Description
Each of the terms (factor*LoadPattern) of the combination.
Member Function Documentation
◆ getFactor()
| const float & XC::LoadPatternCombination::summand::getFactor | ( | void | ) | const |
Returns the factor that multiplies the load pattern.
Returns the factor that multiplies the summand.
◆ getString()
| std::string XC::LoadPatternCombination::summand::getString | ( | const MapLoadPatterns & | lPatterns, |
| const std::string & | fmt | ||
| ) | const |
Returns a string representation of the combination i.e.
"1.35*G1".
lPatterns:Load pattern container.fmt:Format for the factor.
The documentation for this class was generated from the following files:
- src/domain/load/pattern/LoadPatternCombination.h
- src/domain/load/pattern/LoadPatternCombination.cc
