Package gavo :: Package dm :: Module common :: Class AnnotationBase
[frames] | no frames]

Class AnnotationBase

source code

object --+
         |
        AnnotationBase
Known Subclasses:

A base class for of structs.

Basically, these are pairs of a role name and something else, which depends on the actual subclass (e.g., an atomic value, a reference, a sequence of key-value pairs, a sequence of other objects, ...).

They have a method getVOT(ctx, instance) -> xmlstan, which, using a votablewrite.Context ctx, will return mapping-document conformant VOTable xmlstan; instance is the rsc/rscdef structure the annotation is produced for.

Use asSIL() to retrieve a simple string representation.

Compund annotations (sequences, key-value pairs) should use add(thing) to build themselves up.

AnnotationBase is abstract and doesn't implement some of these methods.

Instance Methods
 
__init__(self, name, instance)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getVOT(self, ctx, instance) source code
 
asSIL(self) source code
 
add(self, thing) source code
 
iterNodes(self) source code

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

Properties

Inherited from object: __class__

Method Details

__init__(self, name, instance)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)