packageAnnotations

Auto completion information on annotations.

Information

In this package annotations are gathered in their record-like form together with meta information such as descriptions, units, min, max, etc.

Components

TypeNameDefaultDescription
StringpreferredView"diagram"Default view when selecting the class (<b>info</b>, <b>diagram</b> or <b>text</b>).
BooleanDocumentationClasstrueImplies that this class and all classes within it are treated as having the annotation <b>preferredView="info"</b>. If the annotation <b>preferredView</b> is explicitly set for a class, it has precedence over a <b>DocumentationClass</b> annotation.
BooleanEvaluatetrueDefines if the value can be utilize for symbolic processing.
BooleanHideResulttrueProposes to not show the simulator results.
BooleanInlinetrueProposes to inline the function which means the body of the function is included at all places where the function is called.
BooleanLateInlinetrueProposes to inline the function after all symbolic transformations have been performed.
BooleanGenerateEventstrueproposes that crossing functions in the function should generate events.
IntegersmoothOrderDefines the number of differentiations of the function, in order that all of the differentiated outputs are continuous provided all input arguments and their derivatives up to order <b>smoothOrder</b> are continuous.
BooleansingleInstancetrueIndicates that there should only be one component instance of the class.
StringdefaultComponentNameRecommended name when creating a component of the class.
StringdefaultComponentPrefixesRecommended prefixes when creating a component of the class.
StringmissingInnerMessageSpecifies a message when an <b>outer</b> component of the class does not have a corresponding <b>inner</b> component.
BooleanabsoluteValueIf <b>false</b>, then the variable defines a relative quantity, and if <b>true</b> an absolute quantity.
BooleandefaultConnectionStructurallyInconsistentIf <b>true</b>, it is stated that a default connection will result in a structurally inconsistent model or block.
StringobsoleteIndicates that the class ideally should not be used anymore and gives a message indicating the recommended action.
StringunassignedMessageDefines a diagnostic message to use when a variable declaration cannot be computed due to the structure of the equations.
StringversionThe version number of the released library.
StringversionDateThe date in UTC format (according to ISO 8601) when the library was released.
IntegerversionBuildThe optional build number of the library.
StringdateModifiedThe UTC date and time (according to ISO 8601) of the last modification of the package.
StringrevisionIdA tool specific revision identifier possibly generated by a source code management system (e.g. Subversion or CVS).
BooleanchoicesAllMatchingSpecify whether to construct an automatic list of choices menu or not.
String__OpenModelica_commandLineOptionsannotation(__OpenModelica_commandLineOptions = "--matchingAlgorithm=BFSB --indexReductionMethod=dynamicStateSelection");

Contents

NameDescription
DocumentationDefines the documentation.
experimentDefine default experiment parameters.
Dialog
Selector
usesA list of dependent classes.
Access
ProtectionProtection of class
Authorization
License
inverse
choicesDefines a suitable redeclaration or modifications of the element.
derivative
__OpenModelica_simulationFlagsannotation(__OpenModelica_simulationFlags(s = "ida", cpu = "()"));