Project

General

Profile

Files » config_reader.py

config_reader.py / commented - Wonil KIM, 10/23/2024 07:32 PM

 
1
#!/usr/bin/env python
2
# -*- coding: utf-8 -*-
3
# ˅
4

    
5

    
6
from keyboard_input import KeyboardInput
7

    
8

    
9
##
10
# @brief This class reads config information from config file
11
# 
12
class ConfigReader(object):
13
    # ˅
14
    
15
    # ˄
16

    
17
    ##
18
    # @brief Initializer for Python function
19
    def __init__(self):
20

    
21
        self.__keyboardInput = None
22

    
23
        # ˅
24
        pass
25
        # ˄
26

    
27
    ##
28
    # @brief This function will get the length between projector and the screen
29
    # @param file path of config.ini
30
    # @return Length between projector and screen
31
    def getProjectionLength(self):
32
        # ˅
33
        pass
34
        # ˄
35
    
36
    ##
37
    # @brief This function will get the height of the projected window
38
    # @param file path of config.ini
39
    # @return height of the window
40
    def getProjectorHeight(self):
41
        # ˅
42
        pass
43
        # ˄
44

    
45
    ##
46
    # @brief This function will get the width of the projected window
47
    # @param file path of config.ini
48
    # @return width of the window
49
    def getProjectionWidth(self):
50
        # ˅
51
        pass
52
        # ˄
53
    
54
    ##
55
    # @brief This function will get the length between projector and the screen
56
    # @param file path of config.ini
57
    # @return Length between projector and screen
58
    #
59
    # @todo
60
    # This function should be eliminated.
61
    # Doing exactly same thing with getProjectionLength().
62
    def getProjectionDistance(self):
63
        # ˅
64
        pass
65
        # ˄
66
    
67
    ##
68
    # @brief This function will get the name of the image
69
    # @param file path of config.ini
70
    # @return the name of the image file
71
    def getImageName(self):
72
        # ˅
73
        pass
74
        # ˄
75
    
76
    ##
77
    # @brief This function will get side of the image
78
    # @param file path of config.ini
79
    # @return the side of the image
80
    def getSide(self):
81
        # ˅
82
        pass
83
        # ˄
84
    
85
    ##
86
    # @brief This function will get the height of the image
87
    # @param file path of config.ini
88
    # @return height of the image
89
    def getImgHeight(self):
90
        # ˅
91
        pass
92
        # ˄
93
    
94
    ##
95
    # @brief This function will get the width of the image
96
    # @param file path of config.ini
97
    # @return width of the image
98
    def getImgWidth(self):
99
        # ˅
100
        pass
101
        # ˄
102
    
103
    ##
104
    # @brief This function will calculate the range that should be overlapped
105
    # @param file path of config.ini
106
    # @return the range that should be overlapped
107
    def getOverlap() : int(self):
108
        # ˅
109
        pass
110
        # ˄
111

    
112
    # ˅
113
    
114
    # ˄
115

    
116

    
117
# ˅
118

    
119
# ˄
(5-5/49)