IXE::ReferenceField< T > Class Template Reference
[Reflection]

Reference fields. More...

#include <metaclass.h>

Inheritance diagram for IXE::ReferenceField< T >:

List of all members.

Public Member Functions
	ReferenceField (char const *name, Size offset, Size maxLength, IndexType indexType, char const *merge=0)
virtual Field *	clone () const
virtual bool	isType (Type t)
	Check Field type.
virtual bool	isReference ()
	Whether the type is a reference type.
virtual bool	isPointer ()
	Whether the type is a pointer type (subsumes isReference()).
virtual MetaClass *	itemClass () const
	The metaclass of items.
virtual Size	size ()
	Size in bytes of field.
virtual Size	itemSize ()
virtual Size	length (byte *base)
	Number of items, if field contains pointer (or else its size).
virtual Size	packSize (byte *)
	Compute size of record needed for storing the field.
virtual std::ostream &	print (std::ostream &out)
	Display the Field information.
virtual Item *	item ()
	Create an Item to store a value for the Field.
virtual byte *	fetch (byte *dst, byte *&src)
	Method to fetch fields from a buffer.
virtual byte *	fetchKey (byte *dst, byte *src)
	Same as fetch() from key data, without header information, which gets converted from BigEndian order to host order.
virtual byte *	store (byte *&dst, byte *src)
	Method to store fields into a buffer.
virtual Size	storeKey (byte *dst, byte *src)
	Same as store() but without field header information, and BigEndian order to ensure comparison by bt_compare works.

---

Detailed Description

template<class T>
class IXE::ReferenceField< T >

Reference fields.

---

Member Function Documentation

template<class T>

virtual byte* IXE::ReferenceField< T >::fetch	(	byte *	dst,
		byte *&	src
	)			[inline, virtual]

Method to fetch fields from a buffer.

Parameters:

	dst	the location of the field.
	src	the buffer from which the field is fetched; it is advanced to the next field

Returns:

the position at the end of the field.

Implements IXE::Field.

template<class T>

virtual byte* IXE::ReferenceField< T >::fetchKey	(	byte *	dst,
		byte *	src
	)			[inline, virtual]

Same as fetch() from key data, without header information, which gets converted from BigEndian order to host order.

Parameters:

	dst	the location of the field.
	src	the buffer from which the field is fetched.

Returns:

the location of the field.

Implements IXE::Field.

template<class T>

virtual Size IXE::ReferenceField< T >::itemSize

(

)

[inline, virtual]

Returns:

the size of items, if this is a Reference, Var or ArrayField

Reimplemented from IXE::Field.

template<class T>

virtual Size IXE::ReferenceField< T >::packSize

(

byte *

base

)

[inline, virtual]

Compute size of record needed for storing the field.

This includes header information (eg. length) and padding for alignment

Parameters:

base

the location of the object to be stored. If base == 0, return the maximum size.

Implements IXE::Field.

template<class T>

virtual std::ostream& IXE::ReferenceField< T >::print

(

std::ostream &

out

)

[inline, virtual]

Display the Field information.

Parameters:

out

the output stream

Implements IXE::Field.

References IXE::Field::maxLength_, IXE::ReferenceField< T >::size(), and IXE::Field::type.

template<class T>

virtual byte* IXE::ReferenceField< T >::store	(	byte *&	dst,
		byte *	src
	)			[inline, virtual]

Method to store fields into a buffer.

Advances dst to next field.

Parameters:

	dst	the buffer where to store the field; it is advanced to the next field.
	src	the field in the object being stored.

Returns:

the position at the end of the field.

Implements IXE::Field.

template<class T>

virtual Size IXE::ReferenceField< T >::storeKey	(	byte *	dst,
		byte *	src
	)			[inline, virtual]

Same as store() but without field header information, and BigEndian order to ensure comparison by bt_compare works.

Parameters:

	dst	the buffer where to store the field.
	src	the field in the object being stored.

Returns:

the size of the field.

Implements IXE::Field.

---

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

• search/ixe/Common/metaclass.h