TCLCaller

Quatre variables globales Tcl servent de passerelle entre une entité FME et le script Tcl : Les variables FME_FeatureType, FME_CoordSys, FME_AttrEncoding et FME_AttrNameEncoding. Pour les utiliser dans une procédure Tcl, elles doivent être déclarées comme globales ; sinon, les variables seront considérées comme locales et n'affecteront pas ou n'interagiront pas avec l'entité FME sur laquelle la fonction est exécutée. Pour les utiliser dans une fonction, utilisez un modèle comme :

proc doSomething {

global FME_FeatureType

global FME_CoordSys

# rest of function goes here...

}

Cette variable globale définit le nom du codage de caractères dans lequel Tcl suppose que les attributs d'une entité sont spécifiés lorsqu'il travaille avec les fonctions FME_GetAttribute et FME_SetAttribute. Comme Tcl travaille en interne avec UTF-8, cela signifie qu'il convertira les valeurs des attributs de l'encodage donné en UTF-8 lorsqu'il obtiendra la valeur de l'attribut avec la fonction FME_GetAttribute, et qu'il convertira les valeurs de UTF-8 vers l'encodage donné lorsqu'il définira la valeur de l'attribut à l'aide de la fonction FME_SetAttribute.

La valeur de cette variable n'impacte pas sur la définition si sur la récupération d'attributs lorsque l'encodage des caractères est connu.

L'encodage par défaut des attributs est le même que l'encodage par défaut des caractères du système sur lequel FME s'exécute, et peut être remplacé par la commande intégrée "encoding system" de Tcl. Une liste complète des encodages supportés peut être obtenue en exécutant la commande "encoding names".

La variable peut être définie, lue ou non définie :

set FME_AttrEncoding iso8859-2

puts $FME_AttrEncoding

unset FME_AttrEncoding

Si ME_AttrEncoding n'est pas défini, il revient au système d'enocade par défaut.

Cette fonction est utilisée pour déterminer si un attribut est présent dans une entité.

La syntaxe pour FME_AttributeExists est :

FME_AttributeExists <attributeName>

<attributeName> est le nom de l'attribut dont la valeur doit être récupérée.

Si l'attribut est présent, la valeur 1 est retournée, sinon, 0 est renvoyé.

La fonction est utilisée pour déterminer si la valeur de l'attribut est nulle.

La syntaxe de FME_IsAttributeNull est :

FME_IsAttributeNull <attributeName>

<attributeName> est le nom de l'attribut dont la valeur est contrôlée.

Si l'attribut a une valeur nulle, la valeur 1 est retournée, sinon, 0 est renvoyé.

Cette fonction est utilisée pour récupérer les noms de tous les attributs des entités et les retourne sous la forme de liste Tcl.

La syntaxe pour FME_AttributeNames est :

FME_AttributeNames

Cette variable globale définit le nom du codage des caractères dans lequel Tcl suppose que les noms des attributs d'une entité sont spécifiés lorsqu'il utilise les fonctions FME_GetAttribute et FME_SetAttribute. Comme Tcl travaille en interne avec UTF-8, cela signifie qu'il convertira les noms d'attributs d'UTF-8 au système de codage donné, et utilisera le nom converti lorsqu'il fera référence aux attributs réels de l'entité.

L'encodage par défaut des attributs est le même que l'encodage par défaut des caractères du système sur lequel FME s'exécute, et peut être remplacé par la commande intégrée "encoding system" de Tcl. Une liste complète des encodages supportés peut être obtenue en exécutant la commande "encoding names".

La variable peut être définie, lue ou non définie :

set FME_AttrNameEncoding iso8859-2

puts $FME_AttrNameEncoding

unset FME_AttrNameEncoding

Si ME_AttrNameEncoding n'est pas défini, il revient au système d'encodage par défaut.

Cette variable globale est configurée pour refléter le système de coordonnées de l'entité. Comme pour la variable FME_FeatureType, elle peut être définie, lue et désactivée :

set FME_CoordSys UTM10-83

puts $FME_CoordSys

unset FME_CoordSys

