ignite::binary::BinaryEnumEntry Class Reference

Binary enum entry. More...

#include <binary_enum_entry.h>

Public Member Functions
	BinaryEnumEntry ()
	Default constructor.
	BinaryEnumEntry (int32_t typeId, int32_t ordinal)
	Constructor. More...
int32_t	GetTypeId () const
	Get type ID. More...
int32_t	GetOrdinal () const
	Get ordinal of the enum value. More...
bool	IsNull () const
	Check whether value was acquired by reading a NULL value. More...

Detailed Description

Binary enum entry.

Represents a single entry of enum in a binary form.

Constructor & Destructor Documentation

BinaryEnumEntry()

ignite::binary::BinaryEnumEntry::BinaryEnumEntry ( int32_t  typeId, int32_t  ordinal  )

inline

Constructor.

Parameters

typeId	Type ID of the enum.
ordinal	Ordinal of the enum value.

Member Function Documentation

GetOrdinal()

int32_t ignite::binary::BinaryEnumEntry::GetOrdinal ( ) const

inline

Get ordinal of the enum value.

Returns

Ordinal.

GetTypeId()

int32_t ignite::binary::BinaryEnumEntry::GetTypeId ( ) const

inline

Get type ID.

Type ID can never equal zero. If the Type ID equals zero, the instance is not valid, and could only be acquired by manual construction or by reading NULL value.

Returns

Type ID.

IsNull()

bool ignite::binary::BinaryEnumEntry::IsNull ( ) const

inline

Check whether value was acquired by reading a NULL value.

Returns

true if acquired by reading a NULL value.

---

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

• binary_enum_entry.h