glo::OdRefRecordAttribute Class Reference

Class for the on-demand reference attributes of a Record. Represents an attribute of type 'TOndemand<MyPersClass>' and MyPersClass is a persistent object. The referenced object is generally not automatically loaded with the owning object. More...

#include <GloOdRefRecordAttribute.h>

Inheritance diagram for glo::OdRefRecordAttribute:

Public Member Functions
	OdRefRecordAttribute (ClassInfoAttribute *pType, const std::streampos &rFilePos)
	OdRefRecordAttribute (ClassInfoAttribute *pType, ObjID Value, const std::streampos &rFilePos)
virtual BaseRecordAttribute *	getCopy ()
virtual int	setValueFromObjectAttributeID (Persistent &rObject, const AttributeID &rAttributeID)
bool	operator== (const OdRefRecordAttribute &rT) const
	Comparison operator, all attributes are compared.
bool	operator!= (const OdRefRecordAttribute &rT) const
	Comparison operator, all attributes are compared.
Public Member Functions inherited from glo::IDRecordAttribute
	IDRecordAttribute (ClassInfoAttribute *pType, const std::streampos &rFilePos)
	IDRecordAttribute (ClassInfoAttribute *pType, ObjID Value, const std::streampos &rFilePos)
virtual bool	dataIsFieldContent () const
virtual unsigned short	getDataFieldLength () const
virtual std::string	getValueAsDataString () const
virtual std::string	getValueAsDisplayString () const
virtual std::string	getValueAsStreamString () const
virtual std::string	getValueAsString () const
std::string	getValueAsString (const ObjID &rValue) const
virtual void *	getValueAsVoidPointer ()
const ObjID &	getValueRef () const
virtual void	initNew ()
virtual void	setValue (ObjID Value)
virtual void	setValueFromVoid (void *pValue)
virtual int	takeValue (const BaseRecordAttribute &rT)
bool	operator== (const IDRecordAttribute &rT) const
	Comparison operator, all attributes are compared.
bool	operator!= (const IDRecordAttribute &rT) const
	Comparison operator, all attributes are compared.
Public Member Functions inherited from glo::BaseRecordAttribute
	BaseRecordAttribute (ClassInfoAttribute *pClassInfoAttribut, const std::streampos &rFilePos)
virtual	~BaseRecordAttribute ()
unsigned int	forget ()
AttributeID	getAttributeID () const
virtual int	getAttributeValueBlob (eut::Blob &rBlob) const
ClassInfoAttribute *	getClassInfoAttribute () const
std::string	getClassMemberName () const
std::string	getClassName () const
virtual std::string	getDataReference () const
EnDataType	getDataType () const
std::string	getFieldName () const
int	getFieldPos ()
std::streampos	getFilePosition () const
virtual int	getFormattedFieldContents (std::string &rsRetVal, DATA_REFERENCE_INFO &rRetValInfo, ObjID ObjID)
EnDataTypeGroup	getInfoType ()
unsigned int	getReferenceCount () const
std::string	getTableFieldName () const
std::string	getTableName () const
ClassInfoAttribute::Type	getType () const
std::string	getTypeAsCppString () const
std::string	getTypeAsString () const
std::string	getTypeInfo () const
unsigned int	remember ()
virtual void	setDataReference (const std::string &rsDataReference)
void	setFilePosition (const std::streampos &rFilePos)
virtual int	updateDataReference (const std::string &rsDataPath, DATA_REFERENCE_INFO MethodInfo)
bool	operator== (const BaseRecordAttribute &rT) const
	Comparison operator, all attributes are compared.
bool	operator!= (const BaseRecordAttribute &rT) const
	Comparison operator, all attributes are compared.

Protected Member Functions
	OdRefRecordAttribute ()
	OdRefRecordAttribute (const OdRefRecordAttribute &rT)
virtual	~OdRefRecordAttribute ()
Protected Member Functions inherited from glo::IDRecordAttribute
	IDRecordAttribute ()
	IDRecordAttribute (const IDRecordAttribute &rT)
