hds::db::Object Class Reference

#include <object.hpp>

Inheritance diagram for hds::db::Object:

Public Types
typedef std::vector< std::string >	Names

Public Member Functions
	Object ()
virtual	~Object ()
virtual ErrCode	open (const std::string &name, OpenMode mode)=0
virtual OpenMode	openMode () const
virtual ErrCode	close ()=0
virtual ErrCode	flush ()=0
virtual std::string	name (ErrCode *rc=NULL) const =0
virtual ErrCode	setName (const std::string &name_str)=0
virtual ErrCode	remove (const std::string &name)=0
virtual ErrCode	getList (Names &list) const =0
virtual bool	exists (const std::string &name, ErrCode *rc=NULL) const
virtual size_t	dataSize (const std::string &name, ErrCode *rc=NULL) const =0
virtual time_t	creationTime (const std::string &name, ErrCode *rc=NULL) const =0
virtual time_t	modificationTime (const std::string &name, ErrCode *rc=NULL) const =0

Protected Attributes
OpenMode	m_cur_open_mode

Detailed Description

Data base object interface.

Member Typedef Documentation

typedef std::vector<std::string> hds::db::Object::Names

List of data base objects names.

Constructor & Destructor Documentation

hds::db::Object::Object

(

)

Construct data base object.

virtual hds::db::Object::~Object ( )

virtual

Destructor.

Member Function Documentation

virtual ErrCode hds::db::Object::close ( )

pure virtual

Try to close opened or created data. Return EC_NO_ERROR if all correct, 

otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual time_t hds::db::Object::creationTime ( const std::string &  name, ErrCode *  rc = NULL  ) const

pure virtual

Get creation time of the object with provided name.

Return EC_NO_ERROR if all correct, otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual size_t hds::db::Object::dataSize ( const std::string &  name, ErrCode *  rc = NULL  ) const

pure virtual

Get size of the object data in bytes.

Parameters

name	Name of the object.
rc	Resulted error code if provided.

Returns

Data size in bytes.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual bool hds::db::Object::exists ( const std::string &  name, ErrCode *  rc = NULL  ) const

virtual

Check whether object with provided name exists in data base.

Parameters

name	Name of requested object.
rc	Will be set to resulted error code if provided.

Returns

true if object exists otherwise return false.

virtual ErrCode hds::db::Object::flush ( )

pure virtual

Synchronizes modified data with database. 

Returns

EC_NO_ERROR if all done, otherwise return error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual ErrCode hds::db::Object::getList ( Names &  list ) const

pure virtual

Get list of data base objects names for current context.

Return EC_NO_ERROR if all correct, otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual time_t hds::db::Object::modificationTime ( const std::string &  name, ErrCode *  rc = NULL  ) const

pure virtual

Get modification time of the object with provided name.

Return EC_NO_ERROR if all correct, otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual std::string hds::db::Object::name ( ErrCode *  rc = NULL ) const

pure virtual

Get name of the object. 

rc will be EC_NO_ERROR if all correct, otherwise correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual ErrCode hds::db::Object::open ( const std::string &  name, OpenMode  mode  )

pure virtual

Try to open data with provided name. Return EC_NO_ERROR if all correct, 

otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual OpenMode hds::db::Object::openMode ( ) const

virtual

Return current open mode.

virtual ErrCode hds::db::Object::remove ( const std::string &  name )

pure virtual

Try to remove data with provided name. Return EC_NO_ERROR if all correct, 

otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

virtual ErrCode hds::db::Object::setName ( const std::string &  name_str )

pure virtual

Set name of the object (rename). 

Return EC_NO_ERROR if all correct, otherwise return correspondent error code.

Implemented in hds::db::SeismicQSql, and hds::db::ProjectQSql.

Member Data Documentation

OpenMode hds::db::Object::m_cur_open_mode

protected

< Current open mode

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/hds_db/base/object.hpp