Dans toute procédure Tcl invoquée par TclCaller, la fonction FME_Coordinates peut être utilisée pour lire et écrire les coordonnées de l'entité. Elle offre plusieurs options, comme indiqué ci-dessous :

dimension (2|3)

Défini la dimension de l'entité

numCoords

Retourne le nombre de coordonnées d'une entité.

resetCoords

Supprimer les coordonnées de l'entité.

Remarque : L'appel à resetCoords n'a aucun effet sur les attributs fme_geometry ou fme_type. Ceux-ci doivent être réinitialisés ou réajustés explicitement par le script afin de ne pas laisser l'entité dans un état incohérent.

getCoord (x|y|z) <index>

Retourne la valeur de la coordonnées pour l'axe spécifié via l'<index>.

<index> est compris entre zéro et le nombre total de coordonnées - 1

addCoord <xvalue> <yvalue> [<zvalue>]

Ajoute la coordonnée spécifiée à la fin de la géométrie.

geomType

Retourne le type de géométrie de l'entité - Le type de géométrie a pour valeur une des valeurs de l'attribut FME Geometry Model.

fme_point

fme_line

fme_polygon

fme_donut

fme_aggregate

fme_undefined

geomType <type>

Définit le type de géométrie de l'entité à la valeur transmise. Aucun contrôle d'intégrité n'est effectué. Il est important que cela soit fait avec précaution car la définition d'un type géométrique incorrect peut ultérieurement gêner FME.

Cette fonction est utilisée pour copier un attribut d'entité. Le type de stockage de données interne original de l'attribut est préservé en utilisant cette fonction. Cela peut être important lorsque vous travaillez avec des valeurs à virgule flottante de haute précision.

La syntaxe de FME_CopyAttribute est :

FME_CopyAttribute <newName> <oldName>

Si l'entité ne contenait pas d'attribut portant le nom oldName, la fonction ne fait rien. Elle ne crée pas de nouvel attribut vide.

Cette fonction est utilisée pour décoder les chaînes de caractères qui ont été encodées comme décrit dans la fonction FME_EncodeText. Le résultat de la fonction est une copie du paramètre d'entrée, avec les séquences de chaînes substituées reconverties en caractères qu'elles représentent.

La syntaxe de FME_DecodeText est :

FME_DecodeText <encodedText>

<encodedText> spécifie une chaîne qui peut contenir des caractères convertis.

Cette fonction est similaire à FME_DecodeText, sauf que cet argument peut être interprété comme une référence à une valeur d'attribut plutôt qu'à une chaîne à décoder.

La syntaxe FME_DecodeTextOrAttr est :

FME_DecodeTextOrAttr [&]<encodedText>

<encodedText> spécifie une chaîne qui peut contenir des caractères convertis.

Si l'argument commence par un caractère esperluette ("&"), la fonction renvoie la valeur dans l'attribut nommé en décodant le reste de l'argument. Sinon, la fonction renvoie l'équivalent décodé du <texte encodé>.

Cette fonction est particulièrement utile lors de la définition de nouveaux Transformers avec des éléments GUI de type "STRING_OR_ATTR_ENCODED".

Cette fonction est utilisée pour générer des chaînes de caractères qui sont encodées comme décrit ci-dessous dans Substitution de chaînes de caractères dans les fichiers de contrôle. Le résultat de la fonction est une copie du paramètre d'entrée, avec des caractères spéciaux convertis en séquences de chaînes substituées qui passent proprement à travers l'analyseur de fichiers de FME, et peuvent être représentées dans n'importe quel jeu de caractères ANSI.

La syntaxe de FME_EncodeText est :

FME_EncodeText <unencodedText>

<Texte non encodé> spécifie la chaîne de caractères qui doit être encodée. Tout caractère spécial dans cette chaîne sera remplacé par les séquences de substitution énumérées ci-dessous.

Substitution de chaînes de caractères dans les fichiers de contrôle

Occasionnellement, un caractère peut provoquer un conflit dans l'analyseur du fichier de mappage. Si cela se produit, vous pouvez substituer des chaînes de caractères sûres dans de nombreux formats, fonctions et fabriques, notamment :

