python.trfArgClasses.argBool Class Reference

Boolean type argument. More...

Inheritance diagram for python.trfArgClasses.argBool:

Collaboration diagram for python.trfArgClasses.argBool:

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

(

self

)

Reimplemented from python.trfArgClasses.argument.

Definition at line 343 of file trfArgClasses.py.

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

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.

    def value(self):
        return self._value
 

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

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 331 of file trfArgClasses.py.

    def value(self, value):
        # Default value matches the python bool() constructor
        if value is None:
            self._value = False
        else:
            if isinstance(value, bool):
                self._value = value
            else:
                self._value = strToBool(value)
 

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:

• trfArgClasses.py