lumiera_documentation/src/proc/mobject/session/allocation.hpp
Ichthyostega 48e9b7594a Doxygen: identify all files lacking a @file comment
reason is, only files with a @file comment will be processed
with further documentation commands. For this reason, our Doxygen
documentation is lacking a lot of entries.

HOWTO:
find src -type f \( -name '*.cpp' -or -name '*.hpp' \) -not -exec egrep -q '\*.+@file' {} \; -print -exec sed -i -r -e'\_\*/_,$ { 1,+0 a\
\
\
/** @file §§§\
 ** TODO §§§\
 */
}' {} \;
2016-11-03 18:20:10 +01:00

66 lines
1.7 KiB
C++

/*
ALLOCATION.hpp - objective to place a MObject in a specific way
Copyright (C) Lumiera.org
2008, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file §§§
** TODO §§§
*/
#ifndef PROC_MOBJECT_SESSION_ALLOCATION_H
#define PROC_MOBJECT_SESSION_ALLOCATION_H
#include "proc/mobject/session/locatingpin.hpp"
#include <string>
using std::string;
namespace proc {
namespace mobject {
namespace session {
/**
* Interface (abstract): any objective, constraint or wish
* of placing a MObject in a specific way.
*/
class Allocation : public LocatingPin
{
protected:
/** human readable representation of the condition
* characterising this allocation, e.g. "t >= 10"
*/
string repr;
virtual void intersect (LocatingSolution&) const;
public:
const string& getRepr () const { return repr; }
virtual Allocation* clone () const = 0;
};
}}} // namespace proc::mobject::session
#endif