StaffPosition

class pitchtools.StaffPosition(number=0)

Staff position.

Initializes staff position at middle line of staff:

>>> pitchtools.StaffPosition(0)
StaffPosition(number=0)

Initializes staff position one space below middle line of staff:

>>> pitchtools.StaffPosition(-1)
StaffPosition(number=-1)

Initializes staff position one line below middle line of staff:

>>> pitchtools.StaffPosition(-2)
StaffPosition(number=-2)

Staff positions are immutable.

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

Bases

Attribute summary

number Gets staff position number.
__copy__(*arguments) Copies Abjad value object.
__eq__(other) Is true when other is a staff position with the same number as this staff position.
__float__() Casts staff position as floating point number.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes staff position.
__int__() Changes staff position to integer.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of staff position.

Read-only properties

StaffPosition.number

Gets staff position number.

>>> pitchtools.StaffPosition(-2).number
-2

Returns number.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

StaffPosition.__eq__(other)

Is true when other is a staff position with the same number as this staff position. Otherwise false.

>>> staff_position_1 = pitchtools.StaffPosition(-2)
>>> staff_position_2 = pitchtools.StaffPosition(-2)
>>> staff_position_3 = pitchtools.StaffPosition(0)
>>> staff_position_1 == staff_position_1
True
>>> staff_position_1 == staff_position_2
True
>>> staff_position_1 == staff_position_3
False
>>> staff_position_1 == 'foo'
False

Returns true or false.

StaffPosition.__float__()

Casts staff position as floating point number.

>>> float(pitchtools.StaffPosition(-2))
-2.0

Returns floating-point number.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

StaffPosition.__hash__()

Hashes staff position.

Returns integer.

StaffPosition.__int__()

Changes staff position to integer.

>>> int(pitchtools.StaffPosition(-2))
-2

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.

StaffPosition.__str__()

Gets string representation of staff position.

>>> str(pitchtools.StaffPosition(-2))
'StaffPosition(-2)'

Returns string.