Home       Trees       Indices       Help   
Package bar :: Module atlas_indexer :: Class barIndexerPropertyElement
[hide private]
[frames] | no frames]

Class barIndexerPropertyElement

Class of objects representing 'property' elements of CAF dataset index file.

Nested Classes [hide private]

Inherited from base.barObject (private): _clsBoundingBox, _clsBregmaMetadataElement, _clsCommentLabel, _clsGenericStructure, _clsMetadataElement, _clsPath, _clsRegularLabel, _clsSpotLabel, _clsStructureLabel, _clsTransfMatrixMetadataElement

Instance Methods [hide private]
 
__init__(self, type, value)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
__getType(self)
Returns: value of the 'type' attribute of represented XML element
 
__setType(self, newType)
Sets value of the 'type' attribute to newType.
 
__getValue(self)
Returns: value of the 'value' attribute of represented XML element
 
__setValue(self, newValue)
Sets value of the 'value' attribute to newValue.

Inherited from barIndexerElement: getXMLelement

Inherited from base.barObject: __str__, getElementById, writeXMLtoFile

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]
cls
fromXML(cls, sourceXMLElement, indexer=None)
Creates object from its (valid) xml representation.
Static Methods [hide private]

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
str _elementName = 'property'
name of the XML element represented by class instances
[str, ...] _elementAttributes = ['type', 'value']
names of attributes of the XML element represented by class instances
Instance Variables [hide private]
str _type
property name
str _value
property value
Properties [hide private]
str type
The 'type' attribute of represented 'property' element.
  name
An alias for type property.
str value
The 'value' attribute of represented 'property' element.

Inherited from object: __class__

Method Details [hide private]

__init__(self, type, value)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • type (str) - value of the 'type' attribute of represented XML element
  • value (str) - value of the 'value' attribute of represented XML element
Overrides: object.__init__

__getType(self)

 
Returns:
value of the 'type' attribute of represented XML element

__setType(self, newType)

 

Sets value of the 'type' attribute to newType.

Parameters:
  • newType (str) - new value of the 'type' attribute of represented XML element

__getValue(self)

 
Returns:
value of the 'value' attribute of represented XML element

__setValue(self, newValue)

 

Sets value of the 'value' attribute to newValue.

Parameters:
  • newValue (str) - new value of the 'value' attribute of represented XML element

fromXML(cls, sourceXMLElement, indexer=None)
Class Method

 

Creates object from its (valid) xml representation.

Parameters:
  • sourceXMLElement (xml.dom.Node) - XML description of the barIndexerPropertyElement object to be created
  • indexer (barIndexer) - the object encapsulating returned class instance
Returns: cls
object based on sourceXMLElement description
Overrides: barIndexerObject.fromXML

Property Details [hide private]

type

The 'type' attribute of represented 'property' element.

Get Method:
__getType(self) - Returns: value of the 'type' attribute of represented XML element
Set Method:
__setType(self, newType) - Sets value of the 'type' attribute to newType.

name

An alias for type property.

Get Method:
__getType(self) - Returns: value of the 'type' attribute of represented XML element
Set Method:
__setType(self, newType) - Sets value of the 'type' attribute to newType.

value

The 'value' attribute of represented 'property' element.

Get Method:
__getValue(self) - Returns: value of the 'value' attribute of represented XML element
Set Method:
__setValue(self, newValue) - Sets value of the 'value' attribute to newValue.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Mar 20 14:31:35 2013 http://epydoc.sourceforge.net