ATLAS Offline Software
Loading...
Searching...
No Matches
python.trfArgClasses.argBool Class Reference

Boolean type argument. More...

Inheritance diagram for python.trfArgClasses.argBool:
Collaboration diagram for python.trfArgClasses.argBool:

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

 value (self)
 Argument value getter.
 value (self, value)
 Value setter function.
 prodsysDescription (self)
 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

 _runarg = runarg
 _name = name
 _value = value

Detailed Description

Boolean type argument.

Definition at line 317 of file trfArgClasses.py.

Member Typedef Documentation

◆ result

Definition at line 90 of file EDM_MasterSearch.h.

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.

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

◆ __gt__()

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

Definition at line 170 of file trfArgClasses.py.

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

◆ __lt__()

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

Definition at line 167 of file trfArgClasses.py.

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

◆ __nq__()

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

Definition at line 164 of file trfArgClasses.py.

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

◆ __repr__()

python.trfArgClasses.argument.__repr__ ( self)
inherited

Repr conversion of our value.

Definition at line 157 of file trfArgClasses.py.

157 def __repr__(self):
158 return repr(self.value)
159

◆ __str__()

python.trfArgClasses.argument.__str__ ( self)
inherited

String conversion of our value.

Definition at line 153 of file trfArgClasses.py.

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

◆ isRunarg()

python.trfArgClasses.argument.isRunarg ( self)
inherited

Return runarg status.

Definition at line 134 of file trfArgClasses.py.

134 def isRunarg(self):
135 return self._runarg
136

◆ 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.

139 def name(self):
140 return self._name
141

◆ 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.

144 def name(self, value):
145 self._name = value
146

◆ prodsysDescription()

python.trfArgClasses.argBool.prodsysDescription ( self)

Reimplemented from python.trfArgClasses.argument.

Definition at line 343 of file trfArgClasses.py.

343 def prodsysDescription(self):
344 desc = {'type' : 'bool'}
345 return desc
346

◆ value() [1/2]

python.trfArgClasses.argBool.value ( self)

Argument value getter.

Returns
Current value

Reimplemented from python.trfArgClasses.argument.

Definition at line 322 of file trfArgClasses.py.

322 def value(self):
323 return self._value
324

◆ value() [2/2]

python.trfArgClasses.argBool.value ( self,
value )

Value setter function.

The argument can be a bool or a string with value true or false (case independent).

Parameters
valueValue to set.
Exceptions
trfExceptions.TransformArgExceptionException thrown if the float conversion fails.
trfExceptions.TransformArgExceptionException thrown if value is outside of the given range.

Reimplemented from python.trfArgClasses.argument.

Definition at line 331 of file trfArgClasses.py.

331 def value(self, value):
332 # Default value matches the python bool() constructor
333 if value is None:
334 self._value = False
335 else:
336 if isinstance(value, bool):
337 self._value = value
338 else:
339 self._value = strToBool(value)
340

Member Data Documentation

◆ _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: