CompleteDB Embedded: Direct C++ API  2.4.2
Config Class Reference

Provides services to query and modify configuration attributes of a Database. More...

#include <Config.hpp>

+ Inheritance diagram for Config:

Public Member Functions

bool cast (const Object &from)
bool isConnected () const
bool isDisconnected () const
Type::Enum getClassType () const
Type::Enum getObjectType () const
Error::Enum getLastErrorId () const
const char * getLastError () const
bool getGlobalAccess ()
bool getNumaOptimization ()
bool load ()
bool save ()
uint64_t getAddressSpaceMaxSizeGB ()
uint64_t getExtentSizeMB ()
uint64_t getFileMaxSizeGB ()
void setAddressSpaceMaxSizeGB (const uint64_t addressSpaceMaxSizeGB)
void setExtentSizeMB (const uint64_t extentSizeMB)
void setFileMaxSizeGB (const uint64_t fileMaxSizeGB)
void setGlobalAccess (const bool globalAccess)
void setNumaOptimization (const bool numaOptimization)
Configoperator= (const Config &src)
 Config (const Config &src)
virtual ~Config ()
 Config ()
- Public Member Functions inherited from Object
void * get () const
Objectoperator= (const Object &src)
 Object (const Object &src)
virtual ~Object ()
 Object ()
- Public Member Functions inherited from LastError
LastErroroperator= (const LastError &src)
 LastError (const LastError &src)
virtual ~LastError ()
 LastError ()

Friends

class Database

Additional Inherited Members

- Protected Member Functions inherited from Object
 Object (void *src)
- Protected Attributes inherited from Object
void * m

Detailed Description

Provides services to query and modify configuration attributes of a Database.

Definition at line 16 of file Config.hpp.

Constructor & Destructor Documentation

Config ( const Config src)
inline

Definition at line 75 of file Config.hpp.

virtual ~Config ( )
inlinevirtual

Definition at line 79 of file Config.hpp.

Config ( )
inline

Definition at line 80 of file Config.hpp.

Member Function Documentation

bool cast ( const Object from)
inlinevirtual

Performs safe typecast.

Reimplemented from LastError.

Definition at line 28 of file Config.hpp.

uint64_t getAddressSpaceMaxSizeGB ( )
inline

Definition at line 63 of file Config.hpp.

Type::Enum getClassType ( ) const
inlinevirtual

class type of the object.

Reimplemented from LastError.

Definition at line 40 of file Config.hpp.

uint64_t getExtentSizeMB ( )
inline

Definition at line 64 of file Config.hpp.

uint64_t getFileMaxSizeGB ( )
inline

Definition at line 65 of file Config.hpp.

bool getGlobalAccess ( )
inline

Definition at line 59 of file Config.hpp.

const char* getLastError ( ) const
inlinevirtual

Retrieves the calling object last-error text message.

Reimplemented from LastError.

Definition at line 55 of file Config.hpp.

Error::Enum getLastErrorId ( ) const
inlinevirtual

Retrieves the calling object last-error id value.

Reimplemented from LastError.

Definition at line 51 of file Config.hpp.

bool getNumaOptimization ( )
inline

Definition at line 60 of file Config.hpp.

Type::Enum getObjectType ( ) const
inlinevirtual

object type of the underlying derived object.

Reimplemented from LastError.

Definition at line 44 of file Config.hpp.

bool isConnected ( ) const
inlinevirtual

if underlying database is connected.

Reimplemented from LastError.

Definition at line 32 of file Config.hpp.

bool isDisconnected ( ) const
inlinevirtual

if underlying database is not connected.

Reimplemented from LastError.

Definition at line 36 of file Config.hpp.

bool load ( )
inline

Definition at line 61 of file Config.hpp.

Config& operator= ( const Config src)
inline

Definition at line 74 of file Config.hpp.

bool save ( )
inline

Definition at line 62 of file Config.hpp.

void setAddressSpaceMaxSizeGB ( const uint64_t  addressSpaceMaxSizeGB)
inline

Definition at line 66 of file Config.hpp.

void setExtentSizeMB ( const uint64_t  extentSizeMB)
inline

Definition at line 67 of file Config.hpp.

void setFileMaxSizeGB ( const uint64_t  fileMaxSizeGB)
inline

Definition at line 68 of file Config.hpp.

void setGlobalAccess ( const bool  globalAccess)
inline

Definition at line 69 of file Config.hpp.

void setNumaOptimization ( const bool  numaOptimization)
inline

Definition at line 70 of file Config.hpp.

Friends And Related Function Documentation

friend class Database
friend

Definition at line 21 of file Config.hpp.


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