source: flair-dev/trunk/include/FlairCore/LayoutPosition.h @ 13

Last change on this file since 13 was 13, checked in by Bayard Gildas, 5 years ago

formatting script + include reformatted

File size: 1.3 KB
Line 
1// %flair:license{
2// This file is part of the Flair framework distributed under the
3// CECILL-C License, Version 1.0.
4// %flair:license}
5/*!
6 * \file LayoutPosition.h
7 * \brief Class to define a position in a layout on the ground station.
8 * \author Guillaume Sanahuja, Copyright Heudiasyc UMR UTC/CNRS 7253
9 * \date 2014/12/04
10 * \version 4.0
11 */
12
13#ifndef LAYOUTPOSITION_H
14#define LAYOUTPOSITION_H
15
16#include <stdint.h>
17
18namespace flair {
19namespace gui {
20class Layout;
21
22/*! \class LayoutPosition
23*
24* \brief Class to define a position in a layout on the ground station.
25*
26
27*/
28class LayoutPosition {
29public:
30  /*!
31  * \brief Constructor
32  *
33  * Construct a LayoutPosition, in given Layout at given place.
34  *
35  * \param layout layout
36  * \param row row position
37  * \param col col position
38  */
39  LayoutPosition(const Layout *layout, int16_t row, int16_t col);
40
41  /*!
42  * \brief Destructor
43  *
44  */
45  ~LayoutPosition();
46
47  /*!
48  * \brief get Layout
49  *
50  * \return the parent Layout
51  */
52  const Layout *getLayout(void) const;
53
54  /*!
55  * \brief get row
56  *
57  * \return row position
58  */
59  int16_t Row(void) const;
60
61  /*!
62  * \brief get col
63  *
64  * \return col position
65  */
66  int16_t Col(void) const;
67
68private:
69  const Layout *layout;
70  int16_t row, col;
71};
72
73} // end namespace gui
74} // end namespace flair
75
76#endif // LAYOUTPOSITION_H
Note: See TracBrowser for help on using the repository browser.