IndicatorExpression

class indicatortools.IndicatorExpression(component=None, indicator=None, is_annotation=None, name=None, scope=None, synthetic_offset=None)

An indicator expression.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.IndicatorExpression.IndicatorExpression" [color=black, fontcolor=white, group=2, label=<<B>IndicatorExpression</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.indicatortools.IndicatorExpression.IndicatorExpression"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

component Start component of indicator expression.
indicator Indicator of indicator expression.
is_annotation Is true if indicator expression is annotative.
name Indicator expression name.
scope Target context of indicator expression.
start_offset Start offset of indicator expression.
synthetic_offset Optional synthetic offset.
__copy__() Copies indicator expression.
__eq__(expr) Is true when all initialization values of Abjad value object equal the initialization values of expr.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of indicator expression.

Read-only properties

IndicatorExpression.component

Start component of indicator expression.

Returns component.

IndicatorExpression.indicator

Indicator of indicator expression.

Returns indicator.

IndicatorExpression.is_annotation

Is true if indicator expression is annotative.

Returns true or false.

IndicatorExpression.name

Indicator expression name.

Returns string.

IndicatorExpression.scope

Target context of indicator expression.

Returns context.

IndicatorExpression.start_offset

Start offset of indicator expression.

This is either the expression’s synthetic offset or the start offset of the expression’s component.

Returns offset.

IndicatorExpression.synthetic_offset

Optional synthetic offset.

Returns offset or None.

Special methods

IndicatorExpression.__copy__()

Copies indicator expression.

Note that indicator and scope are copied but that start component is not copied. This is to avoid start component reference problems.

Returns new indicator expression.

(AbjadValueObject).__eq__(expr)

Is true when all initialization values of Abjad value object equal the initialization values of expr.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

IndicatorExpression.__repr__()

Gets interpreter representation of indicator expression.

Returns string.