Float type argument. More...

Inheritance diagram for python.trfArgClasses.argFloat:

Collaboration diagram for python.trfArgClasses.argFloat:

Public Types
typedef HLT::TypeInformation::for_each_type_c< typenameEDMLIST::map, my_functor, my_result<>, my_arg< HLT::TypeInformation::get_cont, CONTAINER > >::type	result

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

Protected Attributes
	_min = min
	_max = max
	_runarg = runarg
	_name = name
	_value = value

Detailed Description

Float type argument.

Definition at line 261 of file trfArgClasses.py.

Member Typedef Documentation

◆ result

typedef HLT::TypeInformation::for_each_type_c<typenameEDMLIST::map,my_functor,my_result<>,my_arg<HLT::TypeInformation::get_cont,CONTAINER>>::type master_search< typenameEDMLIST::map, HLT::TypeInformation::get_cont, CONTAINER >::result

inherited

Definition at line 90 of file EDM_MasterSearch.h.

Constructor & Destructor Documentation

◆ init()

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()

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()

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()

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()

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()

python.trfArgClasses.argument.__repr__ ( self )

inherited

Repr conversion of our value.

Definition at line 157 of file trfArgClasses.py.

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

◆ str()

python.trfArgClasses.argument.__str__ ( self )

inherited

String conversion of our value.

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()

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]

python.trfArgClasses.argument.name ( self )

inherited

Name getter.

Reimplemented in python.trfArgClasses.argFile, and python.trfArgClasses.argFile.

Definition at line 139 of file trfArgClasses.py.

    def name(self):
        return self._name
    

◆ name() [2/2]

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

inherited

Name setter.

Reimplemented in python.trfArgClasses.argFile, and python.trfArgClasses.argFile.

Definition at line 144 of file trfArgClasses.py.

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

◆ prodsysDescription()

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]

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]

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 = max

protected

Definition at line 269 of file trfArgClasses.py.

◆ _min

python.trfArgClasses.argFloat._min = min

protected

Definition at line 268 of file trfArgClasses.py.

◆ _name

python.trfArgClasses.argument._name = name

protectedinherited

Definition at line 111 of file trfArgClasses.py.

◆ _runarg

python.trfArgClasses.argument._runarg = runarg

protectedinherited

Definition at line 110 of file trfArgClasses.py.

◆ _value

python.trfArgClasses.argument._value = value

protectedinherited

Definition at line 130 of file trfArgClasses.py.

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

trfArgClasses.py

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ result

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __gt__()

◆ __lt__()

◆ __nq__()

◆ __repr__()

◆ __str__()

◆ isRunarg()

◆ name() [1/2]

◆ name() [2/2]

◆ prodsysDescription()

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ _max

◆ _min

◆ _name

◆ _runarg

◆ _value

◆ init()

◆ eq()

◆ gt()

◆ lt()

◆ nq()

◆ repr()

◆ str()