OOBD

User Tools

Site Tools

Trace:
de:doc:rfc_onion

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
de:doc:rfc_onion [2014/09/25 22:05] – created wsauerde:doc:rfc_onion [2014/09/28 09:14] (current) – wsauer
Line 16: Line 16:
 Jeder Pfad beinhaltet einen Wert. Jeder Pfad beinhaltet einen Wert.
  
-Dieser Wert kann entweder ein Basistyp wie eine Zeichenfolge, ein Integer, boolscher Wert oder eine Fließkommazahl , eine Ansammlung von "Zwiebeln" oder einer (Sub) - "Zwiebelstruktur" sein. Eine "Zwiebelklasse" unterstützt methoden um die Werte zu erhalten, zu setzen und zu löschen.+Dieser Wert kann entweder ein Basistyp wie eine Zeichenfolge, ein Integer, boolscher Wert oder eine Fließkommazahl, eine Ansammlung von "Zwiebeln" oder einer (Sub)-"Zwiebelstruktur" sein. Eine "Zwiebelklasse" unterstützt Methoden um die Werte zu erhalten, zu setzen und zu löschen.
  
 +Weil der Wert dieses Pfads eine "Zwiebel" sein kann, kann der Pfad aufgeteilt werden in einen nach links zeigenden Pfad, welcher eine (Sub)-"Zwiebelstruktur" als Wert zurückgibt, wobei diese (Sub)-"Zwiebelstruktur" dann den verbleibenden (rechten) Teil des Pfades enthält.
  
-As the value of a path can be an Onion, a path can be splitted into a left leading part, which returns a (sub-)onion as value, where this sub onion then contains the remaining (right) part of the path.+Das bedeutet wenn man z. Bsp. "Dies/ist" von dem Pfad "Dies/ist/ein/möglicher/Pfad" wegnimmt, gibt dies eine "Zwiebelstruktur" zurück, welche selbst den Inhalt von "ein/Möglicher/Pfad" enthält. Dies wird benutzt, um sehr einfach Unterteile in eine "zwiebelstruktur" einzubinden oder aus Ihr auszulagern.
  
-This means taking e.g. "this/is" from the path "this/is/a/possible/path" returns an Onion, which contains itself the content of "a/possible/path". This is used to easily include and extract subparts in and out an Onion. 
  
- +===== Die Namenskonvention =====
-===== The Naming Convention =====+
    
-A part of such a path consist of the following characters [a-zA-Z0-9_-] and must start with a letter. Normal parts are written in lowercase, root parts (see below) in upper case. Collections, which are internally represent by a key/value hash array, are indexed by a leading "_", followed by an continious increased integer value, starting with 0. The number of included elements is an integer value, indexed by "_nr"+Ein Teil eines solchen Pfades, besteht aus den folgenden Zeichen [a-zA-Z0-9_-] und muss mit einem Buchstaben starten. Normale Teile werden in Kleinschreibweise geschrieben, Wurzelbereiche in Großschreibweise (siehe unten) geschrieben. Sammlungen die intern als Schlüssel/Wert eines Hasharrays dargestellt werden, sind indiziert mit einem führenden "_", gefolgt von einem kontinuierlich erhöhten Integerwert welcher mit 0 startet. Die Anzahl der eingebundenen Elemente ist ein Integerwert, indiziert mit "_nr"
  
-===== The Root Names ===== +===== Die Wurzelnamen =====
-  +
-As it is their indention, Onions can represent a wide range of possible datasets. These datasets are quite equal to what in C is called a struct, or record in Pascal: A structure of different static data, which may contain other sub- structs.+
  
 +Wie es ihre Absicht ist, vermögen "Zwiebeln" eine breite Palette von möglichen Datensätzen darzustellen.
 +Diese Datensätze ähneln dem was in C einen Struktur oder ein Datensatz in Pascal ist: Eine Struktur von verschiedenen statischen Daten, welche auch andere Sub-Strukturen enthalten können.
  
-Just to make the handling easier, the following convention must be used: 
  
-the name of that struct is used as the root part of the path, written in uppercase letters. As an example we use a date structure, first in C syntax:+Um nun die Handhabung einfacher zu machen, muss folgende Konvention beachtet werden: 
 + 
 +Der Name dieser Struktur wird als Wurzelteil des Pfades benutzt, in Großbuchstaben geschrieben. Als ein Beispiel, wie wir die Datenstruktur nutzen, betrachten wir zunächst die Implementation in C:
  
   struct date{   struct date{
Line 44: Line 44:
   }   }
  
-would be written in onion syntax+Dies würde in der "Zwiebel" Syntax folgendermassen geschrieben werden
  
   DATE/year = 2010   DATE/year = 2010
