Scippy

UG

Ubiquity Generator framework

bbParaInstance.h
Go to the documentation of this file.
1/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2/* */
3/* This file is part of the program and software framework */
4/* UG --- Ubquity Generator Framework */
5/* */
6/* Copyright Written by Yuji Shinano <shinano@zib.de>, */
7/* Copyright (C) 2021-2024 by Zuse Institute Berlin, */
8/* licensed under LGPL version 3 or later. */
9/* Commercial licenses are available through <licenses@zib.de> */
10/* */
11/* This code is free software; you can redistribute it and/or */
12/* modify it under the terms of the GNU Lesser General Public License */
13/* as published by the Free Software Foundation; either version 3 */
14/* of the License, or (at your option) any later version. */
15/* */
16/* This program is distributed in the hope that it will be useful, */
17/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
19/* GNU Lesser General Public License for more details. */
20/* */
21/* You should have received a copy of the GNU Lesser General Public License */
22/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
23/* */
24/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
25
26/**@file bbParaInstance.h
27 * @brief Base class for instance data.
28 * @author Yuji Shinano
29 *
30 *
31 *
32 */
33
34/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
35
36
37#ifndef __BB_PARA_INSTANCE_H__
38#define __BB_PARA_INSTANCE_H__
39
40#include "ug/paraInstance.h"
41
42namespace UG
43{
44
45///
46/// class for instance data
47///
48/// This class should NOT have any data member.
49///
51{
52
53 ///
54 /// DO NOT HAVE DATA MEMBER!!
55 ///
56
57public:
58
59 ///
60 /// default constructor
61 ///
63 )
64 {
65 }
66
67 ///
68 /// destructor
69 ///
71 )
72 {
73 }
74
75 ///
76 /// get variable index range
77 /// TODO: this function should be in inherited class
78 /// @return the range of indexes
79 ///
80 virtual int getVarIndexRange(
81 ) = 0;
82
83};
84
85}
86
87#endif // __BB_PARA_INSTANCE_H__
class for instance data
virtual ~BbParaInstance()
destructor
virtual int getVarIndexRange()=0
get variable index range TODO: this function should be in inherited class
BbParaInstance()
DO NOT HAVE DATA MEMBER!!
class for instance data
Definition: paraInstance.h:51
Base class for instance data.