xc
Public Member Functions | Protected Member Functions | List of all members
XC::MySqlDatastore Class Reference

Store model data in a MySQL database. More...

#include <MySqlDatastore.h>

Inheritance diagram for XC::MySqlDatastore:
Inheritance graph
[legend]
Collaboration diagram for XC::MySqlDatastore:
Collaboration graph
[legend]

Public Member Functions

 MySqlDatastore (const std::string &, Preprocessor &, FEM_ObjectBroker &, int dbRun=0)
 
 MySqlDatastore (const std::string &, const std::string &, const std::string &, const std::string &, unsigned int port, const std::string &, unsigned int clientFlag, Preprocessor &, FEM_ObjectBroker &, int dbRun=0)
 
std::string getTypeId (void) const
 
int sendMsg (int dbTag, int commitTag, const Message &, ChannelAddress *theAddress=nullptr)
 A method invoked to send the data in the Message object theMsg to another Channel object. More...
 
int recvMsg (int dbTag, int commitTag, Message &, ChannelAddress *theAddress=nullptr)
 Invoked to send the data in the Message object theMsg to another Channel object. More...
 
int sendMatrix (int dbTag, int commitTag, const Matrix &, ChannelAddress *theAddress=nullptr)
 Invoked to receive the data in the Matrix object theMatrix to another Channel object. More...
 
int recvMatrix (int dbTag, int commitTag, Matrix &, ChannelAddress *theAddress=nullptr)
 Invoked to receive the data in the Matrix object theMatrix to another Channel object. More...
 
int sendVector (int dbTag, int commitTag, const Vector &, ChannelAddress *theAddress=nullptr)
 Invoked to receive the data in the Vector object theVector to another Channel object. More...
 
int recvVector (int dbTag, int commitTag, Vector &, ChannelAddress *theAddress=nullptr)
 Invoked to receive the data in the Vector object theVector to another Channel object. More...
 
int sendID (int dbTag, int commitTag, const ID &, ChannelAddress *theAddress=nullptr)
 Invoked to receive the data in the ID object theID to another Channel object. More...
 
int recvID (int dbTag, int commitTag, ID &, ChannelAddress *theAddress=nullptr)
 Invoked to receive the data in the ID object theID to another Channel object. More...
 
int createTable (const std::string &tableName, const std::vector< std::string > &columns)
 
int insertData (const std::string &tableName, const std::vector< std::string > &columns, int commitTag, const Vector &data)
 
int getData (const std::string &tableName, const std::vector< std::string > &columns, int commitTag, Vector &data)
 
int setDbRun (int run)
 
int getDbRun (void)
 
- Public Member Functions inherited from XC::DBDatastore
 DBDatastore (const std::string &, Preprocessor &, FEM_ObjectBroker &)
 
- Public Member Functions inherited from XC::FE_Datastore
 FE_Datastore (const std::string &, Preprocessor &, FEM_ObjectBroker &theBroker)
 Constructor. More...
 
std::string addToProgram (void)
 Return \(nullptr\).
 
int setUpConnection (void)
 
int setNextAddress (const ChannelAddress &otherChannelAddress)
 Return \(0\).
 
ChannelAddressgetLastSendersAddress (void)
 Return \(nullptr\).
 
int sendObj (int commitTag, MovableObject &theObject, ChannelAddress *theAddress=0)
 Call {sendSelf(commitTag, *this, theBroker)} on theObject and return the result. More...
 
int recvObj (int commitTag, MovableObject &theObject, FEM_ObjectBroker &theBroker, ChannelAddress *theAddress=0)
 Call {recvSelf(commitTag, *this, theBroker)} on theObject and return the result. More...
 
int getDbTag (void) const
 To return a unique integer identifier at each call. More...
 
virtual const std::string & getName (void) const
 Returns the name passed as argument to the constructor.
 
virtual bool isDatastore (void) const
 Return true (this channel type IS a Datastore).
 
virtual int commitState (int commitTag)
 Stores the current state on the database. More...
 
virtual int restoreState (int commitTag)
 Invoked to restore the state of the domain from a database. More...
 
bool isSaved (int commitTag) const
 Returns true if the state identified by commitTag was previously saved on the database. More...
 
virtual int save (const int &commitTag)
 
virtual int restore (const int &commitTag)
 
