UMLの
タイミング図は、システムの
タイミング制約を視覚化する、特定のタイプの
相互作用図です。この図では、
イベントの時系列的な順序に注目し、さまざまなオブジェクトが時間の経過とともにどのように相互作用するかを示しま す。
タイミング図は、
リアルタイム・システムや
組込みシステムにおいて、ある期間を通してのオブジェクトの振る舞いを理解する ために特に役立ちます。
以下のキーワードを使用してライフラインを定義します。表示方法に応じてキーワードを選択します。
キーワード
|
説明
|
concise
|
データの動きを表すための単純化された信号(メッセージに最適です)
|
robust
|
状態の遷移を表すための複雑な線(複数の状態を作れます)
|
clock
|
period の時間間隔でhighとlowの状態を繰り返し遷移するクロック信号(pulse , offset を指定することもできます)
|
binary
|
2状態(バイナリ)に制限された信号
|
@
と
is
を用いて、状態の変化を記述できます。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@0
WU is アイドル
WB is アイドル
@100
WU is 待機
WB is 処理中
@300
WB is 待機
@enduml
|
🎉 Copied!
|
@startuml
clock "Clock_0" as C0 with period 50
clock "Clock_1" as C1 with period 50 pulse 15 offset 10
binary "Binary" as B
concise "Concise" as C
robust "Robust" as R
@0
C is Idle
R is Idle
@100
B is high
C is Waiting
R is Processing
@300
R is Waiting
@enduml
|
[Ref. QA-14631 and QA-14647]
[Ref. QA-14631, QA-14647 and QA-11288]
WARNING
This translation need to be updated. WARNING
次のキーワードでバイナリ信号とクロック信号を定義することができます:
🎉 Copied!
|
@startuml
clock clk with period 1
binary "Enable" as EN
@0
EN is low
@5
EN is high
@10
EN is low
@enduml
|
メッセージは、矢印構文を使います。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@0
WU is アイドル
WB is アイドル
@100
WU -> WB : URL
WU is 待機
WB is 処理中
@300
WB is 待機
@enduml
|
@
で時間を指定するとき、相対的な時間の指定の仕方ができます。
🎉 Copied!
|
@startuml
robust "DNS Resolver" as DNS
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@0
WU is アイドル
WB is アイドル
DNS is アイドル
@+100
WU -> WB : URL
WU is 待機
WB is 処理中
@+200
WB is 待機
WB -> DNS@+50 : URL から IPアドレス を解決
@+100
DNS is 処理中
@+300
DNS is アイドル
@enduml
|
絶対時間、相対時間を使用する代わりに、
as
キーワードと
:
で開始する名前を使用してアンカーポイントを定義することができます。
@XX as :<anchor point name>
🎉 Copied!
|
@startuml
clock clk with period 1
binary "enable" as EN
concise "dataBus" as db
@0 as :start
@5 as :en_high
@10 as :en_low
@:en_high-2 as :en_highMinus2
@:start
EN is low
db is "0x0000"
@:en_high
EN is high
@:en_low
EN is low
@:en_highMinus2
db is "0xf23a"
@:en_high+6
db is "0x0000"
@enduml
|
時系列順での定義ではなく、インスタンス毎(≒ライフライン毎)に定義できます。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@WB
0 is アイドル
+200 is 処理中
+100 is 待機
@WU
0 is 待機
+500 is ok
@enduml
|
スケール(目盛りの数値の表示)を指定できます。
以下の例では、「目盛りを 100ずつ 表示、1目盛りの幅を 50px にする」設定になります。
🎉 Copied!
|
@startuml
concise "ユーザ" as WU
scale 100 as 50 pixels
@WU
0 is 待機
+500 is ok
@enduml
|
WARNING
This translation need to be updated. WARNING
「初期状態」を設定できます。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
WB is 初期化中
WU is 不在
@WB
0 is アイドル
+200 is 処理中
+100 is 待機
@WU
0 is 待機
+500 is ok
@enduml
|
信号をいくつかの不定状態とすることができます。
🎉 Copied!
|
@startuml
robust "Signal1" as S1
robust "Signal2" as S2
S1 has 0,1,2,hello
S2 has 0,1,2
@0
S1 is 0
S2 is 0
@100
S1 is {0,1} #SlateGrey
S2 is {0,1}
@200
S1 is 1
S2 is 0
@300
S1 is hello
S2 is {0,2}
@enduml
|
*[Ref. [QA-11936](https:
forum.plantuml.net/11936) and [QA-15933](https:forum.plantuml.net/15933)]*
WARNING
This translation need to be updated. WARNING
いくつかの状態を非表示にすることもできます。
🎉 Copied!
|
@startuml
concise "Web User" as WU
@0
WU is {-}
@100
WU is A1
@200
WU is {-}
@300
WU is {hidden}
@400
WU is A3
@500
WU is {-}
@enduml
|
🎉 Copied!
|
@startuml
scale 1 as 50 pixels
concise state0
concise substate1
robust bit2
bit2 has HIGH,LOW
@state0
0 is 18_start
6 is s_dPause
8 is 10_data
14 is {hidden}
@substate1
0 is sSeq
4 is sPause
6 is {hidden}
8 is dSeq
12 is dPause
14 is {hidden}
@bit2
0 is HIGH
2 is LOW
4 is {hidden}
8 is HIGH
10 is LOW
12 is {hidden}
@enduml
|
[Ref. QA-12222]
時間軸を非表示にすることができます。
🎉 Copied!
|
@startuml
hide time-axis
concise "ユーザ" as WU
WU is 不在
@WU
0 is 待機
+500 is ok
@enduml
|
時刻または日付を使用することができます。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@2019/07/02
WU is アイドル
WB is アイドル
@2019/07/04
WU is 待機 : some note
WB is 処理中 : some other note
@2019/07/05
WB is 待機
@enduml
|
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@1:15:00
WU is アイドル
WB is アイドル
@1:16:30
WU is 待機 : some note
WB is 処理中 : some other note
@1:17:30
WB is 待機
@enduml
|
[Ref. QA-7019]
It is also possible to change date format.
🎉 Copied!
|
@startuml
robust "Web Browser" as WB
concise "Web User" as WU
use date format "YY-MM-dd"
@2019/07/02
WU is Idle
WB is Idle
@2019/07/04
WU is Waiting : some note
WB is Processing : some other note
@2019/07/05
WB is Waiting
@enduml
|
You can manage the time-axis labels.
Label on each tick (by default)
🎉 Copied!
|
@startuml
scale 31536000 as 40 pixels
use date format "yy-MM"
concise "OpenGL Desktop" as OD
@1992/01/01
OD is {hidden}
@1992/06/30
OD is 1.0
@1997/03/04
OD is 1.1
@1998/03/16
OD is 1.2
@2001/08/14
OD is 1.3
@2004/09/07
OD is 3.0
@2008/08/01
OD is 3.0
@2017/07/31
OD is 4.6
@enduml
|
Manual label (only when the state changes)
🎉 Copied!
|
@startuml
scale 31536000 as 40 pixels
manual time-axis
use date format "yy-MM"
concise "OpenGL Desktop" as OD
@1992/01/01
OD is {hidden}
@1992/06/30
OD is 1.0
@1997/03/04
OD is 1.1
@1998/03/16
OD is 1.2
@2001/08/14
OD is 1.3
@2004/09/07
OD is 3.0
@2008/08/01
OD is 3.0
@2017/07/31
OD is 4.6
@enduml
|
[Ref. GH-1020]
タイムラインの目盛りとは別に、時間の尺度を示す矢印を表示することができます。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
WB is 初期化中
WU is 不在
@WB
0 is アイドル
+200 is 処理中
+100 is 待機
WB@0 <-> @50 : {50 ms lag}
@WU
0 is 待機
+500 is ok
@200 <-> @+150 : {150 ms}
@enduml
|
図の一部をハイライトすることができます。
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
@0
WU is アイドル
WB is アイドル
@100
WU -> WB : URL
WU is 待機 #LightCyan;line:Aqua
@200
WB is 処理中
@300
WU -> WB@350 : URL2
WB is 待機
@+200
WU is ok
@+200
WB is アイドル
highlight 200 to 450 #Gold;line:DimGrey : This is my caption
@enduml
|
[Ref. QA-10868]
WARNING
This translation need to be updated. WARNING
note top of
および
note bottom of
キーワードを使用して、1つのオブジェクトまたは参加者に関連するノートを定義できます
( concise
オブジェクト でのみ使用可能)。
🎉 Copied!
|
@startuml
robust "Web Browser" as WB
concise "Web User" as WU
@0
WU is Idle
WB is Idle
@100
WU is Waiting
WB is Processing
note top of WU : first note\non several\nlines
note bottom of WU : second note\non several\nlines
@300
WB is Waiting
@enduml
|
[Ref.QA-6877]
[Ref. [QA-6877](https://forum.plantuml.net/6877), [GH-1465](https://github.com/plantuml/plantuml/issues/1465)]
WARNING
This translation need to be updated. WARNING
(他の UML ダイアグラムと同様に)タイトル、ヘッダー/フッター、説明文、キャプション を書くことができます。
🎉 Copied!
|
@startuml
Title これはタイトル
header: ここにヘッダーを書く
footer: ここにフッターを書く
legend
図の説明は、ここに書きます。
複数行かけますよ。
end legend
caption 一行の説明は、caption に書きましょう。
robust "Web ブラウザ" as WB
concise "ユーザ" as WU
@0
WU is アイドル
WB is アイドル
@100
WU is 待機
WB is 処理中
@300
WB is 待機
@enduml
|
Adam Rosienによる例:
🎉 Copied!
|
@startuml
concise "Client" as Client
concise "Server" as Server
concise "Response freshness" as Cache
Server is idle
Client is idle
@Client
0 is send
Client -> Server@+25 : GET
+25 is await
+75 is recv
+25 is idle
+25 is send
Client -> Server@+25 : GET\nIf-Modified-Since: 150
+25 is await
+50 is recv
+25 is idle
@100 <-> @275 : no need to re-request from server
@Server
25 is recv
+25 is work
+25 is send
Server -> Client@+25 : 200 OK\nExpires: 275
+25 is idle
+75 is recv
+25 is send
Server -> Client@+25 : 304 Not Modified
+25 is idle
@Cache
75 is fresh
+200 is stale
@enduml
|
🎉 Copied!
|
@startuml
scale 5 as 150 pixels
clock clk with period 1
binary "enable" as en
binary "R/W" as rw
binary "data Valid" as dv
concise "dataBus" as db
concise "address bus" as addr
@6 as :write_beg
@10 as :write_end
@15 as :read_beg
@19 as :read_end
@0
en is low
db is "0x0"
addr is "0x03f"
rw is low
dv is 0
@:write_beg-3
en is high
@:write_beg-2
db is "0xDEADBEEF"
@:write_beg-1
dv is 1
@:write_beg
rw is high
@:write_end
rw is low
dv is low
@:write_end+1
rw is low
db is "0x0"
addr is "0x23"
@12
dv is high
@13
db is "0xFFFF"
@20
en is low
dv is low
@21
db is "0x0"
highlight :write_beg to :write_end #Gold:Write
highlight :read_beg to :read_end #lightBlue:Read
db@:write_beg-1 <-> @:write_end : setup time
db@:write_beg-1 -> addr@:write_end+1 : hold
@enduml
|
色を追加できます。
🎉 Copied!
|
@startuml
concise "LR" as LR
concise "ST" as ST
LR is AtPlace #palegreen
ST is AtLoad #gray
@LR
0 is Lowering
100 is Lowered #pink
350 is Releasing
@ST
200 is Moving
@enduml
|
[Ref. QA-5776]
スタイル無し(デフォルト)
🎉 Copied!
|
@startuml
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
WB is 初期化中
WU is 不在
@WB
0 is アイドル
+200 is 処理中
+100 is 待機
WB@0 <-> @50 : {50 ms lag}
@WU
0 is 待機
+500 is ok
@200 <-> @+150 : {150 ms}
@enduml
|
スタイル有り
スタイルを使用して要素の表示方法を変更することができます。
🎉 Copied!
|
@startuml
<style>
timingDiagram {
document {
BackGroundColor SandyBrown
}
constraintArrow {
LineStyle 2-1
LineThickness 3
LineColor Blue
}
}
</style>
robust "ウェブブラウザ" as WB
concise "ユーザ" as WU
WB is 初期化中
WU is 不在
@WB
0 is アイドル
+200 is 処理中
+100 is 待機
WB@0 <-> @50 : {50 ms lag}
@WU
0 is 待機
+500 is ok
@200 <-> @+150 : {150 ms}
@enduml
|
[Ref. QA-14340]
You can use the
<style>
tags and sterotyping to give a name to line attributes.
🎉 Copied!
|
@startuml
<style>
timingDiagram {
.red {
LineColor red
}
.blue {
LineColor blue
LineThickness 5
}
}
</style>
clock clk with period 1
binary "Input Signal 1" as IS1
binary "Input Signal 2" as IS2 <<blue>>
binary "Output Signal 1" as OS1 <<red>>
@0
IS1 is low
IS2 is high
OS1 is low
@2
OS1 is high
@4
OS1 is low
@5
IS1 is high
OS1 is high
@6
IS2 is low
@10
IS1 is low
OS1 is low
@enduml
|
[Ref. QA-15870]
You can use
compact
command to compact the timing layout.
By default
🎉 Copied!
|
@startuml
robust "Web Browser" as WB
concise "Web User" as WU
robust "Web Browser2" as WB2
@0
WU is Waiting
WB is Idle
WB2 is Idle
@200
WB is Proc.
@300
WB is Waiting
WB2 is Waiting
@500
WU is ok
@700
WB is Idle
@enduml
|
Global mode with mode compact
🎉 Copied!
|
@startuml
mode compact
robust "Web Browser" as WB
concise "Web User" as WU
robust "Web Browser2" as WB2
@0
WU is Waiting
WB is Idle
WB2 is Idle
@200
WB is Proc.
@300
WB is Waiting
WB2 is Waiting
@500
WU is ok
@700
WB is Idle
@enduml
|
Local mode with only compact
on element
🎉 Copied!
|
@startuml
compact robust "Web Browser" as WB
compact concise "Web User" as WU
robust "Web Browser2" as WB2
@0
WU is Waiting
WB is Idle
WB2 is Idle
@200
WB is Proc.
@300
WB is Waiting
WB2 is Waiting
@500
WU is ok
@700
WB is Idle
@enduml
|
[Ref. QA-11130]
You can scale analog signal.
Without scaling: 0-max (by default)
🎉 Copied!
|
@startuml
title Between 0-max (by default)
analog "Analog" as A
@0
A is 350
@100
A is 450
@300
A is 350
@enduml
|
With scaling: min-max
🎉 Copied!
|
@startuml
title Between min-max
analog "Analog" between 350 and 450 as A
@0
A is 350
@100
A is 450
@300
A is 350
@enduml
|
[Ref. QA-17161]
Without any customisation (by default)
🎉 Copied!
|
@startuml
analog "Vcore" as VDD
analog "VCC" as VCC
@0
VDD is 0
VCC is 3
@2
VDD is 0
@3
VDD is 6
VCC is 6
VDD@1 -> VCC@2 : "test"
@enduml
|
With customisation (on scale, ticks and height)
🎉 Copied!
|
@startuml
analog "Vcore" as VDD
analog "VCC" between -4.5 and 6.5 as VCC
VCC ticks num on multiple 3
VCC is 200 pixels height
@0
VDD is 0
VCC is 3
@2
VDD is 0
@3
VDD is 6
VCC is 6
VDD@1 -> VCC@2 : "test"
@enduml
|
[Ref. QA-11288]
Without order (by default)
🎉 Copied!
|
@startuml
robust "Flow rate" as rate
@0
rate is high
@5
rate is none
@6
rate is low
@enduml
|
With order
🎉 Copied!
|
@startuml
robust "Flow rate" as rate
rate has high,low,none
@0
rate is high
@5
rate is none
@6
rate is low
@enduml
|
With order and label
🎉 Copied!
|
@startuml
robust "Flow rate" as rate
rate has "35 gpm" as high
rate has "15 gpm" as low
rate has "0 gpm" as none
@0
rate is high
@5
rate is none
@6
rate is low
@enduml
|
[Ref. QA-6651]