python.trfArgClasses.argument Class Reference

Basic argument class holding a value which can be get and set. More...

Inheritance diagram for python.trfArgClasses.argument:

Collaboration diagram for python.trfArgClasses.argument:

Public Member Functions
def	__init__ (self, value=None, runarg=True, name=None)
	Initialise argument class. More...
def	value (self)
	Return argument value. More...
def	value (self, value)
	Set argument value. More...
def	isRunarg (self)
	Return runarg status. More...
def	name (self)
	Name getter. More...
def	name (self, value)
	Name setter. More...
def	prodsysDescription (self)
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
	_runarg
	_name
	_value

Detailed Description

Basic argument class holding a value which can be get and set.

Note

Any argument type is supported

Definition at line 102 of file trfArgClasses.py.

Constructor & Destructor Documentation

__init__()

def python.trfArgClasses.argument.__init__	(		self,
			value = None,
			runarg = True,
			name = None
	)

Initialise argument class.

Parameters

value	Initial value to be set
runarg	Boolean specifiying if this is a run time argument (specifically passed to athena by the AthenaExecutor, other executors may do the same).
name	Name for this argument

Definition at line 109 of file trfArgClasses.py.

    def __init__(self, value = None, runarg = True, name = None):
        self._runarg = runarg
        self._name = name
                
        
        self.value = value
 

Member Function Documentation

__eq__()

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

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
	)

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
	)

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
	)

Definition at line 164 of file trfArgClasses.py.

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

__repr__()

def python.trfArgClasses.argument.__repr__

(

self

)

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

)

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

)

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

)

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
	)

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.argument.prodsysDescription

(

self

)

Reimplemented in python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepString, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstep, python.trfArgClasses.argFTKIPFile, python.trfArgClasses.argBZ2File, python.trfArgClasses.argNTUPFile, python.trfArgClasses.argHISTFile, python.trfArgClasses.argPOOLFile, python.trfArgClasses.argBSFile, python.trfArgClasses.argAthenaFile, python.trfArgClasses.argFile, python.trfArgClasses.argKeyFloatValueList, python.trfArgClasses.argIntList, python.trfArgClasses.argList, python.trfArgClasses.argBool, python.trfArgClasses.argFloat, python.trfArgClasses.argInt, and python.trfArgClasses.argString.

Definition at line 148 of file trfArgClasses.py.

    def prodsysDescription(self):
        desc = {'type' : None}
        return desc
        

value() [1/2]

def python.trfArgClasses.argument.value

(

self

)

Return argument value.

Returns

Current value

Reimplemented in python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepString, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstep, python.trfArgClasses.argFile, python.trfArgClasses.argKeyFloatValueList, python.trfArgClasses.argIntList, python.trfArgClasses.argList, python.trfArgClasses.argBool, python.trfArgClasses.argFloat, python.trfArgClasses.argInt, and python.trfArgClasses.argString.

Definition at line 123 of file trfArgClasses.py.

    def value(self):
        return self._value
 

value() [2/2]

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

Set argument value.

Note

No conversion or coercion done

Reimplemented in python.trfArgClasses.argFloat, python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepString, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstep, python.trfArgClasses.argFile, python.trfArgClasses.argKeyFloatValueList, python.trfArgClasses.argIntList, python.trfArgClasses.argList, python.trfArgClasses.argBool, python.trfArgClasses.argInt, and python.trfArgClasses.argString.

Definition at line 129 of file trfArgClasses.py.

    def value(self, value):
        self._value = value
    

Member Data Documentation

_name

python.trfArgClasses.argument._name

private

Definition at line 111 of file trfArgClasses.py.

_runarg

python.trfArgClasses.argument._runarg

private

Definition at line 110 of file trfArgClasses.py.

_value

python.trfArgClasses.argument._value

private

Definition at line 130 of file trfArgClasses.py.

value

python.trfArgClasses.argument.value

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