Skip to content

Commit

Permalink
Sentence-based lines, and break one long line.
Browse files Browse the repository at this point in the history
  • Loading branch information
HansOlsson committed Sep 2, 2022
1 parent 21ae0aa commit adc0d48
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions chapters/annotations.tex
Expand Up @@ -2031,10 +2031,13 @@ \subsection{Protection of Classes}\label{protection-of-classes}
of the class).
\item
\lstinline!Access.icon!\\
The class can be instantiated and public parameter, constant, input, output variables as well as public connectors can be accessed, as well as the \lstinline!Icon! annotation, as defined in \cref{annotations-for-graphical-objects} (the declared information of these elements can be shown). Additionally, the class name and its description text can be accessed.
The class can be instantiated and public parameter, constant, input, output variables as well as public connectors can be accessed, as well as the \lstinline!Icon! annotation, as defined in \cref{annotations-for-graphical-objects} (the declared information of these elements can be shown).
Additionally, the class name and its description text can be accessed.
\item
\lstinline!Access.documentation!\\
Same as \lstinline!Access.icon! and additionally the \lstinline!Documentation! annotation (as defined in \cref{annotations-for-documentation}) can be accessed. HTML-generation in the \lstinline!Documentation! annotation is normally performed before encryption, but the generated HTML is intended to be used with the encrypted package. Thus the HTML-generation should use the same access as the encrypted version -- even before encryption.
Same as \lstinline!Access.icon! and additionally the \lstinline!Documentation! annotation (as defined in \cref{annotations-for-documentation}) can be accessed.
HTML-generation in the \lstinline!Documentation! annotation is normally performed before encryption, but the generated HTML is intended to be used with the encrypted package.
Thus the HTML-generation should use the same access as the encrypted version -- even before encryption.
\item
\lstinline!Access.diagram!\\
Same as \lstinline!Access.documentation! and additionally, the \lstinline!Diagram! annotation, and all components and \lstinline!connect!-equations that have a graphical annotation can be accessed.
Expand All @@ -2052,24 +2055,21 @@ \subsection{Protection of Classes}\label{protection-of-classes}
Same as \lstinline!Access.packageText! and additionally the class, or part of the class, can be copied.
\end{enumerate}

The \lstinline!access! annotation holds for the respective class and all classes
that are hierarchically on a lower level, unless overridden by a
\lstinline!Protection! annotation with \lstinline!access!.
Overriding \lstinline!access=Access.hide! or \lstinline!access=Access.packageDuplicate!
has no effect.
The \lstinline!access! annotation holds for the respective class and all classes that are hierarchically on a lower level, unless overridden by a \lstinline!Protection! annotation with \lstinline!access!.
Overriding \lstinline!access=Access.hide! or \lstinline!access=Access.packageDuplicate! has no effect.

\begin{example}
If the annotation is given on the top level of a package and at no other class in this package, then the \lstinline!access! annotation holds for all classes in this package.
\end{example}

\begin{nonnormative}
It is currently not standardized which result variables are
accessible for plotting. It seems natural to not introduce new flags for
this, but reuse the \lstinline!Access.XXX! definition, e.g., for \lstinline!Access.icon!
only the variables can be stored in a result file that can also be
inspected in the class, and for \lstinline!Access.nonPackageText! all public
and protected variables can be stored in a result file, because all
variables can be inspected in the class.
It is currently not standardized which result variables are accessible for plotting.
It seems natural to not introduce new flags for this, but reuse the \lstinline!Access.XXX! definition.
For instance:
\begin{itemize}
\item For \lstinline!Access.icon! only the variables can be stored in a result file that can also be inspected in the class.
\item For \lstinline!Access.nonPackageText! all public and protected variables can be stored in a result file, because all variables can be inspected in the class.
\end{itemize}

Classes should not use other classes in ways that contradict this protection.
For instance a class with \lstinline!Access.hide! should not be used in the diagram layer of a class with \lstinline!Access.diagram!, and there should not be hyperlinks to classes with \lstinline!Access.icon! (from classes with visible documentation).
Expand Down

0 comments on commit adc0d48

Please sign in to comment.