python.trfArgClasses.argFloat Class Reference

Float type argument. More...

Inheritance diagram for python.trfArgClasses.argFloat:

Collaboration diagram for python.trfArgClasses.argFloat:

Public Member Functions
def	__init__ (self, value=None, min=None, max=None, runarg=True, name=None)
	Float argument constructor. More...
def	value (self)
	Argument value getter. More...
def	prodsysDescription (self)
def	value (self, value=None)
	Setter function. More...
def	isRunarg (self)
	Return runarg status. More...
def	name (self)
	Name getter. More...
def	name (self, value)
	Name setter. More...
def	__str__ (self)
	String conversion of our value. More...
def	__repr__ (self)
	Repr conversion of our value. More...
def	__eq__ (self, other)
	Comparison is based on value attribute. More...
def	__nq__ (self, other)
def	__lt__ (self, other)
def	__gt__ (self, other)

Public Attributes
	value

Private Attributes
	_min
	_max
	_value
	_runarg
	_name

Detailed Description

Float type argument.

Definition at line 261 of file trfArgClasses.py.

Constructor & Destructor Documentation

__init__()

def python.trfArgClasses.argFloat.__init__	(		self,
			value = None,
			min = None,
			max = None,
			runarg = True,
			name = None
	)

Float argument constructor.

Parameters

value	Initial value to set, default None,
min	Minimum value for any limits that need to be set
max	Maximum value for any limits that need to be set

Definition at line 267 of file trfArgClasses.py.

    def __init__(self, value=None, min=None, max=None, runarg=True, name=None):
        self._min = min
        self._max = max
        super(argFloat, self).__init__(value = value, runarg = runarg, name=name)
 

Member Function Documentation

__eq__()

def python.trfArgClasses.argument.__eq__ (   self,   other  )

inherited

Comparison is based on value attribute.

Definition at line 161 of file trfArgClasses.py.

    def __eq__(self,other):
        return self.value == other.value
 

__gt__()

def python.trfArgClasses.argument.__gt__ (   self,   other  )

inherited

Definition at line 170 of file trfArgClasses.py.

    def __gt__(self, other):
        return self.value > other.value
 

__lt__()

def python.trfArgClasses.argument.__lt__ (   self,   other  )

inherited

Definition at line 167 of file trfArgClasses.py.

    def __lt__(self, other):
        return self.value < other.value
 

__nq__()

def python.trfArgClasses.argument.__nq__ (   self,   other  )

inherited

Definition at line 164 of file trfArgClasses.py.

    def __nq__(self, other):
        return self.value != other.value
 

__repr__()

def python.trfArgClasses.argument.__repr__ (   self )

inherited

Repr conversion of our value.

Reimplemented in python.trfArgClasses.argList.

Definition at line 157 of file trfArgClasses.py.

    def __repr__(self):
        return repr(self.value)
    

__str__()

def python.trfArgClasses.argument.__str__ (   self )

inherited

String conversion of our value.

Reimplemented in python.trfArgClasses.argFile, python.trfArgClasses.argKeyFloatValueList, python.trfArgClasses.argIntList, python.trfArgClasses.argList, and python.trfArgClasses.argString.

Definition at line 153 of file trfArgClasses.py.

    def __str__(self):
        return '{0}: Value {1} (isRunArg={2})'.format(self.__class__.__name__, self._value, self._runarg)
    

isRunarg()

def python.trfArgClasses.argument.isRunarg (   self )

inherited

Return runarg status.

Definition at line 134 of file trfArgClasses.py.

    def isRunarg(self):
        return self._runarg
    

name() [1/2]

def python.trfArgClasses.argument.name (   self )

inherited

Name getter.

Reimplemented in python.trfArgClasses.argFile.

Definition at line 139 of file trfArgClasses.py.

    def name(self):
        return self._name
    

name() [2/2]

def python.trfArgClasses.argument.name (   self,   value  )

inherited

Name setter.

Reimplemented in python.trfArgClasses.argFile.

Definition at line 144 of file trfArgClasses.py.

    def name(self, value):
        self._name = value
 

prodsysDescription()

def python.trfArgClasses.argFloat.prodsysDescription

(

self

)

Reimplemented from python.trfArgClasses.argument.

Definition at line 279 of file trfArgClasses.py.

    def prodsysDescription(self):
        desc = {'type' : 'float'}
        if self._min:
            desc['min'] = self._min
        if self._max:
            desc['max'] = self._max
        return desc
    

value() [1/2]

def python.trfArgClasses.argFloat.value

(

self

)

Argument value getter.

Returns

Current value

Reimplemented from python.trfArgClasses.argument.

Definition at line 275 of file trfArgClasses.py.

    def value(self):
        return self._value
 

value() [2/2]

def python.trfArgClasses.argFloat.value	(		self,
			value = None
	)

Setter function.

The argument can be anything, if it is not of type float, it will attempt to convert using float().

Parameters

value

Value to set.

Exceptions

trfExceptions.TransformArgException	Exception thrown if the float conversion fails.
trfExceptions.TransformArgException	Exception thrown if value is outside of the given range.

Reimplemented from python.trfArgClasses.argument.

Definition at line 293 of file trfArgClasses.py.

    def value(self, value=None):
        # Default value will be 0.0 or self._min (if defined)
        if value is None:
            if self._min is not None:
                self._value = self._min
            else:
                self._value = 0.0
        else:
            try:
                if isinstance(value, float):
                    self._value = value
                else:
                    self._value = float(value)
            except ValueError:
                raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'),
                                                          'Failed to convert %s to a float' % str(value))
            
            if (self._min is not None and self.value < self._min) or (self._max is not None and self._value > self._max):
                raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_OUT_OF_RANGE'),
                                                          'argFloat value out of range: %g is not between %s and %s' % 
                                                          (self.value, self._min, self._max))
 
 

Member Data Documentation

_max

python.trfArgClasses.argFloat._max

private

Definition at line 269 of file trfArgClasses.py.

_min

python.trfArgClasses.argFloat._min

private

Definition at line 268 of file trfArgClasses.py.

_name

python.trfArgClasses.argument._name

privateinherited

Definition at line 111 of file trfArgClasses.py.

_runarg

python.trfArgClasses.argument._runarg

privateinherited

Definition at line 110 of file trfArgClasses.py.

_value

python.trfArgClasses.argFloat._value

private

Definition at line 297 of file trfArgClasses.py.

value

python.trfArgClasses.argument.value

inherited

Note

We have a default of None here, but all derived classes should definitely have their own value setter and translate this value to something sensible for their underlying value type. N.B. As most argument classes use this default constructor it must call the @value .setter function!

Definition at line 118 of file trfArgClasses.py.

---

The documentation for this class was generated from the following file:

• trfArgClasses.py