TCL - Erklärungen zur Scope- und Kommandobeschreibung

Es werden Scopes und Kommandos unterschieden. Ein Scope kann Scopes und Kommandos enthalten. Ein Kommando besteht nur aus einer Zeile, wobei TCL erlaubt, einer Zeile durch Verwendung des Zeichen '\' als Zeilenende nach dem Zeilenumbruch fortzusetzen.

Syntax

COMMAND arg1 arg2 ...

Jedes Kommando beginnt mit seinem Namen in Großbuchstaben, gefolgt von seinen Argumenten. Anzahl und Typen der Argumente variieren. In gewissen Fällen bestimmt das arg-i die Regeln zu dessen Folgeargumenten.

Beschreibung

Beschreibung zum jeweiligen Scope oder Kommando.

Argumente

Mindestanzahl: Scopes und Kommandos haben in der Regel eine Mindestanzahl an Argumenten.

arg1

Wert	Dimension	Bedeutung
text	TEXT	Beliebiger Text; Sonderzeichen müssen mit dem Escapezeichen '\' markiert sein. Ein Text ohne Leerzeichen erfordert keine Anführungszeichen '"'.
int	INT	Eine ganze Zahl wird erwartet.
key	KEYWORD	Vorgeschriebenes Schlüsselwort wird erwartet.
double	DOUBLE	Eine reelle Zahl wird erwartet.
double	ANGLED, LCROSSD, LSTRUCTD, STATION, etc.	Eine dimensionsbehaftete Zahl wird erwartet (vgl. PROJECT/UNIT)
fraction	LCROSSD, LSTRUCTD, STATION	Bei ausgewählten Kommandos können unter Verwendung imperialer Einheiten die Werte in "Fuß-Zoll-Darstellung" eingegeben werden.
guid	GUID	GUID als Zeichenkette
word	ENUM	Schlüsselwort einer Aufzählung wird erwartet.
[XFTS s001 s010 1]	XFTS	Eine Serie von nummerierten Stationen wird erwartet (nur Kommando SPOINT)
objid	OBJID	Temporäre ID eines AllplanBridge-Objektes zur Weiterverarbeitung in der Script; Die Gültigkeit der ID endet mit der Ausführung der Script. Nur für den Modell- und Ergebniszugriff.

Rückgabewerte

Die Kommandos des TCL-Scopes ABM geben kein Ergebnis zurück. Im Falle eines TCL-Syntaxfehlers oder eines anderen, für die Weiterverarbeitung fatalen, Fehlers, wird die Script abgebrochen.

Die Kommandos mit Zugriff auf bestehende Modell- und Ergebnisdaten haben immer einen Rückgabewert und werden in der Form "[KOMMANDO arg1 arg2 ....]" ausgeführt. Es ist daher möglich und sinnvoll, die Korrektheit der Ausführung eines derartigen Kommandos zu prüfen.

arg1

Wert	Dimension	Bedeutung
text	TEXT	Beliebiger Text; Sonderzeichen müssen mit dem Escapezeichen '\' markiert sein. Ein Text ohne Leerzeichen erfordert keine Anführungszeichen '"'.
int	INT	Eine ganze Zahl wird erwartet.
key	KEYWORD	Vorgeschriebenes Schlüsselwort wird erwartet.
double	DOUBLE	Eine reelle Zahl wird erwartet.
double	ANGLED, LCROSSD, LSTRUCTD, STATION, etc.	Eine dimensionsbehaftete Zahl wird erwartet (vgl. PROJECT/UNIT)
objid	OBJID	Temporäre ID eines AllplanBridge-Objektes zur Weiterverarbeitung in der Script; Die Gültigkeit der ID endet mit der Ausführung der Script.
tcllist	LIST	Liste von Rückgabewerten
ablist	ABLIST	Liste von AllplanBridge-Objekten als TCL-Array; Aufruf des Kommandos durch "array set ret [KOMMANDO ....]"; Der Inhalt des zurückgegebenen Feldes enthält die Argumente ret(first), ret(last), ret(count), ret(error), ret(info).
tclarr	ARRAY	Aufruf des Kommandos durch "array set ret [KOMMANDO ....]"; Der Inhalt des zurückgegebenen Feldes enthält die Argumente ret(arg1), ret(arg2), ... Die Namen der Argumente sind abhängig vom jeweiligen Kommando.

Scopes

Scopes in welchem der aktuelle Scope oder das aktuelle Kommando verwendet werden kann.

Beispiele

COMMAND .

Beispiel zum Kommando.