Home       Trees       Index       Help   

CedarBackup2

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:
Method Summary
  __init__(self, sourceDir, mediaType, deviceType, devicePath, deviceScsiId, driveSpeed, checkData, warnMidnite, noEject)
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.
  _getCheckData(self)
Property target used to get the check data flag.
  _getDevicePath(self)
Property target used to get the device path.
  _getDeviceScsiId(self)
Property target used to get the SCSI id.
  _getDeviceType(self)
Property target used to get the device type.
  _getDriveSpeed(self)
Property target used to get the drive speed.
  _getMediaType(self)
Property target used to get the media type.
  _getNoEject(self)
Property target used to get the no-eject flag.
  _getSourceDir(self)
Property target used to get the source directory.
  _getWarnMidnite(self)
Property target used to get the midnite warning flag.
  _setCheckData(self, value)
Property target used to set the check data flag.
  _setDevicePath(self, value)
Property target used to set the device path.
  _setDeviceScsiId(self, value)
Property target used to set the SCSI id The SCSI id must be valid per validateScsiId.
  _setDeviceType(self, value)
Property target used to set the device type.
  _setDriveSpeed(self, value)
Property target used to set the drive speed.
  _setMediaType(self, value)
Property target used to set the media type.
  _setNoEject(self, value)
Property target used to set the no-eject flag.
  _setSourceDir(self, value)
Property target used to set the source directory.
  _setWarnMidnite(self, value)
Property target used to set the midnite warning flag.
    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.
  warnMidnite: Whether to generate warnings for crossing midnite.
  noEject: Indicates that the writer device should not be ejected.

Method Details

__init__(self, sourceDir=None, mediaType=None, deviceType=None, devicePath=None, deviceScsiId=None, driveSpeed=None, checkData=False, warnMidnite=False, noEject=False)
(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.
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.

_getCheckData(self)

Property target used to get the check data flag.

_getDevicePath(self)

Property target used to get the device path.

_getDeviceScsiId(self)

Property target used to get the SCSI id.

_getDeviceType(self)

Property target used to get the device type.

_getDriveSpeed(self)

Property target used to get the drive speed.

_getMediaType(self)

Property target used to get the media type.

_getNoEject(self)

Property target used to get the no-eject flag.

_getSourceDir(self)

Property target used to get the source directory.

_getWarnMidnite(self)

Property target used to get the midnite warning flag.

_setCheckData(self, value)

Property target used to set the check data flag. No validations, but we normalize the value to True or False.

_setDevicePath(self, value)

Property target used to set the device path. The value must be an absolute path if it is not None. It does not have to exist on disk at the time of assignment.
Raises:
ValueError - If the value is not an absolute path.
ValueError - If the value cannot be encoded properly.

_setDeviceScsiId(self, value)

Property target used to set the SCSI id The SCSI id must be valid per validateScsiId.
Raises:
ValueError - If the value is not valid.

_setDeviceType(self, value)

Property target used to set the device type. The value must be one of VALID_DEVICE_TYPES.
Raises:
ValueError - If the value is not valid.

_setDriveSpeed(self, value)

Property target used to set the drive speed. The drive speed must be valid per validateDriveSpeed.
Raises:
ValueError - If the value is not valid.

_setMediaType(self, value)

Property target used to set the media type. The value must be one of VALID_MEDIA_TYPES.
Raises:
ValueError - If the value is not valid.

_setNoEject(self, value)

Property target used to set the no-eject flag. No validations, but we normalize the value to True or False.

_setSourceDir(self, value)

Property target used to set the source directory. The value must be an absolute path if it is not None. It does not have to exist on disk at the time of assignment.
Raises:
ValueError - If the value is not an absolute path.
ValueError - If the value cannot be encoded properly.

_setWarnMidnite(self, value)

Property target used to set the midnite warning flag. No validations, but we normalize the value to True or False.

Property Details

sourceDir

Directory whose contents should be written to media.
Get Method:
_getSourceDir(self)
Set Method:
_setSourceDir(self, value)

mediaType

Type of the media (see notes above).
Get Method:
_getMediaType(self)
Set Method:
_setMediaType(self, value)

deviceType

Type of the device (optional, see notes above).
Get Method:
_getDeviceType(self)
Set Method:
_setDeviceType(self, value)

devicePath

Filesystem device name for writer device.
Get Method:
_getDevicePath(self)
Set Method:
_setDevicePath(self, value)

deviceScsiId

SCSI id for writer device (optional, see notes above).
Get Method:
_getDeviceScsiId(self)
Set Method:
_setDeviceScsiId(self, value)

driveSpeed

Speed of the drive.
Get Method:
_getDriveSpeed(self)
Set Method:
_setDriveSpeed(self, value)

checkData

Whether resulting image should be validated.
Get Method:
_getCheckData(self)
Set Method:
_setCheckData(self, value)

warnMidnite

Whether to generate warnings for crossing midnite.
Get Method:
_getWarnMidnite(self)
Set Method:
_setWarnMidnite(self, value)

noEject

Indicates that the writer device should not be ejected.
Get Method:
_getNoEject(self)
Set Method:
_setNoEject(self, value)

   Home       Trees       Index       Help   

CedarBackup2

Generated by Epydoc 2.1 on Mon Feb 26 20:52:30 2007 http://epydoc.sf.net