Module simwbClient :: Class RTDBItem

Class RTDBItem

object --+
         |
        RTDBItem


The RTDBItem class contains all the information known about a
particular RTDB item. This information is made available
via the object's properties.

Some properties are common to all items:
    Name
    CVTType
    PointType
    NumElements
    MetaFlags       (see NOTE1)

Other properties are optional:
    LoggingPeriod
    A
    B
    EUMin
    EUMax
    EUMsgPeriod
    Units
    Description
    DefaultValue    (see NOTE2)
    ColMajor        (see NOTE2)
    Dimensions      (see NOTE2)

When a property is not defined for an item it will be set
to None.

NOTE1:
    MetaFlags bits are defined by the METAFL_* bit masks
    defined in the simwbConstants module.

NOTE2:
    The Info dictionary contains these values as strings.
    For ease of use, they are returned as:
        Property        String             Return
        --------------------------------------------------
        DefaultValue    '[2.1 5.4 4.3]' -> [2.1, 5.4, 4.3]
        DefaultValue    '6.9'           -> 6.9
        ColMajor        '0'             -> False
        ColMajor        '1'             -> True
        Dimensions      '2x3x1'         -> [2, 3, 1]
        Dimensions      '7'             -> 7

Instance Methods

__init__(self, name, info)
x.__init__(...) initializes x; see help(type(x)) for signature

__repr__(self)
repr(x)

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

Properties
	A RTDB item EU scaling A in Ax+B (double)
	B RTDB item EU scaling B in Ax+B (double)
	CVTType RTDB item CVT type (string)
	ColMajor RTDB item is stored as column-major (bool)
	DefaultValue RTDB item default value (list, double)
	Description RTDB item description (string)
	Dimensions RTDB item dimension (list, int)
	EUMax RTDB item EU maximum value (double)
	EUMin RTDB item EU minimum value (double)
	EUMsgPeriod RTDB item EU out-of-bounds message period (int, cycles)
	Info RTDB item information (dictionary)
	LoggingPeriod RTDB item logging period (int, usec)
	MetaFlags RTDB item meta flags (int)
	Name RTDB item name (string)
	NumElements RTDB item number of elements (int)
	PointType RTDB item point type (string)
	Units RTDB item EU units (string)
	Value RTDB item current value (list, double)
Inherited from `object`: `__class__`

Method Details

init(self, name, info)
(Constructor)

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

Overrides: object.__init__: (inherited documentation)

repr(self)
(Representation operator)

repr(x)

Overrides: object.__repr__: (inherited documentation)

Property Details

A

RTDB item EU scaling A in Ax+B (double)

Get Method:: __getA(self)

B

RTDB item EU scaling B in Ax+B (double)

Get Method:: __getB(self)

CVTType

RTDB item CVT type (string)

Get Method:: __getCVTType(self)

ColMajor

RTDB item is stored as column-major (bool)

Get Method:: __getColMajor(self)

DefaultValue

RTDB item default value (list, double)

Get Method:: __getDefaultValue(self)

Description

RTDB item description (string)

Get Method:: __getDescription(self)

Dimensions

RTDB item dimension (list, int)

Get Method:: __getDimensions(self)

EUMax

RTDB item EU maximum value (double)

Get Method:: __getEUMax(self)

EUMin

RTDB item EU minimum value (double)

Get Method:: __getEUMin(self)

EUMsgPeriod

RTDB item EU out-of-bounds message period (int, cycles)

Get Method:: __getEUMsgPeriod(self)

Info

RTDB item information (dictionary)

Get Method:: __getInfo(self)

LoggingPeriod

RTDB item logging period (int, usec)

Get Method:: __getLoggingPeriod(self)

MetaFlags

RTDB item meta flags (int)

Get Method:: __getMetaFlags(self)

Name

RTDB item name (string)

Get Method:: __getName(self)

NumElements

RTDB item number of elements (int)

Get Method:: __getNumElements(self)

PointType

RTDB item point type (string)

Get Method:: __getPointType(self)

Units

RTDB item EU units (string)

Get Method:: __getUnits(self)

Value

RTDB item current value (list, double)

Get Method:: __getValue(self)
Set Method:: __setValue(self, v)