XC::MapLoadPatterns Class Reference

Load pattern container. More...

#include <MapLoadPatterns.h>

Inheritance diagram for XC::MapLoadPatterns:

Collaboration diagram for XC::MapLoadPatterns:

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

Public Member Functions
	MapLoadPatterns (LoadHandler *owr)
	Default constructor.
	~MapLoadPatterns (void)
	Destructor.
void	clear (void)
	Clears all the load patterns.
const_iterator	begin (void) const
const_iterator	end (void) const
iterator	begin (void)
iterator	end (void)
size_t	size (void) const
bool	empty (void) const
const std::string	getCurrentLoadPatternId (void) const
LoadPattern *	getCurrentLoadPatternPtr (void)
const LoadPattern *	getCurrentLoadPatternPtr (void) const
const std::string &	getCurrentLoadPattern (void) const
void	setCurrentLoadPattern (const std::string &nmb)
LoadPattern *	newLoadPattern (const std::string &, const std::string &)
	Define a LoadPattern object with the type and the name being passed as parameters. More...
bool	removeLoadPattern (const std::string &)
	Remove the load pattern with the given name.
void	addToDomain (const std::string &)
	Adds the load pattern to the domain.
void	removeFromDomain (const std::string &)
	Remove the load pattern del domain.
void	removeAllFromDomain (void)
	Remove the loadpatterns del domain.
TimeSeries *	findTS (const int &)
	Returns a pointer to the TS cuyo dbTag being passed as parameter. More...
const TimeSeries *	findTS (const int &) const
	Returns a pointer to the TS which name is being passed as parameter.
TimeSeries *	findTS (const std::string &)
	Returns a pointer to the TimeSeries which name being passed as parameter.
const TimeSeries *	findTS (const std::string &) const
	Returns a pointer to the TimeSeries which name being passed as parameter.
LoadPattern *	findLoadPattern (const std::string &)
	Returns a pointer to the load pattern which name being passed as parameter.
const LoadPattern *	findLoadPattern (const std::string &) const
	Returns a pointer to the load pattern which name being passed as parameter.
LoadPattern *	findLoadPattern (const int &)
	Returns a pointer to the load pattern identified by the tag being passed as parameter. More...
const LoadPattern *	findLoadPattern (const int &) const
	Returns a pointer to the load pattern with the tag being passed as parameter. More...
const std::string &	getLoadPatternName (const LoadPattern *) const
	Returns the name of the load pattern pointed by the parameter.
TimeSeries *	newTimeSeries (const std::string &, const std::string &)
	Define a TimeSeries object with the type and name passed as parameters. More...
const std::string &	getCurrentTimeSeries (void) const
void	setCurrentTimeSeries (const std::string &nmb)
const std::string &	getTimeSeriesName (const TimeSeries *) const
	Returns the name of the time series pointed by the parameter.
std::deque< std::string >	getNamesList (void) const
	Return the names of the load patterns.
boost::python::list	getKeys (void) const
	Return load case names.
const int &	getCurrentElementLoadTag (void) const
void	setCurrentElementLoadTag (const int &n)
const int &	getCurrentNodeLoadTag (void) const
void	setCurrentNodeLoadTag (const int &n)
std::list< LoadPattern * >	getLoadPatternsActingOn (const Node *)
	Return the load patterns that act on the given node.
boost::python::list	getLoadPatternsActingOnPy (const Node *)
	Return the load patterns that act on the given node.
void	removeLoadsOn (const Node *)
	Removes the given node from all the load patterns.
void	copyLoads (const Node *, const Node *)
	Copy the loads from the first node to the second one. More...
std::list< LoadPattern * >	getLoadPatternsActingOn (const Element *)
	Return the load patterns that act on the given element.
boost::python::list	getLoadPatternsActingOnPy (const Element *)
	Return the load patterns that act on the given element.
void	removeLoadsOn (const Element *)
	Removes the given element from all the load patterns.
void	copyLoads (const Element *, const Element *)
	Copy the loads from the first element to the second one. More...
int	sendSelf (Communicator &)
	Sends object through the communicator argument.
int	recvSelf (const Communicator &)
	Receives object through the communicator argument.
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 XC::LoadHandlerMember
	LoadHandlerMember (LoadHandler *owr)
	Default constructor.
const LoadHandler *	getLoadHandler (void) const
	Returns the owner.
LoadHandler *	getLoadHandler (void)
	Returns the owner.
const Domain *	getDomain (void) const
	Returns the domain.
Domain *	getDomain (void)
	Returns the domain.
int &	getTagLP (void)
	Returns the tag para el siguiente load pattern.
