Object idenfied by an integer (tag). More...
#include <TaggedObject.h>
Inheritance diagram for XC::TaggedObject:
Collaboration diagram for XC::TaggedObject:
Public Member Functions | |
| TaggedObject (int tag, CommandEntity *owr=nullptr) | |
| Constructor. More... | |
| virtual TaggedObject * | getCopy (void) const |
| Virtual constructor. | |
| void | assignTag (int newTag) |
| Set tag (to be called from Python interface). | |
| int | getTag (void) const |
| Returns the tag associated with the object. | |
| virtual void | Print (std::ostream &, int flag=0) const |
| Print stuff. | |
| 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 |
Protected Member Functions | |
| void | setTag (int newTag) |
| Set tag. More... | |
| bool | isEqual (const TaggedObject &) const |
| Return true if both objects are equal. | |
| 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 | ElementHandler |
| class | Communicator |
| template<class T > | |
| T * | getBrokedTagged (const int &, const int &, const int &, FEM_ObjectBroker &, T *(FEM_ObjectBroker::*ptrFunc)(int)) |
| std::ostream & | operator<< (std::ostream &, const TaggedObject &) |
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. | |
| 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
Object idenfied by an integer (tag).
TaggedObject is used as a base class to represent all classes that may have a integer identifier, a tag, to identify the object. It is used in the framework as a base class for many classes, for example DomainComponent and Vertex. The class is provided so that container classes can be written to store objects and provide access to them. This saves us rewriting container classes for each type of object. (templates will be able to provide this functionality when they are provided with all compilers).
Constructor & Destructor Documentation
◆ TaggedObject()
| XC::TaggedObject::TaggedObject | ( | int | tag, |
| CommandEntity * | owr = nullptr |
||
| ) |
Constructor.
Constructs a TaggedObject with a tag given by tag. The tag of a component is some unique means of identifying the component among like components, i.e. the tag of a node would be its unique node number.
- Parameters
-
tag object identifier. owr object owner (this object is somewhat contained by).
Member Function Documentation
◆ setTag()
|
protected |
Set tag.
Sets the tag of the object to be newTag. It is provided so that MovableObjects can set their tag in recvSelf().
The documentation for this class was generated from the following files:
- src/utility/tagged/TaggedObject.h
- src/utility/tagged/TaggedObject.cpp