• Writer Geodatabase (Définitions des attributs > sous-types, Définitions des attributs > domaines)
• @Lookup
• PythonFactory
• @SearchList
• @SupplyAttributes
• @Tcl2

Caractère de substitution

La méthode de codage s'inspire des entités de caractères XML.

Note : les substitutions sont faites uniquement dans les définitions de type d'attribut.

Caractères internationaux

Le codage décrit ci-dessus prend en charge les caractères qui peuvent poser des problèmes lors de l'analyse des fichiers de mappage, mais il interfère avec certains caractères "spéciaux" de certains codages (où "spécial" signifie des caractères qui ne font pas partie du jeu ASCII 7 bits.) Les problèmes apparaissent dans les systèmes où un ou plusieurs octets d'un caractère multi-octet sont spéciaux au codage traditionnel.

Pour contrer cela, FME prend en charge l'encodage des caractères basés sur Unicode. L'encodage des caractères spéciaux se fait désormais sous la forme d'une balise spéciale, <uXXXX>, où XXXX est la représentation hexagonale du caractère UTF-16. Ce schéma d'encodage très simple est basé sur une observation (hypothèse) : tous les caractères qui poseront des problèmes à l'intérieur de l'encodage impliqueront un ou plusieurs octets dont le bit haut est activé. Ainsi, afin d'encoder traditionnellement toute chaîne de caractères contenant un caractère où un bit élevé est activé, nous devons convertir les chaînes de caractères en une forme où le système d'encodage est neutralisé, où nous pouvons en quelque sorte représenter ce caractère avec une chaîne d'octets contenant uniquement des valeurs de 7 bits (c'est-à-dire des valeurs propres de 7 bits).

Le processus de codage applique essentiellement l'heuristique suivante :

Si la chaîne contient des octets dont le bit de poids fort est activé :

• Convertir la chaîne de caractères en UTF-16
• Convertir la chaîne de caractères 16 bits UTF-16 en une chaîne de caractères 7 bits encodée traditionnellement.

