1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
/*
* $Revision: 3505 $
*
* last checkin:
* $Author: beyer $
* $Date: 2013-05-16 14:49:47 +0200 (Thu, 16 May 2013) $
***************************************************************/
/** \file
* \brief Declaration of an interface for hypergraph layout
* algorithms. Any hypergraph layout must follow this prescription.
*
* \author Ondrej Moris
*
* \par License:
* This file is part of the Open Graph Drawing Framework (OGDF).
*
* \par
* Copyright (C)<br>
* See README.txt in the root directory of the OGDF installation for details.
*
* \par
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* Version 2 or 3 as published by the Free Software Foundation;
* see the file LICENSE.txt included in the packaging of this file
* for details.
*
* \par
* 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.
*
* \par
* 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* \see http://www.gnu.org/copyleft/gpl.html
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_HYPERGRAPH_LAYOUT_MODULE_H
#define OGDF_HYPERGRAPH_LAYOUT_MODULE_H
#include <ogdf/hypergraph/HypergraphAttributes.h>
namespace ogdf {
/**
* \brief Interface of hypergraph layout algorithms.
*
*/
class OGDF_EXPORT HypergraphLayoutModule
{
public:
//! Initializes a layout module.
HypergraphLayoutModule()
{
}
virtual ~HypergraphLayoutModule()
{
}
/**
* \brief Computes a layout of hypergraph given by \a HA.
*
* This method is the actual algorithm call and must be implemented by
* derived classes.
* @param HA is the input hypergraph attributes class.
*/
virtual void call(HypergraphAttributes &HA) = 0;
/**
* \brief Computes a layout of a hypergraph given by \a HA.
*
* @param HA is the input hypergraph attributes class.
*/
void operator()(HypergraphAttributes &HA)
{
call(HA);
}
OGDF_MALLOC_NEW_DELETE;
};
} // end namespace ogdf
#endif
|