CuteHMI - Shared Database (CuteHMI.SharedDatabase.0)
cutehmi::shareddatabase::Database Class Reference

Database. More...

#include <cutehmi/shareddatabase/Database.hpp>

Inheritance diagram for cutehmi::shareddatabase::Database:
QObject cutehmi::services::Serviceable CuteHMI::SharedDatabase::Database

Signals

void typeChanged ()
 
void hostChanged ()
 
void portChanged ()
 
void nameChanged ()
 
void userChanged ()
 
void passwordChanged ()
 
void connectionNameChanged ()
 
void threadedChanged ()
 
void connected ()
 
void disconnected ()
 
void errored (InplaceError error)
 

Public Member Functions

 Database (QObject *parent=nullptr)
 
 ~Database () override
 
QString type () const
 Get database type. More...
 
void setType (const QString &type)
 Set database type. More...
 
QString host () const
 Get host. More...
 
void setHost (const QString &host)
 Set host. More...
 
int port () const
 Get port. More...
 
void setPort (int port)
 Set port. More...
 
QString name () const
 Get database name. More...
 
void setName (const QString &name)
 Set database name. More...
 
QString user () const
 Get databse user. More...
 
void setUser (const QString &user)
 Set databse user. More...
 
QString password () const
 Get database password. More...
 
void setPassword (const QString &password)
 Set database password. More...
 
QString connectionName () const
 Get connection name. More...
 
void setConnectionName (const QString &connectionName)
 Set connection name. More...
 
bool threaded () const
 Get threaded status. More...
 
void setThreaded (bool threaded)
 Set threaded status. More...
 
std::unique_ptr< ServiceStatusesconfigureStarted (QState *active, const QState *idling, const QState *yielding) override
 
std::unique_ptr< ServiceStatusesconfigureStarting (QState *starting) override
 
std::unique_ptr< ServiceStatusesconfigureStopping (QState *stopping) override
 
std::unique_ptr< ServiceStatusesconfigureBroken (QState *broken) override
 
std::unique_ptr< ServiceStatusesconfigureRepairing (QState *repairing) override
 
std::unique_ptr< ServiceStatusesconfigureEvacuating (QState *evacuating) override
 
std::unique_ptr< QAbstractTransitiontransitionToStarted () const override
 
std::unique_ptr< QAbstractTransitiontransitionToStopped () const override
 
std::unique_ptr< QAbstractTransitiontransitionToBroken () const override
 
std::unique_ptr< QAbstractTransitiontransitionToYielding () const override
 
std::unique_ptr< QAbstractTransitiontransitionToIdling () const override
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
virtual void * qt_metacast (const char *)
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
 QObject (QObject *parent)
 
virtual ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
const QObjectList & children () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
- Public Member Functions inherited from cutehmi::services::Serviceable
 Serviceable ()=default
 

Static Public Member Functions

static bool IsConnected (const QString &connectionName)
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 

Static Public Attributes

static const char * INITIAL_TYPE = "QPSQL"
 
static const char * INITIAL_HOST = "localhost"
 
static constexpr int INITIAL_PORT = 5432
 
static const char * INITIAL_NAME = "dbname"
 
static const char * INITIAL_USER = "user"
 
static const char * INITIAL_PASSWORD = "password"
 
static constexpr bool INITIAL_THREADED = true
 

Properties

QString type
 Database type. More...
 
QString host
 
int port
 
QString name
 
QString user
 
QString password
 
QString connectionName
 
bool threaded
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Public Types inherited from cutehmi::services::Serviceable
typedef QHash< QState *, QStringServiceStatuses
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
- Protected Member Functions inherited from cutehmi::services::Serviceable
virtual ~Serviceable ()=default
 
 Serviceable (const Serviceable &other)=default
 
Serviceableoperator= (const Serviceable &other)=default
 

Detailed Description

Database.

This class stores databse configuration and manages database connection, which is established in dedicated thread.

Constructor & Destructor Documentation

◆ Database()

cutehmi::shareddatabase::Database::Database ( QObject parent = nullptr)

◆ ~Database()

cutehmi::shareddatabase::Database::~Database ( )
override

Member Function Documentation

◆ configureBroken()

std::unique_ptr< services::Serviceable::ServiceStatuses > cutehmi::shareddatabase::Database::configureBroken ( QState broken)
overridevirtual

◆ configureEvacuating()

std::unique_ptr< services::Serviceable::ServiceStatuses > cutehmi::shareddatabase::Database::configureEvacuating ( QState evacuating)
overridevirtual

◆ configureRepairing()

std::unique_ptr< services::Serviceable::ServiceStatuses > cutehmi::shareddatabase::Database::configureRepairing ( QState repairing)
overridevirtual

◆ configureStarted()

std::unique_ptr< services::Serviceable::ServiceStatuses > cutehmi::shareddatabase::Database::configureStarted ( QState active,
const QState idling,
const QState yielding 
)
overridevirtual

◆ configureStarting()

std::unique_ptr< services::Serviceable::ServiceStatuses > cutehmi::shareddatabase::Database::configureStarting ( QState starting)
overridevirtual

◆ configureStopping()

std::unique_ptr< services::Serviceable::ServiceStatuses > cutehmi::shareddatabase::Database::configureStopping ( QState stopping)
overridevirtual

◆ connected

void cutehmi::shareddatabase::Database::connected ( )
signal

◆ connectionName()

QString cutehmi::shareddatabase::Database::connectionName ( ) const

Get connection name.

Returns
connection name.

◆ connectionNameChanged

void cutehmi::shareddatabase::Database::connectionNameChanged ( )
signal

