/*

Copyright (c) 2002-2005, Yauheni Akhotnikau
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

*/

/*!
	\file oess_1/defs/h/ent_id.hpp
	\brief Класс ent_id_t.
*/

#if !defined( _OESS_1__DEFS__ENT_ID_HPP_ )
#define _OESS_1__DEFS__ENT_ID_HPP_

#include <oess_1/defs/h/declspec.hpp>

#include <iostream>

#include <oess_1/defs/h/types.hpp>

namespace oess_1 {

//
// ent_id_t
//

//!	Идентификатор сущности в БД.
/*!
	Для идентификатора сущности существует понятие
	NULL-значения. Т.е. значения, которое указывает,
	что идентификатор ни на что не ссылается
	(заведомо невозможное значение). Но NULL-значение
	для идентификатора никак не связано со стандартным
	макроопределением \c NULL. В частности, нельзя
	выполнять следующие действия:
	\code
	oess_1::ent_id_t e = NULL;
	if( e == NULL ) ...
	\endcode

	\attention
	Поля структуры сделаны открытыми, чтобы облечить
	доступ к ним из внутренностей ObjESSty.
	Но состав полей ent_id_t может измениться и программы,
	которые их используют, окажутся неработоспособными.
*/
struct OESS_1__DEFS__TYPE	ent_id_t {
	oess_1::uint_t	m_slice_id;
	oess_1::uint_t	m_ent_id;

	//! По умолчанию присваивается значение,
	//! аналогичное NULL.
	ent_id_t();
	//! Полное определение объекта.
	ent_id_t(
		oess_1::uint_t slice_id,
		oess_1::uint_t ent_id );
	//! Конструктор копирования.
	ent_id_t(
		const ent_id_t & o );
	~ent_id_t();

	//! Оператор копирования.
	ent_id_t &
	operator=(
		const ent_id_t & o );

	//! Возвращает true, если не NULL.
	operator bool() const;

	//! Возвращает true, если NULL.
	bool
	operator!() const;

	//! Проверка на равенство.
	bool
	operator==( const ent_id_t & o ) const;

	//! Проверка на неравенство.
	bool
	operator!=( const ent_id_t & o ) const;

	//! Проверка на "строго меньше".
	/*!
		Введен для того, чтобы объекты ent_id_t
		можно было хранить в стандарных
		контейнерах STL.
	*/
	bool
	operator<( const ent_id_t & o ) const;

	//! Присвоить значение, аналогичное NULL.
	void
	make_null();
};

// Методы ввода/вывода объектов ent_id_t в std::stream.
// Если при вводе обнаруживается не правильный формат,
// то объекту присваивается значение, аналогичное NULL.

OESS_1__DEFS__FUNC( std::ostream & )
ent_id_to_std_ostream( std::ostream & s, const ent_id_t & o );

OESS_1__DEFS__FUNC( std::istream & )
ent_id_from_std_ostream( std::istream & s, ent_id_t & o );

//! Вывод объекта ent_id_t в поток вывода.
inline std::ostream &
operator<<( std::ostream & s, const ent_id_t & o )
{
	return ent_id_to_std_ostream( s, o );
}

//! Чтение объекта ent_id_t из потока ввода.
/*!
	Если при вводе обнаруживается не правильный формат,
	то объекту присваивается значение, аналогичное NULL.
*/
inline std::istream &
operator>>( std::istream & s, ent_id_t & o )
{
	return ent_id_from_std_ostream( s, o );
}

} /* namespace oess_1 */

#endif

