summaryrefslogtreecommitdiff
path: root/src/pyglue/DocStrings/AllocationTransform.py
blob: 26bdaa2e3fedb1930cfb395f4abf14f586dc9fb2 (plain)
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
class AllocationTransform:
    """
    Respans the 'expanded' range into the specified (often compressed) range.
    
    Performs both squeeze (offset) and log transforms.
    """
    def __init__(self):
        pass
    
    def getAllocation(self):
        """
        getAllocation()
        
        Returns the allocation specified in the transform. Allocation is an
        enum, defined in Constants.
        
        :return: Allocation
        :rtype: string
        """
        pass
        
    def setAllocation(self, hwalloc):
        """
        setAllocation(hwalloc)
        
        Sets the allocation of the transform.
        
        :param hwalloc: Allocation
        :type hwalloc: object
        """
        pass
        
    def getVars(self):
        """
        getVars()
        
        Returns the allocation values specified in the transform.
        
        :return: allocation values
        :rtype: list of floats
        """
        pass
        
    def setVars(self, vars):
        """
        setVars(pyvars)
        
        Sets the allocation in the transform.
        
        :param pyvars: list of floats
        :type pyvars: object
        """
        pass