Line 51: Line 51:
   DATE/dayofweek = "Monday"   DATE/dayofweek = "Monday"
  
-===== The different Roots (datatypes) =====+===== Die verschiedenen Wurzeln (Datentypen) =====
    
  
-To guarantee a seamless cooperation between all different internal program modules, the following data structure definitions must be followed:+Um eine nahtlose Zusammenarbeit, zwischen all den verschiedenen internen Programmmodulen zu garantieren, muß folgenden Datenstrukturdefinitionen gefolgt werden:
  
 ==== ID ==== ==== ID ====
    
-The ID struct contains all data to identify a module in the system.+Die ID Struktur umfasst alle Daten, um ein Modul in einem System zu identifizieren.
  
-details to be defined+Details die definiert werden müssen
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-| name | String | | Id of the Module |+| name | Zeichenkette | | Id des Moduls |
  
 ==== CONFIG ==== ==== CONFIG ====
    
-The CONFIG struct is used to request the core to ask the user to config something +Die CONFIG Struktur wird benutzt, um den Kern in die Lage zu versetzen, den Nutzer etwas konfigurieren zu lassen 
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ + 
-| owner |  ID  | | Id of the sending Module | +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-| param |  Collection of PARAM  | | Parameter set |+| Eigentümer |  ID  | | Id des sendenden Moduls | 
 +| Parameter |  Kollektion von Parametern  | | setzen von Parametern |
  
 ====  PARAMSET ==== ====  PARAMSET ====
    
-The PARAMSET struct is used to tell a module to use the given set of parameters. This could be either the result of a CONFIG request or e.g. an initial configuration, read by the Core out of settings and sent to the modules during startup+Die PARAMSET Struktur wird benutzt, um dem Modul mitzuteilen, ein Set von gegebenen Parametern zu nutzen. Dies kann zum einen, daß Ergebnis einer CONFIG Anfrage oder einer Startkonfiguration sein, welche durch den Kern aus den Einstellungen gelesen wird und zu den Modulen während der Hochlaufphase gesendet wird.
  
-^  Name ^ Type ^ opt. ^ Meaning ^ +^  Name ^ Typ ^ opt. ^ Bedeutung ^ 
-| owner |  ID  | | Id of the receiving Module +| Eigentümer |  ID  | | Id des empfangenden Moduls 
-| param |  Collection of PARAM  | | Parameter set |+| Parameter |  Kollektion von Parametern  | | setzen von Parametern |
  
 ==== PARAM ==== ==== PARAM ====
    
-The PARAM struct is used to transfer configuration data. The optional data helps to define the user interface for the configuration window and is not needed when some configuration data is send to a module.+Die PARAM Struktur wird benutzt, um Konfigurationsdaten zu transferieren. Die optionellen Daten helfen die Nutzerschnittstelle für das Konfigurationsfenster zu definieren. Sie wird nicht gebraucht, wenn einige Konfigurationsdaten zu einem Modul gesendet werden.
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-|  name  |  string  |   |  Name of that parameter  | +|  name  |  Zeichenkette  |   |  Name dieses Parameters  | 
-|  type  |  string  |  x  | f=float, i = integer , s = string , sf = filename , c = combobox , radiobutton = like a combobox, but with a different presentation, cm = combobox with multiple selection, b = boolean (checkbox), a = alert | +|  typ  |  Zeichenkette  |  x  | f=Fließkommazahl, i = Integer , s = Zeichenkette , sf = Dateiname , c = Combobox , radiobutton = Wie eine Combobox, aber mit einer anderen Präsentation, cm = Combobox mit Mehrfachauswahl, b = Boolscher Wert (checkbox), a = Alarm | 
-|  actValue  |  base type  |  | representation of the actual value(s), seperated by ; in case of a multiselect element  | +|  actValue  |  base type  |  | Repräsentation des aktuellen Werte(s), unterteilt durch ; im Fall eines Mehrfachauswahlelements  | 
-|  loRange  |  base Type  |  x  | lowest value of the allowed range. For comboboxes, this field contains the possible selections, seperated by %%|%%. For strings this field might include a RegEx, which describes the allowed result. For alerts, this may contain the answer button texts, seperated by %%|%%. | +|  loRange  |  base Type  |  x  | niedrigster Wert eines erlaubten Bereiches. Für Comboboxen, enthält dieses Feld die mögliche Auswahl, getrennt durch %%|%%. Für Zeichenketten kann dieses einen RegEx enthalten, welcher das erlaubte Ergebis beschreibt. Für Alarme, kann dies die Texte der Antwortknöpfe enthalten, getrennt durch %%|%%. | 
-|  upRange  |  base type  |  x  | highest value of the allowed range  | +|  upRange  |  Basistyp  |  x  | höchster Wert eines erlaubten Bereiches  | 
-|  tooltip  |  String  |  x  | some additional text which might give the user some help for this parameter  | +|  tooltip  |  Zeichenkette  |  x  | zusätzlicher Text welcher dem Nutzer einen Hinweis oder Hilfe für diesen Parameter gibt  | 
-|  fileexist  |  Boolean  |  x  | in case type=fn for FileSelectDialogs: The file must already exist for opening a File  |+|  fileexist  |  Boolscher Wert |  x  | Im Fall das typ=fn für FileSelectDialogs: Die Datei muss schon existieren, um sie öffnen zu können  |
  
 ==== VALUE ==== ==== VALUE ====
    
