Name
Parameter
Syntax
Parameter
Wertebereiche
ErläuterungLokale Parameter (siehe Hintergrund) werden in der Parameterliste eines Objektes deklariert. Zu Beginn eines Skriptdurchlaufes haben diese, im Gegensatz zu den Variablen einen in der Liste festgelegten Wert und eine feste Typenzuordnung. Sie machen die GDL-Objekte so interessant, da sie es ermöglichen auf individuelle Einstellmöglichkeiten des Anwenders im Skript zu reagieren. Durch diese Parameter sind Objekte nicht "so wie sie sind", sondern vom Zeichner einstellbar.
In der Parameterliste wird neben Art und Namen des Parameters ein beschreibender Kurztext, neben dem im Einstellungsdialog der Wert dieses Parameters abgefragt wird, der Typ und Position und Sichtbarkeit des Parameters innerhalb der Liste festgelegt. Die Verfügbarkeit eines Parameters kann auch skriptgesteuert sein. Siehe Befehle unter Parameterskript.
Die lokalen Parameter können zusätzlich zu ihrer Auflistung unter "Parameter" im Einstellungsdialog über Eingabefelder des User Interces abgefragt werden.
In der Parameterliste wird neben Art und Namen des Parameters ein beschreibender Kurztext, neben dem im Einstellungsdialog der Wert dieses Parameters abgefragt wird, der Typ und Position und Sichtbarkeit des Parameters innerhalb der Liste festgelegt. Die Verfügbarkeit eines Parameters kann auch skriptgesteuert sein. Siehe Befehle unter Parameterskript.
Die lokalen Parameter können zusätzlich zu ihrer Auflistung unter "Parameter" im Einstellungsdialog über Eingabefelder des User Interces abgefragt werden.
Beispiel ErläuterungAls PARAMETER bezeichnen wir Platzhalter, die nicht während des Skriptablaufes, sondern entweder global oder lokal (=innerhalb des Objektes) zur Verfügung gestellt werden. Es gibt mehrere grundsätzliche Typen von Parametern:
1. Globale Parameter.
Sie beziehen ihre Werte aus dem Zustand des Projektes oder den Zeichnungselementen, mit denen das Objekt verbunden ist. Ihr Name ist festgelegt. Sie können vom Anwender nicht selbst definiert werden. Z.B.:
GLOB_SCALE
WALL_THICKNESS
2. Optionale Parameter.
Eingeführt mit ArchiCAD 8 und dem System der "Subtypes" von Objekten, stehen je nach Subtyp des Objektes Parameter mit ebenfalls festen Namen und Typen zur Verfügung, die Informationen über den Kontext des Objektes (z.B. der Wand für ein Fenster, oder das Fenster für einen Fenstermarker) bereitstellen. Diese Parameter tauchen in der Parameterliste des Objektes als unveränderbar auf und beginnen meist mit "ac_". Z.B. ac_left_oversize oder AC_show2DhotspotsIn3D. Dabei gibt es 2 unterschiedliche Arten: Parameter die dem Objekt Informationen liefern und Parameter, die nicht nur Informationen erhalten, sondern auch dem übergeordneten Element Informationen liefern. Dies ist in der Dokumentation der Umgebungsparameter mit READ und WRITE gekennzeichnet.
Für Schnittstellen, z.B. zu ArchiFM gibt es weitere optionale Parameter, die z.B. mit "FM_" beginnen. Sie regeln den Informationsfluß zu ArchiFM und nicht von dem Facility Management-Programm zu ArchiCAD®. Z.B. FM_Type
3. Lokale Parameter - Standardisiert
Ähnlich wie die optionalen Parameter werden ab ArchiCAD 8, abhängig vom Subtyp, unveränderbare Parameter in der Parameterliste eines Objektes angelegt, die sich nur auf die lokalen Einstellungen eines Objektes beziehen. Sie dienen der Vereinheitlichung von Parameter-/Variablennamen. Dadurch wird eine Übergabe von Einstellungswerten zwischen Objekten mittels Pipette und Spritze im Einstellungsdialog eines Objektes (ab ArchiCAD 9) ermöglicht. Diese automatischen Parameter beginnen i.d.R. mit "gs_". Z.B. gs_cont_pen
4. Lokale Parameter - Frei
Die freien Parameter sind nun ganz individuelle Parameter, die das Herzstück der GDL-Objekte ausmachen. Mittels dieser Parameter lassen sich die Objekte nach Wunsch einstellen. Die Namenswahl ist frei, wie bei den Variablen. Sie sind die Objekt-individuellen "Einstellschrauben" und nur zur lokalen Verwendung innerhalb dieses Objektes gedacht.
Die Parameter der Typen 2 und 3 sind eng mit den in ArchiCAD 8 eingeführten Subtypen verknüpft. Das Prinzip der erweiterten Parameterliste war zwar zuvor auch bekannt (Raumstempel), ist hier aber verallgemeinert und vom Nutzer erweiterbar geworden. Die Vielzahl der verfügbaren Parameter zu erläutern sprengt leider den Rahmen dieses Kompendiums. Zumal eine solche Dokumentation (leider nur in Englisch) in der "Basic Library" bereits vorliegt. Download siehe Links. Die entpackte Bibliothek enthält eine HTML-Dokumentation, die alle Standardparameter in Wort und Bild erläutert. Es ist ratsam diese zu archivieren, da stets nur die zur aktuellen ArchiCAD-Version passende Bibliothek zum Herunterladen bereitsteht.
Da die Parameter der Typen 2-4 in der Parameterliste eines Objektes angelegt werden, sind sie, wenn nicht durch HIDEPARAMETER oder Ausschalten in der Liste (Kreuz) deaktiviert, im Einstellungsdialog eines Objektes unter "Parameter" sichtbar.
Unter dem Befehl PARAMETERS ist im Bereich "Hintergrund" ein Erklärungsmodell zur Verwendung und dem Verhalten von Parametern in Skripten erläutert.
1. Globale Parameter.
Sie beziehen ihre Werte aus dem Zustand des Projektes oder den Zeichnungselementen, mit denen das Objekt verbunden ist. Ihr Name ist festgelegt. Sie können vom Anwender nicht selbst definiert werden. Z.B.:
GLOB_SCALE
WALL_THICKNESS
2. Optionale Parameter.
Eingeführt mit ArchiCAD 8 und dem System der "Subtypes" von Objekten, stehen je nach Subtyp des Objektes Parameter mit ebenfalls festen Namen und Typen zur Verfügung, die Informationen über den Kontext des Objektes (z.B. der Wand für ein Fenster, oder das Fenster für einen Fenstermarker) bereitstellen. Diese Parameter tauchen in der Parameterliste des Objektes als unveränderbar auf und beginnen meist mit "ac_". Z.B. ac_left_oversize oder AC_show2DhotspotsIn3D. Dabei gibt es 2 unterschiedliche Arten: Parameter die dem Objekt Informationen liefern und Parameter, die nicht nur Informationen erhalten, sondern auch dem übergeordneten Element Informationen liefern. Dies ist in der Dokumentation der Umgebungsparameter mit READ und WRITE gekennzeichnet.
Für Schnittstellen, z.B. zu ArchiFM gibt es weitere optionale Parameter, die z.B. mit "FM_" beginnen. Sie regeln den Informationsfluß zu ArchiFM und nicht von dem Facility Management-Programm zu ArchiCAD®. Z.B. FM_Type
3. Lokale Parameter - Standardisiert
Ähnlich wie die optionalen Parameter werden ab ArchiCAD 8, abhängig vom Subtyp, unveränderbare Parameter in der Parameterliste eines Objektes angelegt, die sich nur auf die lokalen Einstellungen eines Objektes beziehen. Sie dienen der Vereinheitlichung von Parameter-/Variablennamen. Dadurch wird eine Übergabe von Einstellungswerten zwischen Objekten mittels Pipette und Spritze im Einstellungsdialog eines Objektes (ab ArchiCAD 9) ermöglicht. Diese automatischen Parameter beginnen i.d.R. mit "gs_". Z.B. gs_cont_pen
4. Lokale Parameter - Frei
Die freien Parameter sind nun ganz individuelle Parameter, die das Herzstück der GDL-Objekte ausmachen. Mittels dieser Parameter lassen sich die Objekte nach Wunsch einstellen. Die Namenswahl ist frei, wie bei den Variablen. Sie sind die Objekt-individuellen "Einstellschrauben" und nur zur lokalen Verwendung innerhalb dieses Objektes gedacht.
Die Parameter der Typen 2 und 3 sind eng mit den in ArchiCAD 8 eingeführten Subtypen verknüpft. Das Prinzip der erweiterten Parameterliste war zwar zuvor auch bekannt (Raumstempel), ist hier aber verallgemeinert und vom Nutzer erweiterbar geworden. Die Vielzahl der verfügbaren Parameter zu erläutern sprengt leider den Rahmen dieses Kompendiums. Zumal eine solche Dokumentation (leider nur in Englisch) in der "Basic Library" bereits vorliegt. Download siehe Links. Die entpackte Bibliothek enthält eine HTML-Dokumentation, die alle Standardparameter in Wort und Bild erläutert. Es ist ratsam diese zu archivieren, da stets nur die zur aktuellen ArchiCAD-Version passende Bibliothek zum Herunterladen bereitsteht.
Da die Parameter der Typen 2-4 in der Parameterliste eines Objektes angelegt werden, sind sie, wenn nicht durch HIDEPARAMETER oder Ausschalten in der Liste (Kreuz) deaktiviert, im Einstellungsdialog eines Objektes unter "Parameter" sichtbar.
Unter dem Befehl PARAMETERS ist im Bereich "Hintergrund" ein Erklärungsmodell zur Verwendung und dem Verhalten von Parametern in Skripten erläutert.
BesonderheitenDie Parameterliste eines Objektes ist in der Anzahl der möglichen Parameter je Objekt beschränkt:
Archicad 6.5: max 64
Archicad 7.0: max 128
Archicad 8.x: max. 512
Archicad 10+: max. 1024
Dabei zählen Arrays und Dicts als 1 Parameter, obwohl sie mehrere Werte speichern können.
Der Name eines Parameters ist auf 31 Zeichen begrenzt.
Die Buchstaben A bis Z (einstellige Parameternamen) sind für GDL-Texte (Also Makros mit Endung .gdl) reserviert und sollten nicht verwendet werden.
Archicad 6.5: max 64
Archicad 7.0: max 128
Archicad 8.x: max. 512
Archicad 10+: max. 1024
Dabei zählen Arrays und Dicts als 1 Parameter, obwohl sie mehrere Werte speichern können.
Der Name eines Parameters ist auf 31 Zeichen begrenzt.
Die Buchstaben A bis Z (einstellige Parameternamen) sind für GDL-Texte (Also Makros mit Endung .gdl) reserviert und sollten nicht verwendet werden.
Links