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

Type StoreConfig

object --+
         |
        StoreConfig


Class representing a Cedar Backup store configuration.

As with all of the other classes that represent configuration sections, all of these values are optional. It is up to some higher-level construct to decide whether everything they need is filled in. Some validation is done on non-None assignments through the use of the Python property() construct.

The following restrictions exist on data in this class: Note that although the blanking factor must be a positive floating point number, it is stored as a string. This is done so that we can losslessly go back and forth between XML and object representations of configuration.
Method Summary
  __init__(self, sourceDir, mediaType, deviceType, devicePath, deviceScsiId, driveSpeed, checkData, warnMidnite, noEject, checkMedia, blankBehavior)
Constructor for the StoreConfig class.
  __repr__(self)
Official string representation for class instance.
  __str__(self)
Informal string representation for class instance.
  __cmp__(self, other)
Definition of equals operator for this class.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  sourceDir: Directory whose contents should be written to media.
  mediaType: Type of the media (see notes above).
  deviceType: Type of the device (optional, see notes above).
  devicePath: Filesystem device name for writer device.
  deviceScsiId: SCSI id for writer device (optional, see notes above).
  driveSpeed: Speed of the drive.
  checkData: Whether resulting image should be validated.
  checkMedia: Whether media should be checked before being written to.
  warnMidnite: Whether to generate warnings for crossing midnite.
  noEject: Indicates that the writer device should not be ejected.
  blankBehavior: Controls optimized blanking behavior.

Method Details

__init__(self, sourceDir=None, mediaType=None, deviceType=None, devicePath=None, deviceScsiId=None, driveSpeed=None, checkData=False, warnMidnite=False, noEject=False, checkMedia=False, blankBehavior=None)
(Constructor)

Constructor for the StoreConfig class.
Parameters:
sourceDir - Directory whose contents should be written to media.
mediaType - Type of the media (see notes above).
deviceType - Type of the device (optional, see notes above).
devicePath - Filesystem device name for writer device, i.e. /dev/cdrw.
deviceScsiId - SCSI id for writer device, i.e. [<method>:]scsibus,target,lun.
driveSpeed - Speed of the drive, i.e. 2 for 2x drive, etc.
checkData - Whether resulting image should be validated.
warnMidnite - Whether to generate warnings for crossing midnite.
noEject - Indicates that the writer device should not be ejected.
checkMedia - Whether media should be checked before being written to.
blankBehavior - Controls optimized blanking behavior.
Raises:
ValueError - If one of the values is invalid.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

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.

Property Details

sourceDir

Directory whose contents should be written to media.

mediaType

Type of the media (see notes above).

deviceType

Type of the device (optional, see notes above).

devicePath

Filesystem device name for writer device.

deviceScsiId

SCSI id for writer device (optional, see notes above).

driveSpeed

Speed of the drive.

checkData

Whether resulting image should be validated.

checkMedia

Whether media should be checked before being written to.

warnMidnite

Whether to generate warnings for crossing midnite.

noEject

Indicates that the writer device should not be ejected.

blankBehavior

Controls optimized blanking behavior.

Generated by Epydoc 2.1 on Thu Mar 29 20:58:28 2007 http://epydoc.sf.net