office-gobmx/autodoc/inc/ary/entity.hxx
2012-06-19 18:00:37 +01:00

75 lines
1.7 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef ARY_ENTITY_HXX
#define ARY_ENTITY_HXX
// BASE CLASSES
#include <ary/object.hxx>
namespace ary
{
/** Interface for every class, whose objects are searchable within the
Autodoc Repository by an id.
@todo
Possibly make ->Set_Id() less public accessible.
*/
class Entity : public Object
{
public:
virtual ~Entity() {}
Rid Id() const;
/// @attention Must be used only by ->ary::stg::Storage<>
void Set_Id(
Rid i_nId );
protected:
Entity() : nId(0) {}
private:
// DATA
Rid nId;
};
inline Rid
Entity::Id() const
{
return nId;
}
inline void
Entity::Set_Id(Rid i_nId)
{
nId = i_nId;
}
} // namespace ary
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */