glo::ShortRecordAttribute Class Reference

Class for the short attributes of a Record. Represents an attribute of the type 'short' of a persistent object. More...

#include <GloShortRecordAttribute.h>

Inheritance diagram for glo::ShortRecordAttribute:

Public Member Functions
	ShortRecordAttribute (ClassInfoAttribute *pType, const std::streampos &rFilePos)
	ShortRecordAttribute (ClassInfoAttribute *pType, short siValue, const std::streampos &rFilePos)
virtual bool	dataIsFieldContent () const
virtual BaseRecordAttribute *	getCopy ()
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
virtual void *	getValueAsVoidPointer ()
const short &	getValueRef () const
virtual void	initNew ()
void	setValue (short siValue)
virtual void	setValueFromVoid (void *pValue)
virtual int	takeValue (const BaseRecordAttribute &rT)
bool	operator== (const ShortRecordAttribute &rT) const
	Comparison operator.
bool	operator!= (const ShortRecordAttribute &rT) const
	Comparison operator.
Public Member Functions inherited from glo::INumRecordAttribute
	INumRecordAttribute (ClassInfoAttribute *pType, const std::streampos &rFilePos)
template<typename T >
std::string	getTValueAsString (const T &rTValue, bool bFillBlanks) const
bool	operator== (const INumRecordAttribute &rT) const
	Comparison operator, all attributes are compared.
bool	operator!= (const INumRecordAttribute &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	setValueFromObjectAttributeID (Persistent &rObject, const AttributeID &rAttributeID)
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
	ShortRecordAttribute ()
	ShortRecordAttribute (const ShortRecordAttribute &rT)
virtual	~ShortRecordAttribute ()
Protected Member Functions inherited from glo::INumRecordAttribute
	INumRecordAttribute ()
	INumRecordAttribute (const INumRecordAttribute &rT)
virtual	~INumRecordAttribute ()
Protected Member Functions inherited from glo::BaseRecordAttribute
	BaseRecordAttribute ()
	BaseRecordAttribute (const BaseRecordAttribute &rT)

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

Private Attributes
short	m_siValue

Detailed Description

Class for the short attributes of a Record. Represents an attribute of the type 'short' of a persistent object.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

ShortRecordAttribute() [1/4]

glo::ShortRecordAttribute::ShortRecordAttribute ( )

protected

The standard constructor is not available.

~ShortRecordAttribute()

virtual glo::ShortRecordAttribute::~ShortRecordAttribute ( )

protectedvirtual

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

ShortRecordAttribute() [2/4]

glo::ShortRecordAttribute::ShortRecordAttribute	(	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!

ShortRecordAttribute() [3/4]

glo::ShortRecordAttribute::ShortRecordAttribute	(	ClassInfoAttribute *	pType,
		short	siValue,
		const std::streampos &	rFilePos )

Constructor with parameter passing.

Parameters

[in]	pType	A class information attribute is expected.
[in]	siValue	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!

ShortRecordAttribute() [4/4]

glo::ShortRecordAttribute::ShortRecordAttribute ( const ShortRecordAttribute & rT )

protected

Copy constructor.

Parameters

[in]

rT

The data is copied from this object.

See also

getCopy()

Member Function Documentation

dataIsFieldContent()

virtual bool glo::ShortRecordAttribute::dataIsFieldContent ( ) const

virtual

Returns true, because the attribute data is stored as field content.

Returns

see above

Implements glo::BaseRecordAttribute.

getCopy()

virtual BaseRecordAttribute * glo::ShortRecordAttribute::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.

getDataFieldLength()

virtual unsigned short glo::ShortRecordAttribute::getDataFieldLength ( ) const

virtual

Returns the record field length of the attribute value.

Returns

The field length.

See also

SHORT_TEXT_LENGTH

Implements glo::BaseRecordAttribute.

getValueAsDataString()

virtual std::string glo::ShortRecordAttribute::getValueAsDataString ( ) const

virtual

Returns the value as a formatted data string with the correct length with the correct length for the entry in the table file.

Returns

The value as formatted data string.

Implements glo::BaseRecordAttribute.

getValueAsDisplayString()

virtual std::string glo::ShortRecordAttribute::getValueAsDisplayString ( ) const

virtual

Returns the value as it can be displayed for the GUI.

Returns

The value for the display.

Implements glo::BaseRecordAttribute.

getValueAsStreamString()

virtual std::string glo::ShortRecordAttribute::getValueAsStreamString ( ) const

virtual

Returns the value as string for the DataStreamer.

Returns

The value for the DataStreamer.

Implements glo::BaseRecordAttribute.

getValueAsString()

virtual std::string glo::ShortRecordAttribute::getValueAsString ( ) const

virtual

Returns the value as string.

Returns

The value as string.

Implements glo::BaseRecordAttribute.

getValueAsVoidPointer()

virtual void * glo::ShortRecordAttribute::getValueAsVoidPointer ( )

virtual

Returns a raw pointer to the value.

Returns

The raw pointer to the value.

Implements glo::BaseRecordAttribute.

getValueRef()

const short & glo::ShortRecordAttribute::getValueRef

(

)

const

Returns the reference to the value.

Returns

The value.

initNew()

virtual void glo::ShortRecordAttribute::initNew ( )

virtual

Reinitializes the attribute, the value is set to 0.

Implements glo::BaseRecordAttribute.

operator!=()

bool glo::ShortRecordAttribute::operator!=

(

const ShortRecordAttribute &

rT

)

const

Comparison operator.

Parameters

[in]

rT

The object to be compared with this one.

operator=()

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

private

The assignment operator is not available.

operator==()

bool glo::ShortRecordAttribute::operator==

(

const ShortRecordAttribute &

rT

)

const

Comparison operator.

Parameters

[in]

rT

The object to be compared with this one.

setValue()

void glo::ShortRecordAttribute::setValue

(

short

siValue

)

Sets the value of the attribute.

Parameters

[in]

siValue

The new value.

setValueFromVoid()

virtual void glo::ShortRecordAttribute::setValueFromVoid ( void * pValue )

virtual

Sets the value of the attribute. Is assigned via a static_cast.

Parameters

[in]

pValue

The raw pointer to the value.

Implements glo::BaseRecordAttribute.

takeValue()

virtual int glo::ShortRecordAttribute::takeValue ( const BaseRecordAttribute & rT )

virtual

Adopts the value from transferred attribute, if possible. An attempt is made to cast the value in some way.

Parameters

[in]

rT

The persistent attribute from which the values are to be taken.

Returns

An error or warning message from subclasses will be delivered if the cast does not work.

Reimplemented from glo::BaseRecordAttribute.

Member Data Documentation

m_siValue

short glo::ShortRecordAttribute::m_siValue

private

The value of the attribute.

---

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

• GloShortRecordAttribute.h