Action or linear combination of actions. More...

#include <Action.h>

Inheritance diagram for cmb_acc::Action:

Collaboration diagram for cmb_acc::Action:

Public Types
typedef std::map< std::string, float >	map_descomp

Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object >	PythonDict

Public Member Functions
	Action (const std::string &n="", const std::string &descrip="")
	Default constructor. More...

void	setName (const std::string &nmb)
	Sets the name to the action.

const std::string	getExpandedName (void) const
	Return the expandend name by applying the distributive property of the multiplication so, if the combination name is '1.5G1+1.35(G2+F2)' it returns '1.5G1+1.35G2+1.35*F2'. More...

const std::string &	getDescription (void) const
	Return the description of the action.

void	setDescription (const std::string &desc)
	Set the description of the action.

const ActionRelationships &	getRelaciones (void) const

double	getWeightingFactor (void) const

void	setWeightingFactor (const double &f)

bool	notDeterminant (void) const

void	setNotDeterminant (const bool &b)

map_descomp	getComponents (void) const
	When the actions is a combination return its decomposition.

boost::python::dict	getComponentsPy (void) const
	Return the action components in a Python dictionary.

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.

bool	Incompatible (const Action &) const
	Return true if this actions is not compatible with the argument one, so they cannot be present both in the same combination. More...

bool	Compatible (const Action &f) const
	Return true if this actions is compatible with the argument one. More...

bool	Simple (void) const
	Return true if the action is not a combination of simpler ones.

bool	Nula (const double &tol=zero) const
	Return verdadero si la acción es nula.

Action	GetMult (const double &d) const
	Return la acción multiplicada por un escalar.

Action &	operator*= (const double &d)
	Producto por un escalar.

Action &	operator+= (const Action &f)
	Addition.

std::vector< double >	getCoefficients (const std::vector< std::string > &) const
	When it's a combination, it returns the factors that multiply each of the actions in the argument. More...

boost::python::list	getCoefficientsPy (const boost::python::list &) const
	When it's a combination, it returns the factors that multiply each of the actions in the argument. More...

virtual void	Print (std::ostream &os) const
	Print stuff.

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.

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

Static Public Member Functions
static Action	NULA (void)
	Return una acción nula. More...

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.

Static Public Attributes
static const double	zero = 1e-6
	Treshold to consider the action as zero.

Friends
Action	operator* (const double &d, const Action &f)
	Product by a scalar.

Action	operator* (const Action &f, const double &d)
	Product by a scalar.

Action	operator+ (const Action &f1, const Action &f2)
	Addition.

Additional Inherited Members
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

Action or linear combination of actions.

Constructor & Destructor Documentation

◆ Action()

cmb_acc::Action::Action	(	const std::string &	n = `""`,
		const std::string &	descrip = `""`
	)

Default constructor.

Parameters

n	action name.
descrip	action description.

Member Function Documentation

◆ Compatible()

bool cmb_acc::Action::Compatible ( const Action & f ) const

inline

Return true if this actions is compatible with the argument one.

◆ getCoefficients()

std::vector< double > cmb_acc::Action::getCoefficients ( const std::vector< std::string > & base ) const

When it's a combination, it returns the factors that multiply each of the actions in the argument.

◆ getCoefficientsPy()

boost::python::list cmb_acc::Action::getCoefficientsPy ( const boost::python::list & base ) const

When it's a combination, it returns the factors that multiply each of the actions in the argument.

◆ getExpandedName()

const std::string cmb_acc::Action::getExpandedName ( void ) const

Return the expandend name by applying the distributive property of the multiplication so, if the combination name is '1.5*G1+1.35*(G2+F2)' it returns '1.5*G1+1.35*G2+1.35*F2'.

◆ Incompatible()

bool cmb_acc::Action::Incompatible ( const Action & f ) const

Return true if this actions is not compatible with the argument one, so they cannot be present both in the same combination.

Parameters

f	Action cuya incompatibilidad con ésta se comprueba. Action will be incompatible if its name verifies one or more of the regular expressions contained in the incompatibles member. La acción no podrá ser incompatible consigo misma.

◆ NULA()

cmb_acc::Action cmb_acc::Action::NULA ( void )

static

Return una acción nula.

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

src/utility/load_combinations/actions/Action.h
src/utility/load_combinations/actions/Action.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members