Home       Trees       Indices       Help   
glue
Package glue :: Package ligolw :: Module param :: Class Param
[hide private]
[frames] | no frames]

Class Param

source code

    object --+        
             |        
ligolw.Element --+    
                 |    
      ligolw.Param --+
                     |
                    Param

High-level Param element. The value is stored in the pcdata attribute as the native Python type rather than as a string.

Nested Classes [hide private]
  ParamName
Instance Methods [hide private]
 
endElement(self)
Method invoked by document parser when it encounters the end-of-element event.		 source code
 
write(self, fileobj=<epydoc.docintrospecter._DevNull instance at 0x7f39154699e0>, indent=u'')
Recursively write an element and it's children to a file.		 source code

Inherited from ligolw.Element: __init__, appendChild, appendData, end_tag, getAttribute, getChildrenByAttributes, getElements, getElementsByTagName, hasAttribute, insertBefore, removeAttribute, removeChild, replaceChild, setAttribute, start_tag, unlink

Inherited from ligolw.Element (private): _verifyChildren

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

Class Methods [hide private]
 
build(cls, name, Type, value, start=None, scale=None, unit=None, dataunit=None, comment=None)
Construct a LIGO Light Weight XML Param document subtree.		 source code
 
from_pyvalue(cls, name, value, **kwargs)
Convenience wrapper for .build() that constructs a Param element from an instance of a Python builtin type.		 source code
 
getParamsByName(cls, elem, name)
Return a list of params with name name under elem.		 source code

Inherited from ligolw.Element: validattributes

Class Variables [hide private]

Inherited from ligolw.Param: tagName, validchildren

Properties [hide private]
  Name
The "Name" attribute.
  Scale
The "Scale" attribute.
  Type
The "Type" attribute.

Inherited from ligolw.Param: DataUnit, Start, Unit

Inherited from object: __class__

Method Details [hide private]

build(cls, name, Type, value, start=None, scale=None, unit=None, dataunit=None, comment=None)
Class Method

source code 

Construct a LIGO Light Weight XML Param document subtree. FIXME: document keyword arguments.

endElement(self)

source code 

Method invoked by document parser when it encounters the end-of-element event.

Overrides: ligolw.Element.endElement
(inherited documentation)

from_pyvalue(cls, name, value, **kwargs)
Class Method

source code 

Convenience wrapper for .build() that constructs a Param element from an instance of a Python builtin type. See .build() for a description of the valid keyword arguments.

write(self, fileobj=<epydoc.docintrospecter._DevNull instance at 0x7f39154699e0>, indent=u'')

source code 

Recursively write an element and it's children to a file.

Overrides: ligolw.Element.write
(inherited documentation)

Property Details [hide private]

Name

The "Name" attribute.

Get Method:
unreachable.getter(self)
Set Method:
unreachable.setter(self, value)
Delete Method:
unreachable.deleter(self)

Scale

The "Scale" attribute.

Get Method:
unreachable.getter(self)
Set Method:
unreachable.setter(self, value)
Delete Method:
unreachable.deleter(self)

Type

The "Type" attribute. Default is "lstring" if not set.

Get Method:
unreachable.getter(self)
Set Method:
unreachable.setter(self, value)
Delete Method:
unreachable.deleter(self)

   Home       Trees       Indices       Help   
glue
Generated by Epydoc 3.0.1 on Tue Dec 12 00:34:20 2017 http://epydoc.sourceforge.net