hellomal::DbInterface Class Reference

#include <dbInterface.hpp>

Public Member Functions
	DbInterface (const std::string &prefix, rad::DbAdapter &runtime_db)
virtual	~DbInterface ()
std::string	GetControlState ()
std::string	GetControlSubstate ()
std::string	GetControlStatus ()
std::string	Get (const std::string &key)
void	SetControlState (const std::string &value)
void	SetControlSubstate (const std::string &value)
void	SetControlStatus (const std::string &value)
void	SetControl (const std::string &state, const std::string &substate, const std::string &status)
void	SetConfig (Config &cfg)
void	Set (const std::string &key, const std::string &value)
	DbInterface (const DbInterface &)=delete
DbInterface &	operator= (const DbInterface &)=delete
	Disable copy constructor. More...
	DbInterface (const std::string &prefix, rad::DbAdapter &runtime_db)
virtual	~DbInterface ()
std::string	GetControlState ()
std::string	GetControlSubstate ()
std::string	GetControlStatus ()
std::string	Get (const std::string &key)
void	SetControlState (const std::string &value)
void	SetControlSubstate (const std::string &value)
void	SetControlStatus (const std::string &value)
void	SetControl (const std::string &state, const std::string &substate, const std::string &status)
void	SetConfig (Config &cfg)
void	Set (const std::string &key, const std::string &value)
	DbInterface (const DbInterface &)=delete
DbInterface &	operator= (const DbInterface &)=delete
	Disable copy constructor. More...

Detailed Description

This class is the interface to the in-memory DB.

Constructor & Destructor Documentation

hellomal::DbInterface::DbInterface	(	const std::string &	prefix,
		rad::DbAdapter &	runtime_db
	)

Constructor.

Parameters

[in]	prefix	String used as prefix when building the keys.
[in]	runtime_db	Reference to the in-memory DB adapter.

hellomal::DbInterface::~DbInterface ( )

virtual

Destructor

hellomal::DbInterface::DbInterface ( const DbInterface &  )

delete

hellomal::DbInterface::DbInterface	(	const std::string &	prefix,
		rad::DbAdapter &	runtime_db
	)

Constructor.

Parameters

[in]	prefix	String used as prefix when building the keys.
[in]	runtime_db	Reference to the in-memory DB adapter.

virtual hellomal::DbInterface::~DbInterface ( )

virtual

Destructor

hellomal::DbInterface::DbInterface ( const DbInterface &  )

delete

Member Function Documentation

std::string hellomal::DbInterface::Get

(

const std::string &

key

)

Parameters

[in]

key

Key in the DB.

Returns

The value stored in the DB associated to the given key.

std::string hellomal::DbInterface::Get

(

const std::string &

key

)

Parameters

[in]

key

Key in the DB.

Returns

The value stored in the DB associated to the given key.

std::string hellomal::DbInterface::GetControlState

(

)

Returns

The current state of the application stored in the DB.

std::string hellomal::DbInterface::GetControlState

(

)

Returns

The current state of the application stored in the DB.

std::string hellomal::DbInterface::GetControlStatus

(

)

Returns

The current state and sub-state of the application stored in the DB.

std::string hellomal::DbInterface::GetControlStatus

(

)

Returns

The current state and sub-state of the application stored in the DB.

std::string hellomal::DbInterface::GetControlSubstate

(

)

Returns

The current sub-state of the application stored in the DB.

std::string hellomal::DbInterface::GetControlSubstate

(

)

Returns

The current sub-state of the application stored in the DB.

DbInterface& hellomal::DbInterface::operator= ( const DbInterface &  )

delete

Disable copy constructor.

DbInterface& hellomal::DbInterface::operator= ( const DbInterface &  )

delete

Disable copy constructor.

void hellomal::DbInterface::Set	(	const std::string &	key,
		const std::string &	value
	)

Parameters

[in]	key	Key to be written in the DB.
[in]	value	Value, associated to the given key, to be written in the DB.

void hellomal::DbInterface::Set	(	const std::string &	key,
		const std::string &	value
	)

Parameters

[in]	key	Key to be written in the DB.
[in]	value	Value, associated to the given key, to be written in the DB.

void hellomal::DbInterface::SetConfig

(

Config &

cfg

)

Set the application configuration information in the DB.

Parameters

[in]	reqEndpoint	Request msg endpoint.
[in]	dbIpAddr	DB IP address.
[in]	dbPort	DB port.
[in]	dbTimeout	DB timeout.

void hellomal::DbInterface::SetConfig

(

Config &

cfg

)

Set the application configuration information in the DB.

Parameters

[in]	reqEndpoint	Request msg endpoint.
[in]	dbIpAddr	DB IP address.
[in]	dbPort	DB port.
[in]	dbTimeout	DB timeout.

void hellomal::DbInterface::SetControl	(	const std::string &	state,
		const std::string &	substate,
		const std::string &	status
	)

Set the application control information in the DB.

Parameters

[in]	state	State to be stored in the DB.
[in]	substate	Substate to be stored in the DB.
[in]	status	Status to be stored in the DB.

void hellomal::DbInterface::SetControl	(	const std::string &	state,
		const std::string &	substate,
		const std::string &	status
	)

Set the application control information in the DB.

Parameters

[in]	state	State to be stored in the DB.
[in]	substate	Substate to be stored in the DB.
[in]	status	Status to be stored in the DB.

void hellomal::DbInterface::SetControlState

(

const std::string &

value

)

Parameters

[in]

value

State to be stored in the DB.

void hellomal::DbInterface::SetControlState

(

const std::string &

value

)

Parameters

[in]

value

State to be stored in the DB.

void hellomal::DbInterface::SetControlStatus

(

const std::string &

value

)

Parameters

[in]

value

Status (state and substate) to be stored in the DB.

void hellomal::DbInterface::SetControlStatus

(

const std::string &

value

)

Parameters

[in]

value

Status (state and substate) to be stored in the DB.

void hellomal::DbInterface::SetControlSubstate

(

const std::string &

value

)

Parameters

[in]

value

Sub-state to be stored in the DB.

void hellomal::DbInterface::SetControlSubstate

(

const std::string &

value

)

Parameters

[in]

value

Sub-state to be stored in the DB.

---

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

• INTROOT/sources/hellomal/src/dbInterface.hpp
• test/templates/genMalSm/hello/hellomal/src/dbInterface.hpp
• INTROOT/sources/hellomal/src/dbInterface.cpp
• test/templates/genMalSm/hello/hellomal/src/dbInterface.cpp