virtual	~IDRecordAttribute ()
Protected Member Functions inherited from glo::BaseRecordAttribute
	BaseRecordAttribute ()
	BaseRecordAttribute (const BaseRecordAttribute &rT)

Private Member Functions
OdRefRecordAttribute &	operator= (const OdRefRecordAttribute &)

Detailed Description

Class for the on-demand reference attributes of a Record. Represents an attribute of type 'TOndemand<MyPersClass>' and MyPersClass is a persistent object. The referenced object is generally not automatically loaded with the owning object.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

OdRefRecordAttribute() [1/4]

glo::OdRefRecordAttribute::OdRefRecordAttribute ( )

protected

The standard constructor is not available.

~OdRefRecordAttribute()

virtual glo::OdRefRecordAttribute::~OdRefRecordAttribute ( )

protectedvirtual

The destructor is not available. The object may only be removed from memory using forget().

OdRefRecordAttribute() [2/4]

glo::OdRefRecordAttribute::OdRefRecordAttribute	(	ClassInfoAttribute *	pType,
		const std::streampos &	rFilePos )

Constructor with parameter passing.

Parameters

[in]	pType	A class information attribute is expected.
[in]	rFilePos	The file position.

Exceptions

eut::ErrorNException

An exception will be thrown if an error occurs.

Attention

Since objects of these classes are only instantiated by internal objects like Record and TableReaderInterface, and they know what they are doing, a type check of the class information attribute is omitted!

OdRefRecordAttribute() [3/4]

glo::OdRefRecordAttribute::OdRefRecordAttribute	(	ClassInfoAttribute *	pType,
		ObjID	Value,
		const std::streampos &	rFilePos )

Constructor with parameter passing.

Parameters

[in]	pType	A class information attribute is expected.
[in]	Value	The value of the attribute.
[in]	rFilePos	The file position.

Exceptions

eut::ErrorNException

An exception will be thrown if an error occurs.

Attention

Since objects of these classes are only instantiated by internal objects like Record and TableReaderInterface, and they know what they are doing, a type check of the class information attribute is omitted!

OdRefRecordAttribute() [4/4]

glo::OdRefRecordAttribute::OdRefRecordAttribute ( const OdRefRecordAttribute & rT )

protected

Copy constructor.

Parameters

[in]

rT

The data is copied from this object.

See also

getCopy()

Member Function Documentation

getCopy()

virtual BaseRecordAttribute * glo::OdRefRecordAttribute::getCopy ( )

virtual

Returns a copy of the object. Sometimes a copy of an attribute is needed, e.g. if a deep-copied record (with copied attributes) is needed.

Returns

The copy of this attribute

Attention

The supplied object must be removed from memory by the calling instance.

Implements glo::BaseRecordAttribute.

operator!=()

bool glo::OdRefRecordAttribute::operator!=

(

const OdRefRecordAttribute &

rT

)

const

Comparison operator, all attributes are compared.

Parameters

[in]

rT

The object to be compared with this one.

operator=()

OdRefRecordAttribute & glo::OdRefRecordAttribute::operator= ( const OdRefRecordAttribute & )

private

The assignment operator is not available.

operator==()

bool glo::OdRefRecordAttribute::operator==

(

const OdRefRecordAttribute &

rT

)

const

Comparison operator, all attributes are compared.

Parameters

[in]

rT

The object to be compared with this one.

setValueFromObjectAttributeID()

virtual int glo::OdRefRecordAttribute::setValueFromObjectAttributeID ( Persistent & rObject, const AttributeID & rAttributeID )

virtual

The value of the RecordAttribut from the class attribute of the passed Persistent is determined and set based on the passed AttributeID.

Parameters

[in]	rObject	The persistent object whose attribute is used.
[in]	rAttributeID	The ID of the attribute of the passed object.

Returns

A return value < 0 indicates an error.

Reimplemented from glo::BaseRecordAttribute.

---

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

• GloOdRefRecordAttribute.h