summaryrefslogtreecommitdiff
path: root/src/pyglue/DocStrings/AllocationTransform.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/pyglue/DocStrings/AllocationTransform.py')
-rw-r--r--src/pyglue/DocStrings/AllocationTransform.py54
1 files changed, 54 insertions, 0 deletions
diff --git a/src/pyglue/DocStrings/AllocationTransform.py b/src/pyglue/DocStrings/AllocationTransform.py
new file mode 100644
index 0000000..26bdaa2
--- /dev/null
+++ b/src/pyglue/DocStrings/AllocationTransform.py
@@ -0,0 +1,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