User Tools

Site Tools


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
Last revisionBoth sides next revision
de:doc:rfc_onion [2014/09/25 22:05] – created wsauerde:doc:rfc_onion [2014/09/27 21:50] 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 Oniona 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ückwelche 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 letterNormal parts are written in lowercaseroot parts (see belowin upper caseCollections, which are internally represent by a key/value hash arrayare indexed by a leading "_", followed by an continious increased integer value, starting with 0. The number of included elements is an integer valueindexed by "_nr"+Ein Teil eines solchen Pfades besteht aus den folgenden Zeichen [a-zA-Z0-9_-] und muss mit einem Buchstaben startenNormale Teile werden in Kleinschreibweise geschriebenWurzelbereiche in Großschreibweise (siehe untengeschriebenSammlungen die intern als Schlüssel/Wert eines Hasharrays dargestellt werdensind indiziert mit einem führenden "_", gefolgt von einem kontinuierlich erhöhten Integerwert welcher mit startetDie Anzahl der eingebundenen Elemente ist ein Integerwertindiziert 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 sind ziemlich gleich zu dem was in C einen Struktur ist oder ein Datensatz in Pascal: 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 pathwritten in uppercase lettersAs 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 as Wurzelteil des Pfades benutzt, in Großbuchstaben geschriebenAls 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+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 modulesthe following data structure definitions must be followed:+Um eine nahtlose Zusammenarbeit zwischen all den verschiedenen internen Programmmodulen zu garantierenmüssen folgende 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 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 parametersThis could be either the result of a CONFIG request or e.g. an initial configurationread 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 nutzenDies kann zum einen das Ergebnis einer CONFIG Anfrage oder einer Startkonfiguration seinwelche 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 dataThe 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 transferierenDie optionellen Daten helfen die Nutzerschnittstelle für das Konfigurationsfenster zu definieren. Es 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 rangeFor comboboxesthis field contains the possible selectionsseperated by %%|%%. For strings this field might include a RegEx, which describes the allowed resultFor alertsthis may contain the answer button textsseperated by %%|%%. | +|  loRange  |  base Type  |  x  | niedrigster Wert eines erlaubten BereichesFür comboboxenenthält dieses Feld die mögliche Auswahlgetrennt durch %%|%%. Für Zeichenketten kann dieses einen RegEx enthaltenwelcher das erlaubte Ergebis beschreibtFür Alarmekann dies die Texte der Antwortknöpfe enthaltengetrennt 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 diese Datei ö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  |  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  |
 |   upRange  |  base type  |  x  | highest value of the allowed range  | |   upRange  |  base type  |  x  | highest value of the allowed range  |
de/doc/rfc_onion.txt · Last modified: 2014/09/28 09:14 by wsauer