const int &	getTagLP (void) const
	Returns the tag para el siguiente load pattern.
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
Public Member Functions inherited from XC::MovableObject
	MovableObject (int classTag, int dbTag)
	Constructor. More...
	MovableObject (int classTag)
	Constructor. More...
	MovableObject (const MovableObject &)
	Copy constructor. Doesn't copy the dbTag.
MovableObject &	operator= (const MovableObject &)
	Assignment operator. Doesn't copy the dbTag.
int	getClassTag (void) const
	Return the class identifier.
int	getDbTag (void) const
	Return the object identifier in the database.
int	getDbTag (Communicator &)
	Return the object identifier in the database.
void	setDbTag (int dbTag)
	Sets the object identifier in the database.
void	setDbTag (Communicator &)
	Sets the object identifier in the database if not already set. More...
virtual int	setParameter (const std::vector< std::string > &argv, Parameter &param)
	Sets the value param to the parameter argv.
virtual int	updateParameter (int parameterID, Information &info)
	Updates the parameter identified by parameterID with info.
virtual int	activateParameter (int parameterID)
	Activates the parameter identified by parameterID.
virtual int	setVariable (const std::string &variable, Information &)
	Set the value of the variable idenfified by var.
virtual int	getVariable (const std::string &variable, Information &)
	Return the value of the variable idenfified by var.
Public Member Functions inherited from XC::DistributedBase
	DistributedBase (void)
	Constructor.
virtual	~DistributedBase (void)
	Destructor.
const int &	getDbTagDataPos (const int &i) const
	Returns the data at the i-th position.
void	setDbTagDataPos (const int &i, const int &v)
	Sets the data at the i-th position.
void	inicComm (const int &dataSize) const
	Initializes communication.

Protected Member Functions
void	clear_time_series (void)
	Clears all the load patterns.
DbTagData &	getDbTagData (void) const
	Return a vector to store the dbTags of the class members. More...
int	sendData (Communicator &comm)
	Send members through the communicator argument.
int	recvData (const Communicator &comm)
	Send members through the communicator argument.
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.

Friends
class	LoadHandler

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

Load pattern container.

Member Function Documentation

copyLoads() [1/2]

void XC::MapLoadPatterns::copyLoads	(	const Node *	fromNode,
		const Node *	toNode
	)

Copy the loads from the first node to the second one.

Parameters

fromNode	node to copy the loads from.
toNode	node to copy the loads to.

copyLoads() [2/2]

void XC::MapLoadPatterns::copyLoads	(	const Element *	fromElement,
		const Element *	toElement
	)

Copy the loads from the first element to the second one.

Parameters

fromElement	element to copy the loads from.
toElement	element to copy the loads to.

findLoadPattern() [1/2]

XC::LoadPattern * XC::MapLoadPatterns::findLoadPattern

(

const int &

tag

)

Returns a pointer to the load pattern identified by the tag being passed as parameter.

findLoadPattern() [2/2]

const XC::LoadPattern * XC::MapLoadPatterns::findLoadPattern

(

const int &

tag

)

const

Returns a pointer to the load pattern with the tag being passed as parameter.

findTS()

XC::TimeSeries * XC::MapLoadPatterns::findTS

(

const int &

dbTag

)

Returns a pointer to the TS cuyo dbTag being passed as parameter.

se usa en LoadPattern::recvData.

getDbTagData()

XC::DbTagData & XC::MapLoadPatterns::getDbTagData ( void  ) const

protectedvirtual

Return a vector to store the dbTags of the class members.

Reimplemented from XC::DistributedBase.

newLoadPattern()

XC::LoadPattern * XC::MapLoadPatterns::newLoadPattern	(	const std::string &	type,
		const std::string &	cod_lp
	)

Define a LoadPattern object with the type and the name being passed as parameters.

newTimeSeries()

XC::TimeSeries * XC::MapLoadPatterns::newTimeSeries	(	const std::string &	type,
		const std::string &	cod_ts
	)

Define a TimeSeries object with the type and name passed as parameters.

It Interprets the following types:

• constant_ts: Defines a constant time series (ConstantSeries).
• linear_ts: Defines a linear time series (LinearSeries).
• path_ts: Defines a path time series (PathSeries).
• pulse_ts: Defines a pulse time series (PulseSeries).
• rectangular_ts: Defines a rectangular time series (RectangularSeries).
• triangular_ts: Defines a triangular time series (TriangleSeries).
• trig_ts: Defines a trigonometric time series (TrigSeries).

---

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

• src/domain/load/pattern/MapLoadPatterns.h
• src/domain/load/pattern/MapLoadPatterns.cc