xc
Public Member Functions | Friends | List of all members
cmb_acc::ActionsFamily Class Reference

Family of actions (permanent, variable, accidental,...) More...

#include <ActionsFamily.h>

Inheritance diagram for cmb_acc::ActionsFamily:
Inheritance graph
[legend]
Collaboration diagram for cmb_acc::ActionsFamily:
Collaboration graph
[legend]

Public Member Functions

 ActionsFamily (const std::string &nmb="")
 Default constructor.
 
ActionWrapper & insert (const Action &, const std::string &, const std::string &)
 Insert the action argument and sets the its combination and partial safety factors. More...
 
ActionWrapper & insertGroup (const std::vector< Action > &, const std::vector< std::string > &, const std::string &)
 Insert the group of actions being passed as parameter and sets its combination and partial safety factors. More...
 
ActionWrapper & insertGroupPy (const boost::python::list &, const std::string &)
 Insert the group of actions being passed as parameter and sets its combination and partial safety factors. More...
 
const ActionWrapperList & getActions (void) const
 Return the actions in the family.
 
ActionWrapperList & getActions (void)
 Return the actions in the family.
 
void setActions (const ActionWrapperList &acc)
 Set the actions in the family.
 
bool empty (void) const
 brief Return true if no actions in the family.
 
const ActionsAndFactors * getActionsAndFactors (void) const
 Return the container that contains this object.
 
const CombinationFactorsMap * getPtrCombinationFactors (void) const
 Return a pointer to the combination factors container.
 
const PartialSafetyFactorsMap * getPtrPartialSafetyFactors (void) const
 Return a pointer to the partial safety factors container.
 
- Public Member Functions inherited from NamedEntity
 NamedEntity (const std::string &Name="", CommandEntity *owr=nullptr)
 Constructor.
 
const std::string & getName (void) const
 Return the object name.
 
void setName (const std::string &s)
 Set the object name.
 
std::string & Name (void)
 Return a reference to the object name.
 
virtual bool operator== (const NamedEntity &other) const
 Comparison operator.
 
bool operator< (const NamedEntity &other) const
 Less than operator.
 
NamedEntity & operator+= (const NamedEntity &)
 += operator.
 
NamedEntity & operator-= (const NamedEntity &)
 -= operator.
 
NamedEntity & operator*= (const NamedEntity &)
 *= operator.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary with 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 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.
 
- 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
 

Friends

class ActionsAndFactors
 

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

Family of actions (permanent, variable, accidental,...)

Set of actions that share its variation in time, for example:: -Permanent actions. -Variable actions. -Accidental actions. -Earthquake actions.

Member Function Documentation

◆ insert()

cmb_acc::ActionWrapper & cmb_acc::ActionsFamily::insert ( const Action &  a,
const std::string &  combination_factors_name,
const std::string &  partial_safety_factors_name 
)

Insert the action argument and sets the its combination and partial safety factors.

Parameters
aAction object to insert.
combination_factors_namename of the combination factors that correspond to the action.
partial_safety_factors_namename of the partial safety factors that correspond to the action.

◆ insertGroup()

cmb_acc::ActionWrapper & cmb_acc::ActionsFamily::insertGroup ( const std::vector< Action > &  actions,
const std::vector< std::string > &  combination_factors_names,
const std::string &  partial_safety_factors_name 
)

Insert the group of actions being passed as parameter and sets its combination and partial safety factors.

Parameters
actionsVector of action objects to insert.
combination_factors_namesvector of names of the combination factors //! that correspond to the action.
partial_safety_factors_namename (unique) of the partial safety factors that correspond to the actions of the group. The uniqueness of the applicable partial safety factors is the essence of a group of actions.

◆ insertGroupPy()

cmb_acc::ActionWrapper & cmb_acc::ActionsFamily::insertGroupPy ( const boost::python::list &  actionTuples,
const std::string &  partial_safety_factors_name 
)

Insert the group of actions being passed as parameter and sets its combination and partial safety factors.

Parameters
actionTupleslist of (action, combination_factors_name) tuples.
partial_safety_factors_namename (unique) of the partial safety factors that correspond to the actions of the group. The uniqueness of the applicable partial safety factors is the essence of a group of actions.

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