Le résultat de cette opération est une chaîne codée qui est propre sur 7 bits (c'est-à-dire qu'elle n'a pas de bits de poids fort) et qui peut être décodée pour obtenir exactement les caractères originaux du résultat non codé.

Lorsqu'il rencontre la séquence de caractères <u n'importe où dans une chaîne encodée, le décodeur pourra inverser le processus ci-dessus après un décodage "traditionnel", pour revenir à la chaîne encodée originale UTF-8 ou par défaut du système.

Si une valeur de 16 bits est trop grande pour un caractère de 7 bits, remplacez-la par \uXXXX, où XXXX est la représentation hexagonale de la valeur de 16 bits.

Exemples

Selon la méthode de codage, le type d'attribut

coded_domain(TextDom:char(50):a:"the letter a":b:"the letter b")

peut être représenté comme

coded_domain(TextDom:char<openparen>50<closeparen>:a:

<quote>the<space>letter<space>a<quote>:b:<quote>the<space>

letter<space>b<quote>)

dans un fichier de contrôle. Notez que l'encodage est uniquement appliqué au corps du type coded_domain, c'est-à-dire coded_domain(<body>). De même, il ne serait appliqué qu'au corps de range_domain(<body>), subtype(<body>), et subtype_codes(<body>) qui sont des types d'attributs Geodatabase et à enum(<body>) et set(<body>) qui sont tous deux des types d'attributs MySQL.

Cette fonction est utilisée pour appeler n'importe quelle fonction FME à partir d'une procédure Tcl. Cela permet d'appeler des fonctions FME standard de manière itérative sur la même entité.

La syntaxe pour FME_Execute est :

FME_Execute <functionName> [<arg1> ... <argN>]+

<functionName> est le nom de n'importe quelle fonction FME sans le préfixe @.

Tout argument restant est transmis à la fonction. Par exemple, la fonction @Generalize est invoquée comme suit :

FME_Execute Generalize Douglas 10

et cela offre le même effet que si @Generalize(Douglas,10) avait été appelée n'importe où dans le fichier de contrôle.

Si la fonction invoquée entraîne la suppression de l'entité, la traduction est interrompue. La fonction @Generalize peut le faire si la longueur totale de l'entité est inférieure à la valeur de tolérance transmise.

Cette variable globale est configurée pour refléter le type d'entité de l'entité. Comme les autres variables, elle peut être définie, lue et désactivée :

set FME_FeatureType "Roadster"

puts $FME_FeatureType

Cette fonction peut être utilisée pour obtenir une valeur d'attribut de l'entité depuis une procédure Tcl.

The syntax for FME_GetAttribute is:

FME_GetAttribute <attributeName> [<attributeEncoding>]

<attributeName> est le nom de l'attribut dont la valeur doit être récupérée.

<attributeEncoding> est un encodage de caractères facultatif utilisé lors de l'interprétation des octets de la valeur d'un attribut existant. S'il n'est pas spécifié, les octets d'un attribut codé sont interprétés selon leur codage d'origine, et les octets d'un attribut à chaîne simple sont interprétés selon la valeur de la variable globale FME_AttributeEncoding.

Si l'attribut n'était pas présent dans l'entité, une chaîne vide est retournée en tant que valeur.

La fonction FME_LogMessage est utilisée pour écrire des messages dans le fichier journal de FME. Elle peut être invoquée de deux façons :

FME_LogMessage <severity> <messageNumber> [<arg1> ... <argN>]+

ou

FME_LogMessage <severity> <message>

<severity> peut avoir l'une de ces valeurs: fme_inform, fme_warn, fme_error, fme_fatal, fme_statistic, et fme_statusreport

Lorsque la première forme est utilisée, le numéro du message doit être présent dans un fichier situé dans le sous-dossier messages du dossier d'installation de FME. Les autres paramètres sont utilisés pour remplir tous les supports de paramètres %0, %1, ... %n du message. Par exemple, si le message était :

3011, Opening file %0 for mode %1

alors FME_LogMessage peut être appelé comme cela :

FME_LogMessage fme_inform 3011 /tmp/cacher.txt read

Avec la deuxième forme, le message ressort directement du fichier de log.

Cette fonction est utilisée pour copier un attribut d'entité. Le type de stockage de données interne original de l'attribut est préservé en utilisant cette fonction. Cela peut être important lorsque vous travaillez avec des valeurs à virgule flottante de haute précision.

La syntaxe pour FME_RenameAttribute est :

FME_RenameAttribute <newName> <oldName>

Si l'entité ne contenait pas d'attribut portant le nom oldName, la fonction ne fait rien. Elle ne crée pas de nouvel attribut vide.

Cette fonction est utiliser pour définir la valeur d'un attribut d'une entité.

La syntaxe pour FME_SetAttribute est :

FME_SetAttribute [-notranscode] <attributeName> <attrValue> [<attributeEncoding>]

<attributeName> est le nom de l'attribut dont la valeur doit être définie sur <attrValue>.

<attributeEncoding> est un encodage de caractères facultatif à appliquer à l'attribut résultant. Il remplace l'effet de toute valeur actuellement stockée dans la variable globale FME_AttributeEncoding.

Si l'option -notranscode est spécifiée, les octets de la variable Tcl sont copiés textuellement dans l'attribut résultant, au lieu d'une conversion de l'encodage de caractères de l'encodage UTF-8 interne de Tcl vers l'encodage de caractères cible. Ceci est utile lorsque la variable Tcl est connue pour contenir un tableau d'octets dans un codage de caractères particulier au lieu de la séquence habituelle de caractères UTF-8.

L'attribut résultant aura normalement des informations d'encodage de caractères jointes. Si l'argument <attributeEncoding> n'est pas spécifié, l'attribut aura par défaut un encodage UTF-8, sauf si la variable globale FME_AttributeEncoding est définie. Si cette variable est définie, l'attribut résultant sera un attribut non codé (chaîne de caractères simple), avec des octets représentant les caractères de la valeur dans l'encodage nommé.

Cette fonction est utilisée pour définir la valeur d'un attribut sur une entité à null. Si l'attribut n'existe pas, il sera créé.

La syntaxe pour FME_SetAttributeNull est :

FME_SetAttributeNull <attributeName>

<attributeName> est le nom de l'attribut dont les valeurs seront définies sur null.

Si l'attribut n'existe pas, il sera créé et son type sera string.

Cette fonction génère un nom de fichier temporaire dans le dossier temporary de FME.

Le nom de fichier est garanti d'être un nouveau fichier unique.

Note : FME créera un fichier vide avec le nom donné, vous devez le supprimer quand vous avez fini.

La syntaxe de FME_TempFilename est :

FME_TempFilename [<prefix>] [<suffix>]

Si un préfixe et un suffixe ne sont pas fournis, le nom de fichier sera renvoyé sous la forme d'un fichier au nom unique et arbitraire dans le dossier temporaire de FME. (Pour plus d'informations sur l'emplacement de ce dossier, reportez-vous à la section Détermination du dossier temporaire).

Si un préfixe est fourni, il est utilisé comme partie initiale du nom de fichier dans le dossier temporaire, et le suffixe est utilisé comme partie finale. En général, le suffixe est utilisé pour ajouter une extension, et dans ce cas, il doit inclure un point ".".

Par exemple, cet appel :

FME_TempFilename raster .png

devrait retourner quelque chose comme :

c:/Documents and Settings/username/Local Settings/Temp/rastera05921.png

Cette fonction est utilisé pour supprimer un ou plusieurs attributs d'une entité.

La syntaxe pour FME_UnsetAttributes est :

FME_UnsetAttributes <attr1> [<attr2> <attr3 ...]

Aucune erreur ne sera générée si l'entité ne contient aucun des attributs énumérés. FME_UnsetAttributes ignore simplement tout argument qui ne spécifie pas un attribut sur l'entité.

Utilisation de l'éditeur de texte

L'éditeur de texte fournit un moyen efficace de construire des chaînes de textes (dont les expressions régulières) à partir de données source diverses, telles que des attributs, des paramètres et des constantes, et le résultat est directement utilisé dans le paramètre.

Editeur de texte

Utilisation de l'éditeur arithmétique

L'éditeur arithmétique fournit un moyen simple de construire des expressions mathématiques à partir de plusieurs données source, telles que des attributs et des fonctions, et le résultat est directement utilisé dans un paramètre.

Éditeur arithmétique

Valeur conditionnelle

Définit des valeurs selon un ou plusieurs tests.

Fenêtre de définition de conditions

Contenu

Les expressions et chaînes de caractères peuvent inclure des fonctions, caractères, paramètres et plus.

Lors du paramétrage des valeurs - qu'elles soient entrées directement dans un paramètre ou construites en utilisant l'un des éditeurs - les chaînes de caractères et les expressions contenant des fonctions Chaîne de caractères, Math, Date et heure ou Entité FME auront ces fonctions évaluées. Par conséquent, les noms de ces fonctions (sous la forme @<nom_de_fonction>) ne doivent pas être utilisés comme valeurs littérales de chaîne de caractères.

Types de contenu

Fonctions chaînes de caractères	Ces fonctions manipulent les chaînes de caractères.
Caractères spéciaux	Un ensemble de caractères de contrôle est disponible dans l'éditeur de texte.
Fonctions mathématiques	Plusieurs fonctions sont disponibles dans les deux éditeurs.
Fonctions Date/heure	Les fonctions de dates et heures sont disponibles dans l'Editeur texte.
Opérateurs mathématiques	Ces opérateur sont disponibles dans l'éditeur arithmétique.
Fonctions d'entités	Elles retournent des valeurs spécifiques aux entités.
Paramètres FME	Les paramètres FME et spécifiques au projet peuvent être utilisés.
Créer et modifier un paramètre publié	Créer ses propres paramètres éditables.

Note : Tous les outils ne sont pas disponibles dans tous les Transformers.