CharType Class Reference

Inheritance diagram for CharType:

List of all members.

Public Types
typedef uint	Ordinal
	Each type must have a unique positive integer ordinal associated with it.
Private Member Functions
virtual Ordinal	getOrdinal () const
	Returns: the ordinal representing this type.
virtual uint	getBitCount () const
	Returns: number of bits in marshalled representation, or 0 for a non-bit type; currently only 0 or 1 is supported
virtual uint	getFixedByteCount () const
	Returns: the width in bytes for a fixed-width non-bit type which admits no per-attribute precision, or 0 for types with per-attribute precision; for bit types, this yields the size of the unmarshalled representation
virtual uint	getMinByteCount (uint cbMaxWidth) const
	Gets the number of bytes required to store the narrowest value with this type, given a particular max byte count.
virtual uint	getAlignmentByteCount (uint cbWidth) const
	Gets the alignment size in bytes required for values of this type, given a particular max byte count.
virtual void	visitValue (DataVisitor &dataVisitor, void const *pData, TupleStorageByteLength cbData) const
	Visits a value of this type.
virtual int	compareValues (void const *pData1, TupleStorageByteLength cbData1, void const *pData2, TupleStorageByteLength cbData2) const
	Compares two values of this type.

---

Detailed Description

Definition at line 133 of file StandardTypeDescriptor.cpp.

---

Member Typedef Documentation

typedef uint StoredTypeDescriptor::Ordinal [inherited]

Each type must have a unique positive integer ordinal associated with it.

This is used to reconstruct a StoredTypeDescriptor object from a stored attribute definition.

Definition at line 44 of file StoredTypeDescriptor.h.

---

Member Function Documentation

virtual Ordinal CharType::getOrdinal

(

)

const [inline, private, virtual]

Returns:

the ordinal representing this type.

Implements StoredTypeDescriptor.

Definition at line 135 of file StandardTypeDescriptor.cpp.

References STANDARD_TYPE_CHAR.

    {
        return STANDARD_TYPE_CHAR;
    }

virtual uint CharType::getBitCount

(

)

const [inline, private, virtual]

Returns:

number of bits in marshalled representation, or 0 for a non-bit type; currently only 0 or 1 is supported

Implements StoredTypeDescriptor.

Definition at line 140 of file StandardTypeDescriptor.cpp.

    {
        return 0;
    }

virtual uint CharType::getFixedByteCount

(

)

const [inline, private, virtual]

Returns:

the width in bytes for a fixed-width non-bit type which admits no per-attribute precision, or 0 for types with per-attribute precision; for bit types, this yields the size of the unmarshalled representation

Implements StoredTypeDescriptor.

Definition at line 145 of file StandardTypeDescriptor.cpp.

    {
        return 0;
    }

virtual uint CharType::getMinByteCount

(

uint

cbMaxWidth

)

const [inline, private, virtual]

Gets the number of bytes required to store the narrowest value with this type, given a particular max byte count.

For a fixed-width type, the return value is the same as the input.

Parameters:

cbMaxWidth

maximum width for which to compute the minimum

Returns:

number of bytes

Implements StoredTypeDescriptor.

Definition at line 150 of file StandardTypeDescriptor.cpp.

    {
        return cbMaxWidth;
    }

virtual uint CharType::getAlignmentByteCount

(

uint

cbWidth

)

const [inline, private, virtual]

Gets the alignment size in bytes required for values of this type, given a particular max byte count.

This must be 1, 2, 4, or 8, and may not be greater than 2 for variable-width datatypes. For fixed-width datatypes, the width must be a multiple of the alignment size.

Parameters:

cbWidth

width for which to compute the alignment

Returns:

number of bytes

Implements StoredTypeDescriptor.

Definition at line 155 of file StandardTypeDescriptor.cpp.

    {
        return 1;
    }

virtual void CharType::visitValue	(	DataVisitor &	dataVisitor,
		void const *	pData,
		TupleStorageByteLength	cbData
	)			const [inline, private, virtual]

Visits a value of this type.

Parameters:

	dataVisitor	the DataVisitor which should be called with the interpreted value
	pData	the address of the data value
	cbData	the number of bytes of data

Implements StoredTypeDescriptor.

Definition at line 160 of file StandardTypeDescriptor.cpp.

References DataVisitor::visitChars().

    {
        char const *pStr = static_cast<char const *>(pData);
        dataVisitor.visitChars(pStr,cbData);
    }

virtual int CharType::compareValues	(	void const *	pData1,
		TupleStorageByteLength	cbData1,
		void const *	pData2,
		TupleStorageByteLength	cbData2
	)			const [inline, private, virtual]

Compares two values of this type.

Parameters:

	pData1	the address of the first data value
	cbData1	the width of the first data value in bytes
	pData2	the address of the second data value
	cbData2	the width of the second data value in bytes

Returns:

negative if the first data value is less than the second; positive if greater; zero if equal

Implements StoredTypeDescriptor.

Definition at line 169 of file StandardTypeDescriptor.cpp.

    {
        assert(cbData1 == cbData2);
        // REVIEW jvs:  should be using strncmp here and below?
        return memcmp(pData1,pData2,cbData1);
    }

---

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

• /home/pub/open/dev/fennel/tuple/StandardTypeDescriptor.cpp

---