- Public Member Functions inherited from XC::Channel
 Channel (CommandEntity *owr=nullptr)
 Constructor.
 
bool checkDbTag (const int &dbTag)
 Check if a dbTag is already used.
 
const IDgetUsedTags (void) const
 Return the list of dbTags already used.
 
void clearDbTags (void)
 Reset used database tags set.
 
int getTag (void) const
 Return the object tag.
 
template<class inputIterator >
int sendObjs (int commitTag, const inputIterator &first, const inputIterator &last, ChannelAddress *theAddress=nullptr)
 Send the objects on interval [first,last).
 
template<class inputIterator >
int recvObjs (int commitTag, const inputIterator &first, const inputIterator &last, FEM_ObjectBroker &, ChannelAddress *theAddress=nullptr)
 Receive an object sequence.
 
- Public Member Functions inherited from CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
virtual bool operator== (const EntityWithProperties &) const
 Comparison operator.
 
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.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Protected Member Functions

int createOpenSeesDatabase (const std::string &projectName)
 
int execute (const std::string &query)
 
- Protected Member Functions inherited from XC::FE_Datastore
FEM_ObjectBrokergetObjectBroker (void)
 Returns a pointer to theBroker object passed in the constructor.
 
const PreprocessorgetPreprocessor (void) const
 Returns a pointer to the object preprocessor.
 
PreprocessorgetPreprocessor (void)
 Returns a pointer to the object preprocessor.
 
- Protected Member Functions inherited from XC::Channel
int sendMovable (int commitTag, MovableObject &)
 Send theObject.
 
int receiveMovable (int commitTag, MovableObject &, FEM_ObjectBroker &)
 Receive theObject.
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) 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.
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::FE_Datastore
int lastDbTag
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Store model data in a MySQL database.

MySqlDatastore is a concrete subclass of DBDatastore. A MySqlDatastore object is used in the program to store/restore the geometry and state information in a model at a particular instance in the analysis. The information is stored in a MySQL Database which can be local or remote.

Member Function Documentation

◆ recvID()

int XC::MySqlDatastore::recvID ( int  dbTag,
int  commitTag,
ID theID,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to receive the data in the ID object theID to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theID. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ recvMatrix()

int XC::MySqlDatastore::recvMatrix ( int  dbTag,
int  commitTag,
Matrix theMatrix,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to receive the data in the Matrix object theMatrix to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theMatrix. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ recvMsg()

int XC::MySqlDatastore::recvMsg ( int  dbTag,
int  commitTag,
Message theMsg,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to send the data in the Message object theMsg to another Channel object.

The object will obtain the the size of the data that is being received by invoking getSize() on theMsg. The channel object is then responsible for receiving that amount of data from the channel whose address is given by theAddress. If theAddress is 0, the Channel receives from the Channel with the address last set in a send..(), recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ recvVector()

int XC::MySqlDatastore::recvVector ( int  dbTag,
int  commitTag,
Vector theVector,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to receive the data in the Vector object theVector to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theVector. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ sendID()

int XC::MySqlDatastore::sendID ( int  dbTag,
int  commitTag,
const ID theID,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to receive the data in the ID object theID to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theID. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ sendMatrix()

int XC::MySqlDatastore::sendMatrix ( int  dbTag,
int  commitTag,
const Matrix theMatrix,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to receive the data in the Matrix object theMatrix to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theMatrix. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ sendMsg()

int XC::MySqlDatastore::sendMsg ( int  dbTag,
int  commitTag,
const Message theMsg,
ChannelAddress theAddress = nullptr 
)
virtual

A method invoked to send the data in the Message object theMsg to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theMsg. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.

◆ sendVector()

int XC::MySqlDatastore::sendVector ( int  dbTag,
int  commitTag,
const Vector theVector,
ChannelAddress theAddress = nullptr 
)
virtual

Invoked to receive the data in the Vector object theVector to another Channel object.

The object will obtain the data and size of the data to be sent by invoking getData() and getSize() on theVector. The channel object is then responsible for sending that data to the remote channel address given by theAddress. If theAddress is 0, the Channel sends to the Channel with the address last set in a send..()}, recv..(), or setNextAddress() operation. To return 0 if successful, a negative number if not.

Implements XC::Channel.


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