-The VALUE struct contains a value to show+Die VALUE Struktur enthält einen Anzeigewert
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-|  sender  |  ID  |   | sender of this value  | +|  Sender  |  ID  |   | Sender dieses Wertes  | 
-|  to  |  ID  |   | receiver of this value  | +|  to  |  ID  |   | Empfänger dieses Wertes  | 
-|  type  |  string  |   | f=float, i = integer , s = string , c = combobox , radiobutton = like a combobox, but with a different presentation, cm = combobox with multiple selection, b = boolean (checkbox)  | +|  typ  |  Zeichenkette  |   | f=Fließkommazahl, i = Integer , s = Zeichenkette , c = Combobox , Radiobutton = wie eine Combobox, aber mit einer anderen Präsentation, cm = Combobox mit einer Mehrfachauswahl, b = Boolscher Wert (Checkbox)  | 
-|  rawValue  |  base type  |   | representation of the actual value(s), seperated by ; in case of a multiselect element  | +|  rawValue  |  Basistyp  |   | Repräsentation der(s) aktuellen Werte(s), unterteilt durch ; Im Fall eines Mehrfachauswahlelements  | 
-|  Unit  |  String  |    | Unit of the value  | +|  Unit  |  Zeichenkette  |    | Einheit des Wertes  | 
-|   ValueString  |  String  |  | string representation of the value + unit  | +|   ValueString  |  Zeichenkette  |  | Zeichenkettendarstellung des Wertes  + Einheit  | 
-|  loRange  |  base Type  |  x  | lowest value of the allowed range. For comboboxes, this field contains the possible selections, seperated by %%|%%. For strings this field might include a RegEx, which describes the allowed result  | +|  loRange  |  Basistyp  |  x  | Niedrigster Wert eines erlaubten Bereiches. Für Comboboxen, enthält dieses Feld die Auswahlmöglichkeiten, getrennt mit %%|%%. Für Zeichenketten kann dieses einen RegEx enthalten, welcher das erlaubte Ergebis beschreibt  | 
-|   upRange  |  base type  |  x  | highest value of the allowed range  | +|   upRange  |  Basistyp  |  x  | Höchster Wert eines erlaubten Bereiches  | 
-|  step  |  base type  |  x  | step rate in which the value can be changed (e.g. for slider boxes) |+|  step  |  Basistyp  |  x  | Schrittweite in der der Wert geändert werden kann (z.Bsp. für Boxen mit Schieber) |
  
 ==== PAGE ==== ==== PAGE ====
    
-The PAGE struct is used to request the UI to create a "landing surface" to place some visualizers onto. +Die PAGE Struktur wird benutzt, um vom UI (Userinterface) eine "Landefläche" zu erzeugen, auf der dann die Visualisierer plaziert werden. 
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-|  owner  |  ID  |   | Id of the sending Module | +|  Eigentümer  |  ID  |   | Id des sendenden Moduls | 
-|  name  |  String  | | title of the requested page |+|  name  |  Zeichenkette  | | Titel der angeforderten Seite (Landefäche) |
  
 ==== PAGEDONE ==== ==== PAGEDONE ====
    
-The PAGEDONE struct is used to tell the UI that the placement of the visualizers is done. +Die PAGEDONE Struktur wird benutzt, um dem UI mitzuteilen, daß das Plazieren der Visualisierer abgeschlossen ist. 
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-|  owner  |  ID  |  | Id of the sending Module |+|  Eigentümer  |  ID  |  | Id des sendenden Moduls |
  
 ==== UPDATE ==== ==== UPDATE ====
    
