observation.py 2.16 KB
Newer Older
Wei Shoulin's avatar
c3  
Wei Shoulin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14

from ..common.delegate import Delegate

class ObservationApi(object):
    """
    Observation Operation Class
    """
    def __init__(self):
        self.pymodule = Delegate().load(sub_module = "facility")
        self.stub = getattr(self.pymodule, "ObservationApi")()
        
    def find(self, **kwargs):
        ''' retrieve exposure records from database

Wei Shoulin's avatar
docs    
Wei Shoulin committed
15
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
16
17
18
19
20
21
            module_id: [str]
            obs_type: [str]
            obs_time : (start, end),
            qc0_status : [int],
            prc_status : [int],
            limit: limits returns the number of records,default 0:no-limit
Wei Shoulin's avatar
docs    
Wei Shoulin committed
22
23
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
24
25
26
27
28
29
        '''
        return self.stub.find(**kwargs)

    def get(self, **kwargs):
        '''  fetch a record from database

Wei Shoulin's avatar
docs    
Wei Shoulin committed
30
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
31
            obs_id = [int] 
Wei Shoulin's avatar
docs    
Wei Shoulin committed
32
33
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
34
35
36
37
38
39
40
        '''
        return self.stub.get(**kwargs)


    def update_proc_status(self, **kwargs):
        ''' update the status of reduction

Wei Shoulin's avatar
docs    
Wei Shoulin committed
41
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
42
43
            obs_id = [int],
            status = [int]
Wei Shoulin's avatar
docs    
Wei Shoulin committed
44
45
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
46
47
48
49
50
51
        '''
        return self.stub.update_proc_status(**kwargs)

    def update_qc0_status(self, **kwargs):
        ''' update the status of QC0
        
Wei Shoulin's avatar
docs    
Wei Shoulin committed
52
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
53
54
            obs_id = [int],
            status = [int]
Wei Shoulin's avatar
docs    
Wei Shoulin committed
55
56
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
57
58
59
60
61
62
        '''        
        return self.stub.update_qc0_status(**kwargs)    

    def write(self, **kwargs):
        ''' insert a observational record into database
 
Wei Shoulin's avatar
docs    
Wei Shoulin committed
63
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
Wei Shoulin committed
64
            obs_id = [int]
Wei Shoulin's avatar
c3  
Wei Shoulin committed
65
66
67
68
69
70
            obs_time = [str]
            exp_time = [float]
            module_id = [str]
            obs_type = [str]
            facility_status_id = [int]
            module_status_id = [int]
Wei Shoulin's avatar
docs    
Wei Shoulin committed
71
72
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
73
74
75
        '''        
        return self.stub.write(**kwargs)