Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Small PR] Made Labels more meaningful in GlassBR #914

Merged
merged 4 commits into from
Jul 20, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions code/drasil-example/Drasil/GlassBR/TMods.hs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ t1IsSafe = tm' (cw t1SafetyReq)
[t1descr]

t1SafetyReq :: RelationConcept
t1SafetyReq = makeRC "t1SafetyReq" (nounPhraseSP "Safety Requirement-1")
t1SafetyReq = makeRC "safetyReqPb" (nounPhraseSP "Safety Req-Pb")
t1descr ((sy is_safe1) $= (sy prob_br) $< (sy pb_tol))

t1descr :: Sentence
Expand All @@ -47,7 +47,7 @@ t2IsSafe = tm' (cw t2SafetyReq)
[t2descr]

t2SafetyReq :: RelationConcept
t2SafetyReq = makeRC "t2SafetyReq" (nounPhraseSP "Safety Requirement-2")
t2SafetyReq = makeRC "safetyReqLR" (nounPhraseSP "Safety Req-LR")
t2descr ( (sy is_safe2) $= (sy lRe) $> (sy demand))

t2descr :: Sentence
Expand Down
30 changes: 15 additions & 15 deletions code/stable/glassbr/SRS/GlassBR_SRS.tex
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,11 @@ \subsubsection{Theoretical Models}
~\newline
\noindent \begin{minipage}{\textwidth}
\begin{tabular}{p{0.2\textwidth} p{0.73\textwidth}}
\toprule \textbf{Refname} & \textbf{T:t1SafetyReq}
\toprule \textbf{Refname} & \textbf{T:safetyReqPb}
\phantomsection
\label{T:t1SafetyReq}
\label{T:safetyReqPb}
\\ \midrule \\
Label & Safety Requirement-1
Label & Safety Req-Pb
\\ \midrule \\
Equation & \begin{dmath}
is\_safe1={P_{b}}<{P_{btol}}
Expand All @@ -372,7 +372,7 @@ \subsubsection{Theoretical Models}
\item{${P_{btol}}$ is the tolerable probability of breakage (Unitless)}
\end{symbDescription}
\\ \midrule \\
Notes & If $is\_safe1$, the glass is considered safe. $is\_safe1$ and $is\_safe2$ (from \hyperref[T:t2SafetyReq]{Definition~T:t2SafetyReq}) are either both True or both False. ${P_{b}}$ is the probability of breakage, as calculated in \hyperref[T:probOfBr]{Definition~T:probOfBr}. ${P_{btol}}$ is the tolerable probability of breakage entered by the user.
Notes & If $is\_safe1$, the glass is considered safe. $is\_safe1$ and $is\_safe2$ (from \hyperref[T:safetyReqLR]{Definition~T:safetyReqLR}) are either both True or both False. ${P_{b}}$ is the probability of breakage, as calculated in \hyperref[T:probOfBr]{Definition~T:probOfBr}. ${P_{btol}}$ is the tolerable probability of breakage entered by the user.
\\ \midrule \\
Source & FIXME: This needs to be filled in
\\ \midrule \\
Expand All @@ -382,11 +382,11 @@ \subsubsection{Theoretical Models}
~\newline
\noindent \begin{minipage}{\textwidth}
\begin{tabular}{p{0.2\textwidth} p{0.73\textwidth}}
\toprule \textbf{Refname} & \textbf{T:t2SafetyReq}
\toprule \textbf{Refname} & \textbf{T:safetyReqLR}
\phantomsection
\label{T:t2SafetyReq}
\label{T:safetyReqLR}
\\ \midrule \\
Label & Safety Requirement-2
Label & Safety Req-LR
\\ \midrule \\
Equation & \begin{dmath}
is\_safe2=LR>q
Expand All @@ -398,7 +398,7 @@ \subsubsection{Theoretical Models}
\item{$q$ is the applied load (demand) (kPa)}
\end{symbDescription}
\\ \midrule \\
Notes & If $is\_safe2$, the glass is considered safe. $is\_safe1$ (from \hyperref[T:t1SafetyReq]{Definition~T:t1SafetyReq}) and $is\_safe2$ are either both True or both False. LR is the load resistance (also called capacity), as defined in \hyperref[T:calOfCap]{Definition~T:calOfCap}. $q$ (also referred as the Demand) is the 3 second duration equivalent pressure, as defined in \hyperref[T:calOfDe]{Definition~T:calOfDe}.
Notes & If $is\_safe2$, the glass is considered safe. $is\_safe1$ (from \hyperref[T:safetyReqPb]{Definition~T:safetyReqPb}) and $is\_safe2$ are either both True or both False. LR is the load resistance (also called capacity), as defined in \hyperref[T:calOfCap]{Definition~T:calOfCap}. $q$ (also referred as the Demand) is the 3 second duration equivalent pressure, as defined in \hyperref[T:calOfDe]{Definition~T:calOfDe}.
\\ \midrule \\
Source & FIXME: This needs to be filled in
\\ \midrule \\
Expand Down Expand Up @@ -963,7 +963,7 @@ \subsection{Functional Requirements}
\item[\refstepcounter{reqnum}\rthereqnum\label{FR:functional.requirements.req4}:]Output the input quantities from R1 and the known quantities from R2.
\end{description}
\begin{description}
\item[\refstepcounter{reqnum}\rthereqnum\label{FR:functional.requirements.req5}:]If $is\_safe1$ ∧ $is\_safe2$ (from \hyperref[T:t1SafetyReq]{Definition~T:t1SafetyReq} and \hyperref[T:t2SafetyReq]{Definition~T:t2SafetyReq}) are true, output the message ``For the given input parameters, the glass is considered safe.'' If the condition is false, then output the message ``For the given input parameters, the glass is NOT considered safe.''
\item[\refstepcounter{reqnum}\rthereqnum\label{FR:functional.requirements.req5}:]If $is\_safe1$ ∧ $is\_safe2$ (from \hyperref[T:safetyReqPb]{Definition~T:safetyReqPb} and \hyperref[T:safetyReqLR]{Definition~T:safetyReqLR}) are true, output the message ``For the given input parameters, the glass is considered safe.'' If the condition is false, then output the message ``For the given input parameters, the glass is NOT considered safe.''
\end{description}
\begin{itemize}
\item[R6:]Output the following quantities:
Expand Down Expand Up @@ -1044,12 +1044,12 @@ \section{Traceability Matrices and Graphs}
The purpose of the traceability matrices is to provide easy references on what has to be additionally modified if a certain component is changed. Every time a component is changed, the items in the column of that component that are marked with an ``X'' should be modified as well. Table~\ref{Table:TraceyItemSecs} shows the dependencies of theoretical models, instance models, and data definitions with each other. Table~\ref{Table:TraceyReqsItems} shows the dependencies of requirements on theoretical models, instance models, data definitions, and data constraints. Table~\ref{Table:TraceyAssumpsOthers} shows the dependencies of theoretical models, instance models, data definitions, likely changes and requirements on the assumptions.
\begin{longtable}{l l l l l l l l l l l l l l}
\toprule
& T1 (\hyperref[T:t1SafetyReq]{Definition~T:t1SafetyReq}) & T2 (\hyperref[T:t2SafetyReq]{Definition~T:t2SafetyReq}) & IM1 (\hyperref[T:probOfBr]{Definition~T:probOfBr}) & IM2 (\hyperref[T:calOfCap]{Definition~T:calOfCap}) & IM3 (\hyperref[T:calOfDe]{Definition~T:calOfDe}) & DD1 (\hyperref[DD:risk.fun]{Definition~DD:risk.fun}) & DD2 (\hyperref[DD:min.thick]{Definition~DD:min.thick}) & DD3 (\hyperref[DD:loadDurFactor]{Definition~DD:loadDurFactor}) & DD4 (\hyperref[DD:stressDistFac]{Definition~DD:stressDistFac}) & DD5 (\hyperref[DD:nFL]{Definition~DD:nFL}) & DD6 (\hyperref[DD:gTF]{Definition~DD:gTF}) & DD7 (\hyperref[DD:dimlessLoad]{Definition~DD:dimlessLoad}) & DD8 (\hyperref[DD:tolLoad]{Definition~DD:tolLoad})
& T1 (\hyperref[T:safetyReqPb]{Definition~T:safetyReqPb}) & T2 (\hyperref[T:safetyReqLR]{Definition~T:safetyReqLR}) & IM1 (\hyperref[T:probOfBr]{Definition~T:probOfBr}) & IM2 (\hyperref[T:calOfCap]{Definition~T:calOfCap}) & IM3 (\hyperref[T:calOfDe]{Definition~T:calOfDe}) & DD1 (\hyperref[DD:risk.fun]{Definition~DD:risk.fun}) & DD2 (\hyperref[DD:min.thick]{Definition~DD:min.thick}) & DD3 (\hyperref[DD:loadDurFactor]{Definition~DD:loadDurFactor}) & DD4 (\hyperref[DD:stressDistFac]{Definition~DD:stressDistFac}) & DD5 (\hyperref[DD:nFL]{Definition~DD:nFL}) & DD6 (\hyperref[DD:gTF]{Definition~DD:gTF}) & DD7 (\hyperref[DD:dimlessLoad]{Definition~DD:dimlessLoad}) & DD8 (\hyperref[DD:tolLoad]{Definition~DD:tolLoad})
\\
\midrule
T1 (\hyperref[T:t1SafetyReq]{Definition~T:t1SafetyReq}) & & X & X & & & & & & & & & &
T1 (\hyperref[T:safetyReqPb]{Definition~T:safetyReqPb}) & & X & X & & & & & & & & & &
\\
T2 (\hyperref[T:t2SafetyReq]{Definition~T:t2SafetyReq}) & X & & & X & X & & & & & & & &
T2 (\hyperref[T:safetyReqLR]{Definition~T:safetyReqLR}) & X & & & X & X & & & & & & & &
\\
IM1 (\hyperref[T:probOfBr]{Definition~T:probOfBr}) & & & & & & X & X & X & & & & &
\\
Expand Down Expand Up @@ -1079,7 +1079,7 @@ \section{Traceability Matrices and Graphs}
\end{longtable}
\begin{longtable}{l l l l l l l l l l l l l l l l l l l l l}
\toprule
& T1 (\hyperref[T:t1SafetyReq]{Definition~T:t1SafetyReq}) & T2 (\hyperref[T:t2SafetyReq]{Definition~T:t2SafetyReq}) & IM1 (\hyperref[T:probOfBr]{Definition~T:probOfBr}) & IM2 (\hyperref[T:calOfCap]{Definition~T:calOfCap}) & IM3 (\hyperref[T:calOfDe]{Definition~T:calOfDe}) & DD1 (\hyperref[DD:risk.fun]{Definition~DD:risk.fun}) & DD2 (\hyperref[DD:min.thick]{Definition~DD:min.thick}) & DD3 (\hyperref[DD:loadDurFactor]{Definition~DD:loadDurFactor}) & DD4 (\hyperref[DD:stressDistFac]{Definition~DD:stressDistFac}) & DD5 (\hyperref[DD:nFL]{Definition~DD:nFL}) & DD6 (\hyperref[DD:gTF]{Definition~DD:gTF}) & DD7 (\hyperref[DD:dimlessLoad]{Definition~DD:dimlessLoad}) & DD8 (\hyperref[DD:tolLoad]{Definition~DD:tolLoad}) & Data Constraints (Section~\ref{Sec:DataConstraints}) & R1 (Section~\ref{Sec:FRs}) & R2 (Section~\ref{Sec:FRs}) & R3 (Section~\ref{Sec:FRs}) & R4 (Section~\ref{Sec:FRs}) & R5 (Section~\ref{Sec:FRs}) & R6 (Section~\ref{Sec:FRs})
& T1 (\hyperref[T:safetyReqPb]{Definition~T:safetyReqPb}) & T2 (\hyperref[T:safetyReqLR]{Definition~T:safetyReqLR}) & IM1 (\hyperref[T:probOfBr]{Definition~T:probOfBr}) & IM2 (\hyperref[T:calOfCap]{Definition~T:calOfCap}) & IM3 (\hyperref[T:calOfDe]{Definition~T:calOfDe}) & DD1 (\hyperref[DD:risk.fun]{Definition~DD:risk.fun}) & DD2 (\hyperref[DD:min.thick]{Definition~DD:min.thick}) & DD3 (\hyperref[DD:loadDurFactor]{Definition~DD:loadDurFactor}) & DD4 (\hyperref[DD:stressDistFac]{Definition~DD:stressDistFac}) & DD5 (\hyperref[DD:nFL]{Definition~DD:nFL}) & DD6 (\hyperref[DD:gTF]{Definition~DD:gTF}) & DD7 (\hyperref[DD:dimlessLoad]{Definition~DD:dimlessLoad}) & DD8 (\hyperref[DD:tolLoad]{Definition~DD:tolLoad}) & Data Constraints (Section~\ref{Sec:DataConstraints}) & R1 (Section~\ref{Sec:FRs}) & R2 (Section~\ref{Sec:FRs}) & R3 (Section~\ref{Sec:FRs}) & R4 (Section~\ref{Sec:FRs}) & R5 (Section~\ref{Sec:FRs}) & R6 (Section~\ref{Sec:FRs})
\\
\midrule
R1 (in Section~\ref{Sec:FRs}) & & & & & & & & & & & & & & & & & & & &
Expand All @@ -1103,9 +1103,9 @@ \section{Traceability Matrices and Graphs}
& A1 (Section~\ref{Sec:Assumps}) & A2 (Section~\ref{Sec:Assumps}) & A3 (Section~\ref{Sec:Assumps}) & A4 (Section~\ref{Sec:Assumps}) & A5 (Section~\ref{Sec:Assumps}) & A6 (Section~\ref{Sec:Assumps}) & A7 (Section~\ref{Sec:Assumps}) & A8 (Section~\ref{Sec:Assumps})
\\
\midrule
T1 (\hyperref[T:t1SafetyReq]{Definition~T:t1SafetyReq}) & & & & & & & &
T1 (\hyperref[T:safetyReqPb]{Definition~T:safetyReqPb}) & & & & & & & &
\\
T2 (\hyperref[T:t2SafetyReq]{Definition~T:t2SafetyReq}) & & & & & & & &
T2 (\hyperref[T:safetyReqLR]{Definition~T:safetyReqLR}) & & & & & & & &
\\
IM1 (\hyperref[T:probOfBr]{Definition~T:probOfBr}) & & & & X & & X & X &
\\
Expand Down
30 changes: 15 additions & 15 deletions code/stable/glassbr/Website/GlassBR_SRS.html
Original file line number Diff line number Diff line change
Expand Up @@ -1149,15 +1149,15 @@ <h3>
<p class="paragraph">
This section focuses on the general equations and laws that GlassBR is based on.
</p>
<div id="T:t1SafetyReq">
<div id="T:safetyReqPb">
<table class="tdefn">
<tr>
<th>
Label
</th>
<td>
<p class="paragraph">
Safety Requirement-1
Safety Req-Pb
</p>
</td>
</tr>
Expand Down Expand Up @@ -1197,7 +1197,7 @@ <h3>
</th>
<td>
<p class="paragraph">
If <em>is_safe1</em>, the glass is considered safe. <em>is_safe1</em> and <em>is_safe2</em> (from <a href=#T:t2SafetyReq>T:t2SafetyReq</a>) are either both True or both False. <em>P<sub>b</sub></em> is the probability of breakage, as calculated in <a href=#T:probOfBr>T:probOfBr</a>. <em>P<sub>btol</sub></em> is the tolerable probability of breakage entered by the user.
If <em>is_safe1</em>, the glass is considered safe. <em>is_safe1</em> and <em>is_safe2</em> (from <a href=#T:safetyReqLR>T:safetyReqLR</a>) are either both True or both False. <em>P<sub>b</sub></em> is the probability of breakage, as calculated in <a href=#T:probOfBr>T:probOfBr</a>. <em>P<sub>btol</sub></em> is the tolerable probability of breakage entered by the user.
</p>
</td>
</tr>
Expand All @@ -1223,15 +1223,15 @@ <h3>
</tr>
</table>
</div>
<div id="T:t2SafetyReq">
<div id="T:safetyReqLR">
<table class="tdefn">
<tr>
<th>
Label
</th>
<td>
<p class="paragraph">
Safety Requirement-2
Safety Req-LR
</p>
</td>
</tr>
Expand Down Expand Up @@ -1271,7 +1271,7 @@ <h3>
</th>
<td>
<p class="paragraph">
If <em>is_safe2</em>, the glass is considered safe. <em>is_safe1</em> (from <a href=#T:t1SafetyReq>T:t1SafetyReq</a>) and <em>is_safe2</em> are either both True or both False. LR is the load resistance (also called capacity), as defined in <a href=#T:calOfCap>T:calOfCap</a>. <em>q</em> (also referred as the Demand) is the 3 second duration equivalent pressure, as defined in <a href=#T:calOfDe>T:calOfDe</a>.
If <em>is_safe2</em>, the glass is considered safe. <em>is_safe1</em> (from <a href=#T:safetyReqPb>T:safetyReqPb</a>) and <em>is_safe2</em> are either both True or both False. LR is the load resistance (also called capacity), as defined in <a href=#T:calOfCap>T:calOfCap</a>. <em>q</em> (also referred as the Demand) is the 3 second duration equivalent pressure, as defined in <a href=#T:calOfDe>T:calOfDe</a>.
</p>
</td>
</tr>
Expand Down Expand Up @@ -3159,7 +3159,7 @@ <h2>
<ul class="hide-list-style">
<li>
<div id="FR:functional.requirements.req5">
Check-Glass-Safety: If <em>is_safe1</em> ∧ <em>is_safe2</em> (from <a href=#T:t1SafetyReq>T:t1SafetyReq</a> and <a href=#T:t2SafetyReq>T:t2SafetyReq</a>) are true, output the message &quot;For the given input parameters, the glass is considered safe.&quot; If the condition is false, then output the message &quot;For the given input parameters, the glass is NOT considered safe.&quot;
Check-Glass-Safety: If <em>is_safe1</em> ∧ <em>is_safe2</em> (from <a href=#T:safetyReqPb>T:safetyReqPb</a> and <a href=#T:safetyReqLR>T:safetyReqLR</a>) are true, output the message &quot;For the given input parameters, the glass is considered safe.&quot; If the condition is false, then output the message &quot;For the given input parameters, the glass is NOT considered safe.&quot;
</div>
</li>
</ul>
Expand Down Expand Up @@ -3426,10 +3426,10 @@ <h1>

</th>
<th>
T1 (<a href=#T:t1SafetyReq>T:t1SafetyReq</a>)
T1 (<a href=#T:safetyReqPb>T:safetyReqPb</a>)
</th>
<th>
T2 (<a href=#T:t2SafetyReq>T:t2SafetyReq</a>)
T2 (<a href=#T:safetyReqLR>T:safetyReqLR</a>)
</th>
<th>
IM1 (<a href=#T:probOfBr>T:probOfBr</a>)
Expand Down Expand Up @@ -3467,7 +3467,7 @@ <h1>
</tr>
<tr>
<td>
T1 (<a href=#T:t1SafetyReq>T:t1SafetyReq</a>)
T1 (<a href=#T:safetyReqPb>T:safetyReqPb</a>)
</td>
<td>

Expand Down Expand Up @@ -3511,7 +3511,7 @@ <h1>
</tr>
<tr>
<td>
T2 (<a href=#T:t2SafetyReq>T:t2SafetyReq</a>)
T2 (<a href=#T:safetyReqLR>T:safetyReqLR</a>)
</td>
<td>
X
Expand Down Expand Up @@ -4049,10 +4049,10 @@ <h1>

</th>
<th>
T1 (<a href=#T:t1SafetyReq>T:t1SafetyReq</a>)
T1 (<a href=#T:safetyReqPb>T:safetyReqPb</a>)
</th>
<th>
T2 (<a href=#T:t2SafetyReq>T:t2SafetyReq</a>)
T2 (<a href=#T:safetyReqLR>T:safetyReqLR</a>)
</th>
<th>
IM1 (<a href=#T:probOfBr>T:probOfBr</a>)
Expand Down Expand Up @@ -4537,7 +4537,7 @@ <h1>
</tr>
<tr>
<td>
T1 (<a href=#T:t1SafetyReq>T:t1SafetyReq</a>)
T1 (<a href=#T:safetyReqPb>T:safetyReqPb</a>)
</td>
<td>

Expand Down Expand Up @@ -4566,7 +4566,7 @@ <h1>
</tr>
<tr>
<td>
T2 (<a href=#T:t2SafetyReq>T:t2SafetyReq</a>)
T2 (<a href=#T:safetyReqLR>T:safetyReqLR</a>)
</td>
<td>

Expand Down