TaurusModel

class TaurusModel(full_name='', parent=None, serializationMode=None)

Import from taurus.core.taurusmodel as:

from taurus.core.taurusmodel import TaurusModel

RegularEvent = (0, 1, 2)

addListener(listener)

classmethod buildModelName(parent_model, relative_name)

cleanUp()

The cleanUp. Default implementation does nothing Overwrite when necessary

deleteListener(listener)

classmethod factory()

fireEvent(event_type, event_value, listeners=None)

sends an event to all listeners or a specific one

forceListening()

property fullname

getChildObj(child_name)

getDisplayDescrObj(cache=True)

A brief description of the model. Can be used as tooltip, for example.

getDisplayName(cache=True, complete=True)

getEventCounts()

Return event counts keyed by TaurusEventType.

Counts are collected passively when the model dispatches events. This makes them suitable for diagnostics without adding observer listeners.

getFragmentObj(fragmentName=None)

Returns a fragment object of the model. A fragment is computed from a model by evaluating the expression <model>.<fragmentName>

For a simple fragmentName (no dots), this is roughly equivalent to getattr(self, fragmentName)

If the fragment cannot be computed, AttributeError is raised

Parameters:

fragmentName (str or None) – the returned value will correspond to the given fragmentName. If None is passed the defaultFragmentName will be used instead.

Returns:

the computed fragment of the modelObj.

Return type:

obj

getFullName()

getLastEventTime()

Return the local UNIX time of the last dispatched event.

getListeners()

Return the currently registered live listeners.

The returned tuple is a snapshot. Inspecting it does not register a listener or otherwise change the model subscription state.

classmethod getNameValidator()

getNormalName()

getParentObj()

getSerializationMode()

Gives the serialization operation mode.

Returns:

the current serialization mode

Return type:

TaurusSerializationMode

getSimpleName()

classmethod getTaurusElementType()

hasListeners()

returns True if anybody is listening to events from this attribute

classmethod isValid(*args, **kwargs)

isWritable()

property name

property parentObj

removeListener(listener)

classmethod setEventStatisticsEnabled(enabled)

Enable or disable passive event statistics for all models.

Statistics are disabled by default to avoid adding measurable work to the event dispatch hot path when diagnostics are not being used. Existing counters are preserved when collection is disabled.

setSerializationMode(mode)

Sets the serialization mode for the system.

Parameters:

mode (TaurusSerializationMode) – the new serialization mode

unforceListening()