CedarBackup2.config.BlankBehavior

Package CedarBackup2 :: Module config :: Class BlankBehavior |
[hide private]
[frames] | no frames]

# Class BlankBehavior

source code

    object --+
             |
            BlankBehavior

Class representing optimized store-action media blanking behavior.

The following restrictions exist on data in this class:

- The blanking mode must be a one of the values in VALID_BLANK_MODES
- The blanking factor must be a positive floating point number

Instance Methods | [hide private]
__init__(self, blankMode=None, blankFactor=None) Constructor for the `BlankBehavior` class. | source code
__repr__(self) Official string representation for class instance. | source code
__str__(self) Informal string representation for class instance. | source code
__cmp__(self, other) Definition of equals operator for this class. | source code
_setBlankMode(self, value) Property target used to set the blanking mode. | source code
_getBlankMode(self) Property target used to get the blanking mode. | source code
_setBlankFactor(self, value) Property target used to set the blanking factor. | source code
_getBlankFactor(self) Property target used to get the blanking factor. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| blankMode Blanking mode
| blankFactor Blanking factor
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, blankMode=None, blankFactor=None) (Constructor) | source code
Constructor for the `BlankBehavior` class. Parameters: `blankMode` - Blanking mode `blankFactor` - Blanking factor Raises: `ValueError` - If one of the values is invalid. Overrides: object.__init__

### __repr__(self) (Representation operator) | source code
Official string representation for class instance. Overrides: object.__repr__

### __str__(self) (Informal representation operator) | source code
Informal string representation for class instance. Overrides: object.__str__

### __cmp__(self, other) (Comparison operator) | source code
Definition of equals operator for this class. Parameters: `other` - Other object to compare to. Returns: -1/0/1 depending on whether self is `<`, `=` or `>` other.

### _setBlankMode(self, value) | source code
Property target used to set the blanking mode. The value must be one of VALID_BLANK_MODES. Raises: `ValueError` - If the value is not valid.

### _setBlankFactor(self, value) | source code
Property target used to set the blanking factor. The value must be a non-empty string if it is not `None`. Raises: `ValueError` - If the value is an empty string. `ValueError` - If the value is not a valid floating point number `ValueError` - If the value is less than zero

Property Details | [hide private]

### blankMode Blanking mode Get Method: _getBlankMode(self) - Property target used to get the blanking mode. Set Method: _setBlankMode(self, value) - Property target used to set the blanking mode.

### blankFactor Blanking factor Get Method: _getBlankFactor(self) - Property target used to get the blanking factor. Set Method: _setBlankFactor(self, value) - Property target used to set the blanking factor.