class FieldDeclaration:
- """Field declaration class. Do not instantiate."""
+ """
+ Base class for concrete field declarations.
+
+ This class is not meant to be instantiated by the user.
+ """
def __init__(self):
raise NotImplementedError("FieldDeclaration cannot be instantiated")
@property
def name(self):
- """Return the name of a FieldDeclaration or None on error."""
+ """
+ Field's name, or ``None`` on error.
+ """
return self._name
@property
def type(self):
"""
- Return the FieldDeclaration's type. One of the entries in class
- CTFTypeId.
+ Field's type (one of :class:`CTFTypeId` constants).
"""
return nbt._bt_ctf_field_type(self._fd)
@property
def scope(self):
"""
- Return the FieldDeclaration's scope.
+ Field's scope (one of :class:`CTFScope` constants).
"""
return self._s
class IntegerFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Integer field declaration.
+ """
def __init__(self):
raise NotImplementedError("IntegerFieldDeclaration cannot be instantiated")
@property
def signedness(self):
"""
- Return the signedness of an integer:
- 0 if unsigned; 1 if signed; -1 on error.
+ 0 if this integer is unsigned, 1 if signed, or -1 on error.
"""
return nbt._bt_ctf_get_int_signedness(self._fd)
@property
def base(self):
- """Return the base of an int or a negative value on error."""
+ """
+ Integer's base (``int``), or a negative value on error.
+ """
return nbt._bt_ctf_get_int_base(self._fd)
@property
def byte_order(self):
"""
- Return the byte order. One of class ByteOrder's entries.
+ Integer's byte order (one of :class:`ByteOrder` constants).
"""
ret = nbt._bt_ctf_get_int_byte_order(self._fd)
@property
def length(self):
"""
- Return the size, in bits, of an int or a negative
- value on error.
+ Integer's length in bits, or a negative value on error.
"""
return nbt._bt_ctf_get_int_len(self._fd)
@property
def encoding(self):
"""
- Return the encoding. One of class CTFStringEncoding's entries.
- Return a negative value on error.
+ Integer's encoding (one of :class:`CTFStringEncoding`
+ constants).
"""
return nbt._bt_ctf_get_encoding(self._fd)
class EnumerationFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Enumeration field declaration.
+
+ .. note::
+
+ As of this version, this class is missing some properties.
+ """
def __init__(self):
raise NotImplementedError("EnumerationFieldDeclaration cannot be instantiated")
class ArrayFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Static array field declaration.
+ """
def __init__(self):
raise NotImplementedError("ArrayFieldDeclaration cannot be instantiated")
@property
def length(self):
"""
- Return the length of an array or a negative
- value on error.
+ Static array's fixed length (number of contained elements), or
+ a negative value on error.
"""
return nbt._bt_ctf_get_array_len(self._fd)
@property
def element_declaration(self):
"""
- Return element declaration.
+ Underlying element's field declaration.
"""
field_decl_ptr = nbt._bt_python_get_array_element_declaration(self._fd)
class SequenceFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Sequence (dynamic array) field declaration.
+
+ .. note::
+
+ As of this version, this class is missing some properties.
+ """
def __init__(self):
raise NotImplementedError("SequenceFieldDeclaration cannot be instantiated")
@property
def element_declaration(self):
"""
- Return element declaration.
+ Underlying element's field declaration.
"""
field_decl_ptr = nbt._bt_python_get_sequence_element_declaration(self._fd)
class FloatFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Floating point number field declaration.
+
+ .. note::
+
+ As of this version, this class is missing some properties.
+ """
def __init__(self):
raise NotImplementedError("FloatFieldDeclaration cannot be instantiated")
class StructureFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Structure (ordered map of field names to field declarations) field
+ declaration.
+
+ .. note::
+
+ As of this version, this class is missing some properties.
+ """
def __init__(self):
raise NotImplementedError("StructureFieldDeclaration cannot be instantiated")
class StringFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ String (NULL-terminated array of bytes) field declaration.
+
+ .. note::
+
+ As of this version, this class is missing some properties.
+ """
def __init__(self):
raise NotImplementedError("StringFieldDeclaration cannot be instantiated")
class VariantFieldDeclaration(FieldDeclaration):
- """Do not instantiate."""
+ """
+ Variant (dynamic selection between different types) field declaration.
+
+ .. note::
+
+ As of this version, this class is missing some properties.
+ """
def __init__(self):
raise NotImplementedError("VariantFieldDeclaration cannot be instantiated")