glo::ClassInfoItem Class Reference

Base class of a ClassInfoAttribute and a ClassInfoIndex. More...

#include <GloClassInfoItem.h>

Inheritance diagram for glo::ClassInfoItem:

Public Member Functions
	ClassInfoItem ()
	ClassInfoItem (const ClassInfoItem &rT)
	ClassInfoItem (const std::string &rsName)
virtual	~ClassInfoItem ()
unsigned long	getClassID () const
std::string	getClassName () const
std::string	getDeveloperDescription () const
std::string	getName () const
ClassInfo *	getParent ()
ClassInfoItem &	operator= (const ClassInfoItem &rT)
void	setDeveloperDescription (const std::string &rsDeveloperDescription)
void	setMyClassInfo (ClassInfo *pMyClassInfo)
void	setName (const std::string &rsName)
bool	operator== (const ClassInfoItem &rT) const
	Comparison operator, all attributes are compared.
bool	operator!= (const ClassInfoItem &rT) const
	Comparison operator, all attributes are compared.

Private Attributes
ClassInfo *	m_pParent
std::string	m_sClassInfoName
std::string	m_sDeveloperDescription
std::string	m_sName
unsigned long	m_ulClassInfoClassID

Detailed Description

Base class of a ClassInfoAttribute and a ClassInfoIndex.

To build and search objects from tables, we need attribute and index information.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

ClassInfoItem() [1/3]

glo::ClassInfoItem::ClassInfoItem

(

)

Standard constructor.

ClassInfoItem() [2/3]

glo::ClassInfoItem::ClassInfoItem

(

const std::string &

rsName

)

Constructor with parameter passing.

Parameters

[in]

rsName

An attribute or index name is expected.

ClassInfoItem() [3/3]

glo::ClassInfoItem::ClassInfoItem

(

const ClassInfoItem &

rT

)

Copy constructor.

Parameters

[in]

rT

The data is copied from this object.

Note

The pointer m_pParent to the owning class information is not transferred.

~ClassInfoItem()

virtual glo::ClassInfoItem::~ClassInfoItem ( )

virtual

Destructor.

Member Function Documentation

getClassID()

unsigned long glo::ClassInfoItem::getClassID

(

)

const

Returns the class ID from the 'owning' class information.

Returns

The class ID.

getClassName()

std::string glo::ClassInfoItem::getClassName

(

)

const

Returns the class name from the 'owning' class information.

Returns

The class name.

getDeveloperDescription()

std::string glo::ClassInfoItem::getDeveloperDescription

(

)

const

Returns

The developer description.

getName()

std::string glo::ClassInfoItem::getName

(

)

const

Returns the name of the derived attribute or derived index.

Returns

The name.

getParent()

ClassInfo * glo::ClassInfoItem::getParent

(

)

Returns

The owning class information.

operator!=()

bool glo::ClassInfoItem::operator!=

(

const ClassInfoItem &

rT

)

const

Comparison operator, all attributes are compared.

Parameters

[in]

rT

The object to be compared with this one.

operator=()

ClassInfoItem & glo::ClassInfoItem::operator=

(

const ClassInfoItem &

rT

)

Assignment operator.

Parameters

[in]

rT

The data is transferred from this object.

Note

The pointer m_pParent to the owning class information is not transferred.

operator==()

bool glo::ClassInfoItem::operator==

(

const ClassInfoItem &

rT

)

const

Comparison operator, all attributes are compared.

Parameters

[in]

rT

The object to be compared with this one.

setDeveloperDescription()

void glo::ClassInfoItem::setDeveloperDescription

(

const std::string &

rsDeveloperDescription

)

Sets the developer description.

Parameters

[in]

rsDeveloperDescription

The developer description.

setMyClassInfo()

void glo::ClassInfoItem::setMyClassInfo

(

ClassInfo *

pMyClassInfo

)

Sets m_pParent.

Parameters

[in]

pMyClassInfo

The owning class information.

Attention

No copy is made of pMyClassInfo; therefore the passed ClassInfo must not be removed from memory before an object of this class.

setName()

void glo::ClassInfoItem::setName

(

const std::string &

rsName

)

Sets the name of the derived attribute or derived index.

Parameters

[in]

rsName

The name.

Member Data Documentation

m_pParent

ClassInfo* glo::ClassInfoItem::m_pParent

private

The owning class information.

Note

The pointer to the owning class information is not transferred when copying (copy constructor) and assigning ('=' operator).

m_sClassInfoName

std::string glo::ClassInfoItem::m_sClassInfoName

private

The class name from the 'owner' class information.

m_sDeveloperDescription

std::string glo::ClassInfoItem::m_sDeveloperDescription

private

A description for the developer. Is only set and evaluated by the schema interface if it is in developer mode.

Attention

Is NOT streamed into or taken from a blob.

m_sName

std::string glo::ClassInfoItem::m_sName

private

The name of the derived attribute respectively index.

m_ulClassInfoClassID

unsigned long glo::ClassInfoItem::m_ulClassInfoClassID

private

The class ID from the 'owner' class information.

---

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

• GloClassInfoItem.h