Modelica.Icons

Information

This package contains definitions for the graphical layout of components which may be used in different libraries. The icons can be utilized by inheriting them in the desired class using "extends" or by directly copying the "icon" layer.

Main Authors:

Martin Otter

Deutsches Zentrum fuer Luft und Raumfahrt e.V. (DLR)

Oberpfaffenhofen

Postfach 1116

D-82230 Wessling

email: Martin.Otter@dlr.de

Christian Kral

Austrian Institute of Technology, AIT

Mobility Department

Giefinggasse 2

1210 Vienna, Austria

email: christian.kral@ait.ac.at

Johan Andreasson

Modelon AB

Ideon Science Park

22370 Lund, Sweden

email: johan.andreasson@modelon.se

Copyright © 1998-2010, Modelica Association, DLR, AIT, and Modelon AB.

This Modelica package is free software; it can be redistributed and/or modified under the terms of the Modelica license, see the license conditions and the accompanying disclaimer in Modelica.UsersGuide.ModelicaLicense2.

Extends from Icons.Package (Icon for standard packages).

Package Content

Name	Description
Information	Icon for general information packages
Contact	Icon for contact information
ReleaseNotes	Icon for release notes in documentation
References	Icon for external references
ExamplesPackage	Icon for packages containing runnable examples
Example	Icon for runnable examples
Package	Icon for standard packages
BasesPackage	Icon for packages containing base classes
VariantsPackage	Icon for package containing variants
InterfacesPackage	Icon for packages containing interfaces
SourcesPackage	Icon for packages containing sources
SensorsPackage	Icon for packages containing sensors
RotationalSensor	Icon representing a round measurement device
TranslationalSensor	Icon representing a linear measurement device
MaterialPropertiesPackage	Icon for package containing property classes
MaterialProperty	Icon for property classes
Function	Icon for functions
Record	Icon for records
TypeComplex	Icon for Complex types
TypeReal	Icon for Real types
TypeInteger	Icon for Integer types
TypeBoolean	Icon for Boolean types
TypeString	Icon for String types
SignalBus	Icon for signal bus
SignalSubBus	Icon for signal sub-bus
UnderConstruction
ObsoleteModel	Icon for classes that are obsolete and will be removed in later versions
Library	This icon will be removed in future Modelica versions, use Package instead
Library2	This icon will be removed in future Modelica versions, use Package instead
GearIcon	This icon will be removed in future Modelica versions
MotorIcon	This icon will be removed in future Modelica versions.
Info	Icon for general information packages

Types and constants

  type TypeReal "Icon for Real types"
      extends Real;
  end TypeReal;

  type TypeInteger "Icon for Integer types"
      extends Integer;
  end TypeInteger;

  type TypeBoolean "Icon for Boolean types"
      extends Boolean;
  end TypeBoolean;

  type TypeString "Icon for String types"
      extends String;
  end TypeString;

Modelica.Icons.Information

Information

This icon indicate classes containing only documentation, intended for general description of e.g., concepts and features of a package.

Modelica definition

partial class Information "Icon for general information packages"

end Information;

Modelica.Icons.Contact

Information

This icon shall be used for the contact information of the library developers.

Modelica definition

partial class Contact "Icon for contact information"

end Contact;

Modelica.Icons.ReleaseNotes

Information

This icon indicates release notes and the revision history of a library.

Modelica definition

partial class ReleaseNotes "Icon for release notes in documentation"

end ReleaseNotes;

Modelica.Icons.References

Information

This icon indicates a documentation class containing references external documentation and litterature.

Modelica definition

partial class References "Icon for external references"


end References;

Modelica.Icons.Example

Information

This icon indicates an example. The play button suggests that the example can be executed.

Modelica definition

partial model Example "Icon for runnable examples"

end Example;

Modelica.Icons.RotationalSensor

Information

This icon is designed for a rotational sensor model.

Modelica definition

partial class RotationalSensor 
  "Icon representing a round measurement device"

end RotationalSensor;

Modelica.Icons.TranslationalSensor

Information

This icon is designed for a translational sensor model.

Modelica definition

partial class TranslationalSensor 
  "Icon representing a linear measurement device"

end TranslationalSensor;

Modelica.Icons.MaterialProperty

Information

This icon indicates a property class.

Modelica definition

partial class MaterialProperty "Icon for property classes"

end MaterialProperty;

Modelica.Icons.Function

Information

This icon indicates Modelica functions.

Modelica definition

partial function Function "Icon for functions"

end Function;

Modelica.Icons.Record

Information

This icon is indicates a record.

Modelica definition

partial record Record "Icon for records"

end Record;

Modelica.Icons.TypeComplex

Information

This icon is designed for a Complex type.

Extends from Complex (Complex number with overloaded operators).

Parameters

Type	Name	Default	Description
Real	re		Real part of complex number
Real	im		Imaginary part of complex number

Modelica definition

record TypeComplex "Icon for Complex types"
  extends Complex;
end TypeComplex;

Modelica.Icons.SignalBus

Information

Modelica definition

connector SignalBus "Icon for signal bus"

end SignalBus;

Modelica.Icons.SignalSubBus

Information

This icon is designed for a sub-bus in a signal connector.

Modelica definition

connector SignalSubBus "Icon for signal sub-bus"


end SignalSubBus;

Modelica.Icons.UnderConstruction

Information

Library developers can use this icon to indicate that the respective model is under construction.

Modelica definition

partial class UnderConstruction

end UnderConstruction;

Modelica.Icons.ObsoleteModel

Information

This partial class is intended to provide a default icon for an obsolete model that will be removed from the corresponding library in a future release.

Modelica definition

partial class ObsoleteModel 
  "Icon for classes that are obsolete and will be removed in later versions"

end ObsoleteModel;

Modelica.Icons.GearIcon

Information

This icon of a gearbox will be removed in future versions of the library. Please use one of the icons of Mechanics.Rotational.Icons instead.

Modelica definition

partial class GearIcon 
  "This icon will be removed in future Modelica versions"

end GearIcon;

Modelica.Icons.MotorIcon

Information

This icon of an electrical motor model will be removed in future versions of the library. Please use a locally defined icon in your user defined libraries and applications.

Modelica definition

partial class MotorIcon 
  "This icon will be removed in future Modelica versions."

end MotorIcon;

Modelica.Icons.Info

Information

This icon indicate classes containing only documentation, intended for general description of e.g., concepts and features of a package.

Note

This icon will be removed in future versions of the Modelica Standard Library. Instead the icon Information shall be used.

Modelica definition

partial class Info "Icon for general information packages"

end Info;