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

Bindable String column data accessor used to insert, select or update row column data in a database table. More...

#include <ColumnString.hpp>

+ Inheritance diagram for ColumnString:

Public Member Functions

bool cast (const Object &from)
bool isConnected () const
bool isDisconnected () const
Type::Enum getClassType () const
Type::Enum getObjectType () const
bool exists ()
ColumnState::Enum getState () const
ColumnType::Enum getType () const
uint32_t getLength () const
const char * getDescription () const
const char * getName () const
uint32_t getValueLength () const
const char * getValue () const
void setValue (const char *newValue, const int64_t optionalLength=-1)
ColumnStringoperator= (const ColumnString &src)
 ColumnString (const ColumnString &src)
virtual ~ColumnString ()
 ColumnString ()
- 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 ColumnInfo
ColumnInfooperator= (const ColumnInfo &src)
 ColumnInfo (const ColumnInfo &src)
virtual ~ColumnInfo ()
 ColumnInfo ()

Friends

class Columns
class Record

Additional Inherited Members

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

Detailed Description

Bindable String column data accessor used to insert, select or update row column data in a database table.

Definition at line 16 of file ColumnString.hpp.

Constructor & Destructor Documentation

ColumnString ( const ColumnString src)
inline

Definition at line 86 of file ColumnString.hpp.

virtual ~ColumnString ( )
inlinevirtual

Definition at line 90 of file ColumnString.hpp.

ColumnString ( )
inline

Definition at line 91 of file ColumnString.hpp.

Member Function Documentation

bool cast ( const Object from)
inlinevirtual

Performs safe typecast.

Reimplemented from ColumnInfo.

Definition at line 29 of file ColumnString.hpp.

bool exists ( )
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 49 of file ColumnString.hpp.

Type::Enum getClassType ( ) const
inlinevirtual

class type of the object.

Reimplemented from ColumnInfo.

Definition at line 41 of file ColumnString.hpp.

const char* getDescription ( ) const
inlinevirtual

Returns the description of the entity.

Reimplemented from ColumnInfo.

Definition at line 59 of file ColumnString.hpp.

uint32_t getLength ( ) const
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 52 of file ColumnString.hpp.

const char* getName ( ) const
inlinevirtual

Returns the name of the entity.

Reimplemented from ColumnInfo.

Definition at line 66 of file ColumnString.hpp.

Type::Enum getObjectType ( ) const
inlinevirtual

object type of the underlying derived object.

Reimplemented from ColumnInfo.

Definition at line 45 of file ColumnString.hpp.

ColumnState::Enum getState ( ) const
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 50 of file ColumnString.hpp.

ColumnType::Enum getType ( ) const
inlinevirtual

Reimplemented from ColumnInfo.

Definition at line 51 of file ColumnString.hpp.

const char* getValue ( ) const
inline

Returns current data value of the column.

Definition at line 77 of file ColumnString.hpp.

uint32_t getValueLength ( ) const
inline

Returns length of the current data value of the column.

Definition at line 73 of file ColumnString.hpp.

bool isConnected ( ) const
inlinevirtual

if underlying database is connected.

Reimplemented from ColumnInfo.

Definition at line 33 of file ColumnString.hpp.

bool isDisconnected ( ) const
inlinevirtual

if underlying database is not connected.

Reimplemented from ColumnInfo.

Definition at line 37 of file ColumnString.hpp.

ColumnString& operator= ( const ColumnString src)
inline

Definition at line 85 of file ColumnString.hpp.

void setValue ( const char *  newValue,
const int64_t  optionalLength = -1 
)
inline

Sets current data value of the column.

Definition at line 81 of file ColumnString.hpp.

Friends And Related Function Documentation

friend class Columns
friend

Definition at line 21 of file ColumnString.hpp.

friend class Record
friend

Definition at line 22 of file ColumnString.hpp.


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