◆ disconnected

void cutehmi::shareddatabase::Database::disconnected ( )
signal

◆ errored

void cutehmi::shareddatabase::Database::errored ( InplaceError  error)
signal

◆ host()

QString cutehmi::shareddatabase::Database::host ( ) const

Get host.

Returns
host name.

◆ hostChanged

void cutehmi::shareddatabase::Database::hostChanged ( )
signal

◆ IsConnected()

bool cutehmi::shareddatabase::Database::IsConnected ( const QString connectionName)
static

◆ name()

QString cutehmi::shareddatabase::Database::name ( ) const

Get database name.

Returns
database name.

◆ nameChanged

void cutehmi::shareddatabase::Database::nameChanged ( )
signal

◆ password()

QString cutehmi::shareddatabase::Database::password ( ) const

Get database password.

Returns
password.

◆ passwordChanged

void cutehmi::shareddatabase::Database::passwordChanged ( )
signal

◆ port()

int cutehmi::shareddatabase::Database::port ( ) const

Get port.

Returns
port number.

◆ portChanged

void cutehmi::shareddatabase::Database::portChanged ( )
signal

◆ setConnectionName()

void cutehmi::shareddatabase::Database::setConnectionName ( const QString connectionName)

Set connection name.

Parameters
connectionNameconnection name.

◆ setHost()

void cutehmi::shareddatabase::Database::setHost ( const QString host)

Set host.

Parameters
hosthost name.

◆ setName()

void cutehmi::shareddatabase::Database::setName ( const QString name)

Set database name.

Parameters
namedatabase name.

◆ setPassword()

void cutehmi::shareddatabase::Database::setPassword ( const QString password)

Set database password.

Parameters
passwordpassword.

◆ setPort()

void cutehmi::shareddatabase::Database::setPort ( int  port)

Set port.

Parameters
portport number.

◆ setThreaded()

void cutehmi::shareddatabase::Database::setThreaded ( bool  threaded)

Set threaded status.

Threaded connection is established

Parameters
threadeddetermines whether connection should be established in a separate thread.

◆ setType()

void cutehmi::shareddatabase::Database::setType ( const QString type)

Set database type.

Parameters
typedatabase type.

◆ setUser()

void cutehmi::shareddatabase::Database::setUser ( const QString user)

Set databse user.

Parameters
useruser name.

◆ threaded()

bool cutehmi::shareddatabase::Database::threaded ( ) const

Get threaded status.

Threaded status determines whether connection is threaded, i.e. it is established in a separate thread.

Returns
true when connection should be established in separate thread, false otherwise.

◆ threadedChanged

void cutehmi::shareddatabase::Database::threadedChanged ( )
signal

◆ transitionToBroken()

std::unique_ptr< QAbstractTransition > cutehmi::shareddatabase::Database::transitionToBroken ( ) const
overridevirtual

◆ transitionToIdling()

std::unique_ptr< QAbstractTransition > cutehmi::shareddatabase::Database::transitionToIdling ( ) const
overridevirtual

◆ transitionToStarted()

std::unique_ptr< QAbstractTransition > cutehmi::shareddatabase::Database::transitionToStarted ( ) const
overridevirtual

◆ transitionToStopped()

std::unique_ptr< QAbstractTransition > cutehmi::shareddatabase::Database::transitionToStopped ( ) const
overridevirtual

◆ transitionToYielding()

std::unique_ptr< QAbstractTransition > cutehmi::shareddatabase::Database::transitionToYielding ( ) const
overridevirtual

◆ type()

QString cutehmi::shareddatabase::Database::type ( ) const

Get database type.

Returns
database type.

◆ typeChanged

void cutehmi::shareddatabase::Database::typeChanged ( )
signal

◆ user()

QString cutehmi::shareddatabase::Database::user ( ) const

Get databse user.

Returns
user name.

◆ userChanged

void cutehmi::shareddatabase::Database::userChanged ( )
signal

Member Data Documentation

◆ INITIAL_HOST

const char * cutehmi::shareddatabase::Database::INITIAL_HOST = "localhost"
static

◆ INITIAL_NAME

const char * cutehmi::shareddatabase::Database::INITIAL_NAME = "dbname"
static

◆ INITIAL_PASSWORD

const char * cutehmi::shareddatabase::Database::INITIAL_PASSWORD = "password"
static

◆ INITIAL_PORT

constexpr int cutehmi::shareddatabase::Database::INITIAL_PORT = 5432
staticconstexpr

◆ INITIAL_THREADED

constexpr bool cutehmi::shareddatabase::Database::INITIAL_THREADED = true
staticconstexpr

◆ INITIAL_TYPE

const char * cutehmi::shareddatabase::Database::INITIAL_TYPE = "QPSQL"
static

◆ INITIAL_USER

const char * cutehmi::shareddatabase::Database::INITIAL_USER = "user"
static

Property Documentation

◆ connectionName

QString cutehmi::shareddatabase::Database::connectionName
readwrite

◆ host

QString cutehmi::shareddatabase::Database::host
readwrite

◆ name

QString cutehmi::shareddatabase::Database::name
readwrite

◆ password

QString cutehmi::shareddatabase::Database::password
readwrite

◆ port

int cutehmi::shareddatabase::Database::port
readwrite

◆ threaded

bool cutehmi::shareddatabase::Database::threaded
readwrite

◆ type

QString cutehmi::shareddatabase::Database::type
readwrite

Database type.

Use Qt driver name to specify the type.

◆ user

QString cutehmi::shareddatabase::Database::user
readwrite