StaffChange

class indicatortools.StaffChange(staff=None)

Staff change.

Example 1. Explicit staff change:

>>> staff_group = StaffGroup()
>>> staff_group.context_name = 'PianoStaff'
>>> rh_staff = Staff("c'8 d'8 e'8 f'8")
>>> rh_staff.name = 'RHStaff'
>>> lh_staff = Staff("s2")
>>> lh_staff.name = 'LHStaff'
>>> staff_group.extend([rh_staff, lh_staff])
>>> staff_change = indicatortools.StaffChange(lh_staff)
>>> attach(staff_change, rh_staff[2])
>>> show(staff_group) 

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.StaffChange.StaffChange" [color=black, fontcolor=white, group=2, label=<<B>StaffChange</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.StaffChange.StaffChange"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

default_scope Gets default scope of staff change.
staff Gets staff of staff change.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of staff change.

Read-only properties

StaffChange.default_scope

Gets default scope of staff change.

Example 1. Default staff change:

>>> staff_change = indicatortools.StaffChange()
>>> staff_change.default_scope
<class 'abjad.tools.scoretools.Staff.Staff'>

Example 2. Explicit staff change:

>>> staff_change = indicatortools.StaffChange(staff=lh_staff)
>>> staff_change.default_scope
<class 'abjad.tools.scoretools.Staff.Staff'>

Staff changes are staff-scoped.

Returns staff.

StaffChange.staff

Gets staff of staff change.

Example 1. Default staff change:

>>> staff_change = indicatortools.StaffChange()
>>> staff_change.staff is None
True

Example 2. Explicit staff change:

>>> staff_change = indicatortools.StaffChange(staff=lh_staff)
>>> staff_change.staff
Staff('s2')

Set to staff or none.

Defaults to none.

Returns staff or none.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

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

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__(argument)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

StaffChange.__str__()

Gets string representation of staff change.

Example 1. Default staff change:

>>> staff_change = indicatortools.StaffChange()
>>> print(str(staff_change))
\change Staff = ##f

Example 2. Explicit staff change:

>>> staff_change = indicatortools.StaffChange(staff=lh_staff)
>>> print(str(staff_change))
\change Staff = LHStaff

Returns string.