-The UPDATE struct tells the owner of a visualizer that the user has requested an update by e.g. pressing a button or do a double click on an value +Die UPDATE Struktur teilt dem Eigentümer eines Visualisierers mit, daß der Nutzer eine Aktualisierung angefragt hat, z. Bsp. mit dem Drücken eines Knopfes oder dem Doppelklick auf einen Wert 
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-|  vis  |  ID  |  | Id of the sending visualizer | +|  vis  |  ID  |  | Id des sendenden Visualisierers | 
-|  to  |  ID  |   | name of the owner of the visualizer | +|  to  |  ID  |   | Name vom Eigentümer des Visualisierers | 
-|  actValue  |  String  | | actual shown value| +|  actValue  |  Zeichenkette  | | aktuell angezeigter Wert| 
-|  updType  |  int  |  | type of the update (like request came from user or it is a periodic update)| +|  updType  |  int  |  | Aktualisierungstyp (wie eine Anforderung die vom Nutzer kam oder eine periodische Aktualisierung)| 
-|  optid  |  String  |  X  | optional ID as add. identification, if needed |+|  optid  |  Zeichenkette  |  X  | optionale ID als zusätzliche Identifikation, falls benötigt |
  
 ==== UPDEVENT ==== ==== UPDEVENT ====
    
-The UPDEVENT tells the visualizer which events are allowed to send an update request. If not set, the visualizer sends only an update request on manual user request. UPDEVENT is a set of events, which are seperated by |+Die UPDEVENT Struktur teilt dem Visualisierer mit, welchen Ereignissen es erlaubt ist, eine Aktualisierung auszulösen. Falls es nicht gesetzt ist, erfährt der Visualisierer nur eine Aktualisierung, wenn dies durch den Nutzer manuell initiert wurde. UPDEVENT ist ein Set von Ereignissen, welche unterteilt sind durch |
  
-^  Event  ^  Meaning  ^ +^  Ereignis  ^  Bedeutung  ^ 
-|  UPDATE  | the update request is send when the user request a global list update| +|  UPDATE  | Die Aktualisierungsanfrage wird ausgelöst, wenn der Nutzer eine globale Listenaktualisierung anfragt| 
-|  TIMER   | the update request is send in an interval if the global timer is active |+|  TIMER   | Die Aktualisierungsanfrage wird in einem Intervall ausgelöst, in dem der globale Zeitgeber aktiv ist |
  
 ==== VISUALIZE ==== ==== VISUALIZE ====
    
-The VISUALIZE struct is used to request the UI to create a visualizer. It then up to the implementation of this visualizer to add that visualization to an already existing visualizer (in a listview for example) or to create a new object (as for a button)+Die VISUALIZE Struktur wird benutzt, um vom UI das Erzeugen eines Visualisierers zu initiieren. Es ist dann von der Imlementierung abhängig, einen bereits existierenden Visualisierer (Listenansicht) hinzuzufügen oder ein neues Objekt( z.Bsp ein Knopf) zu erzeugen
  
-^  Name  ^  Type  ^  opt.  ^ Meaning  ^ +^  Name  ^  Typ  ^  opt.  ^ Bedeutung  ^ 
-|  owner  |  ID  | | Id of the sending Module | +|  Eigentümer  |  ID  | | Id des sendenden Moduls | 
-|  name  |  String  | | name of the requested visualizer | +|  name  |  Zeichenkette  | | Name des angeforderten Visualisierers | 
-|  type  |  String  | | type of the requested visualizer | +|  type  |  Zeichenkette  | | Typ des angeforderten Visualisierers | 
-|  theme |  String  |   x   | name of the theme to be used, if different from default theme | +|  theme |  Zeichenkette  |   x   | Name des Motivs welches benutzt werden soll, falls es nicht mit dem Standartmotiv übereinstimmt | 
-|  canvas  |  String  |   | name of the canvas, on which that visualizer should appear | +|  canvas  |  Zeichenkette  |   | Name der Flächen auf denen der Visualisierer erscheinen sollte | 
-|  value  |  VALUE  | | initial value | +|  value  |  VALUE  | | Startwert | 
-|  tooltip  |  String  | | some additional text which might gives some information about this value | +|  tooltip  |  Zeichenkette  | | zusätzlicher Text, der eine Information über diesen Wert transportiert | 
-|  updevent  |  UPDEVENT  |   x   | allowed update events of this visualizer  | +|  updevent  |  UPDEVENT  |   x   | erlaubte Aktualisierungsereignisse für den Visualisierer  | 
-|  optid  |  String  |   x   | optional ID as add. identification, if needed |+|  optid  |  Zeichenkette  |   x   | optionale ID als zusätzliche Identifikation, falls benötigt |
  
de/doc/rfc_onion.1411675523.txt.gz · Last modified: 2014/09/25 22:05 by wsauer