Référence de méthode
Cette page constitue la référence canonique pour l’API COM GeoDin. Elle décrit les Méthodes qu’une application externe peut appeler sur piloter GeoDin (en tant que serveur COM) ou sur intégrer des fonctions externes dans GeoDin en tant que plug-ins. La référence s’adresse sur aux développeurs de logiciels qui combinent GeoDin avec d’autres produits ou intègrent des Fonctions spéciales dans GeoDin. Pour chaque Méthode, l’édition nécessaire de GeoDin est indiquée.
Aperçu
Fonctions COM et plugins
GeoDin offre la possibilité de connecter GeoDin à des applications externes. Ce chapitre décrit les Méthodes techniques et s'adresse aux développeurs logiciels, qui sont sur le point d'associer GeoDin à d'autres produits ou d'intégrer des Fonctions spéciales dans GeoDin.
Pour exécuter GeoDin via une application externe, plusieurs fonctions sont Disponible. Une partie de ces fonctions sert à contrôler l'interface du programme GeoDin (dans ce cas GeoDin est visible pour l'Utilisateur), de sorte qu'une application externe semblable, par exemple, à un SIG choisit de manière autonome un Puits dans le gestionnaire de Puits GeoDin et lance une Méthode GeoDin. Une autre partie des fonctions sert à fournir des informations depuis la Base de données GeoDin sur des images Graphique des Objets. Ici, GeoDin est généralement invisible et gère ses tâches dans l'Arrière-plan. Les fonctions individuelles sont décrites dans la section Fonctions COM. Pour chaque fonction, il est défini quelle édition GeoDin est nécessaire.
Le autre part, il est possible sur d’intégrer des applications externes OU des fonctions dans l’interface du programme inclus de GeoDin. Ces fonctions (appelées plug-ins) peuvent par exemple effectuer des Calculs spéciaux OU des exportations de données et sont affichées inclus GeoDin avec un Symbole de Méthode. Une description pour insérer et configurer ces fonctions externes est donnée inclus la section Greffons ET inclus Installation des modules.
Fonctions COM
Conseils pour l’utilisation de GeoDin comme serveur COM
Utilisation de GeoDin comme serveur COM (en créant un Puits du type GeoDin.GeODinApplication) peut être contrôlé par les paramètres suivants.
Répertoire de travail de l'application GeoDin
Par défaut, le dossier « TEMP » inclus le dossier « paramètres locaux » de l’utilisateur actuellement est utilisé comme répertoire de travail de l’application GeoDin inclus le mode de démarrage en tant que serveur COM. En saisissant ExecutePath=<Répertoire> inclus dans la section [Système] de Fichier de configuration GeoDin.ini un autre Répertoire peut être défini.
Disponibilité des plug-ins
Par défaut Greffons ne sont pas chargés lorsque GeoDin est Commencé. En entrant COMServerPlugins=vrai inclus dans la section [Système] de Fichier de configuration GeoDin.ini le chargement du module peut être obtenu.
Répertoire de l'application GeoDin
Le répertoire de l'application de GeoDin est par défaut le répertoire situé un niveau plus haut que le répertoire BIN (dans lequel GeoDin.exe est inclus). Une Installation GeoDin typique a la structure suivante :
Le répertoire de l'application est dans ce cas C:\Programs\GeoDin, où le fichier de configuration GeoDin.ini est également lu. Avec ce nom, les noms de plusieurs sous-répertoires sont également créés (par exemple pour SOURCE, QUERYDEF, Mises en page, etc.).
Il est possible de configurer le répertoire de l'application de GeoDin sur tout autre répertoire, ce qui permet de différencier si GeoDin est démarré directement comme application par l'utilisateur ou s'il est instancié en tant que serveur COM. Pour un démarrage « normal » de GeoDin par l'utilisateur, le répertoire de l'application peut être défini au moyen d'un paramètre de ligne de commande. Il doit commencer par le mot-clé -af ET doit contenir un Nom de Répertoire Plein par la suite sur.
Note : Si le Nom du Répertoire Contient des espaces Vide, tout le Paramètre doit être inclus sur des guillemets, par ex.:
En démarrant GeoDin comme serveur COM, un paramètre de ligne de commande n'est pas possible. De ce fait, une méthode a été préparée sur saisir cela via le registre. Ici, le nom du répertoire d'application choisi doit être placé AVANT le démarrage du serveur COM inclus dans le REG_SZ clé "ApplicationFolder" inclus la clé de registre suivante :
Avec Tous les deux Méthodes GeoDin vérifie l'existence du Répertoire et ignore le paramètre, Si il ne le trouve pas. D'autres vérifications ne prennent pas place. Assurez-vous que le Répertoire sélectionné Contient un fichier de configuration GeoDin.ini et tous / toutes les sous-répertoires nécessaire à GeoDin.
Greffons
Greffons sont des modules externes (programmes / serveur COM), qui sont appelés depuis l’interface Utilisateur de GeoDin. Ainsi, un développeur de logiciels peut intégrer le Démarrage d’une certaine application, par exemple une fonction Exporter spéciale ou une fonction de calcul Nouveau, inclus l’interface Utilisateur du programme GeoDin. Pour l’Utilisateur, l’application apparaît comme une « ordinaire » Méthode GeoDin. tous / toutes les informations nécessaires pour les Objet(s) choisi(s) sont transférées sur le plug-in inclus le gestionnaire de Puits GeoDin. Ainsi, le plug-in peut proposer des fonctions d’analyse additionnel pour un nombre d’Objets sélectionné. Un plug-in peut aussi être une application qui ne fonctionne pas avec la Base de données GeoDin. La configuration du plug-in peut aussi intégrer le « calculator » provenant du Système d’exploitation inclus l’interface Utilisateur du programme de GeoDin.
Un plug-in peut être invoqué en tant qu’application (EXE Fichier) ou en tant que fonction COM d’un serveur COM enregistré. Ici le paramètre Exécuter OU Serveur inclus dans la configuration du plug-in. Un serveur COM, qui doit être appelé comme un plug-in, doit satisfaire à certains Besoins, qui sont décrits ci-dessous.
Pour une configuration étape par étape, voir Installation des modules.
Définition d’un plug-inclus
Le réglage et la configuration des plug-ins à utiliser sont effectués dans le fichier de configuration GEODIN.INI.
Avec GeoDin 9, les plugins sont définis à l’onglet Le Système, inclus dans la Configuration de système, sous la section « Publications ».
1. Liste des plug-ins disponibles
inclus la section [Plugins] Chaque plug-in est défini avec une Ligne ET obtient un Nom, exemple :
Note : Peut-être la section [Plugins] doit sur être créé, si aucun plug-in Précédent n’a été configuré. Ajouter une ligne contenant [Plugins] avec L’éditeur de texte complet à la Fin du Fichier GEODIN.INI et Au moins une Ligne semblable Plugin1=Nom du plug-in. Utiliser des nombres consécutifs (Plugin1=, Plugin2= etc.) pour la définition de plus d’un plugin.
2. Définition d’un seul plug-in de la liste
Pour chaque plug-in saisi dans la Liste [Plugins] une section séparée inclus dans le Fichier de configuration GEODIN.INI doit sur être créé contenant le Nom du plug-in défini à l’Étape 1, exemple :
OU
Ajouter avec l’éditeur de texte complet les lignes particulières sur le Fichier GEODIN.INI.
Les Paramètres inclus dans cette section contrôlent à quels Objets (inclus le gestionnaire d’objet GeoDin) le plug-in devrait être appliqué, quel Fichier de programme ou quelle fonction de serveur COM devrait être exécutée, et si l’Utilisateur doit attendre l’Exécution de la fonction.
Les paramètres suivants sont définis :
Nom
Nom du module complémentaire dans le gestionnaire d’objets GeoDin (ces noms s’affichent sous le Symbole de la Méthode ou dans le menu contextuel).
Executer
Programme exécutable (Nom de fichier plein avec chemin). Exemple : C:\WINDOWS\SYSTEM32\CALC.EXE
OU Serveur
Nom du serveur COM, qui doit Executer la fonction choisie. Exemple : GeODinPlugin.GeODinPluginSample
DBNode1..n
Liste des nœuds inclus dans le gestionnaire d'objets GeoDin Bases de données, à laquelle le plug-in peut être Commencé. Ici, vous pouvez Sélectionner, à quels nœuds (branches et Etat du nœud) l’appel du plug-in doit être possible. Cela se fait en Sélectionner une Liste de Définitions de branche de N'importe quelle Longueur, qui doivent être définies par une Entrée DBNodexx. Utiliser les nombres consécutifs (DBNode1=, DBNode2= etc.) pour la définition de plusieurs nœuds. Voir les exemples et la syntaxe ci-dessous.
Module (facultatif)
Nom du module de programme dans le plug-in ; ce Nom est transféré en tant que Paramètre au programme exécutable ou à la fonction COM. Si aucun Nom de module n’est saisi, le Paramètre de transfert reste Vide. Grâce à cette option, il est possible qu’une seule application ou qu’une fonction de serveur COM puisse effectuer différentes tâches, lesquelles sont contrôlées par l’Identification du module. Plusieurs fonctions peuvent être combinées dans une application externe en utilisant les noms de module, car il est autorisé de connecter plusieurs plug-ins avec le même Fichier d’application ou la même fonction de serveur COM. En transférant le Nom du module en tant que Paramètre, différents Processus peuvent être Activé inclus l’application externe ou la fonction. Dans ce cas, différentes fonctions peuvent être alignées sur différents Symboles à l’aide du Paramètre « Icon ».
Icône (facultatif)
Plein Nom de fichier d’un fichier ICO pour l’affichage du Symbole de la Méthode dans le gestionnaire de la Méthode. Si ce Paramètre n’est pas saisi, l’icône du programme exécutable est utilisée (pas possible pour les serveurs COM). Si le programme ne Contient aucune icône, une icône Texte standard est utilisée.
Fenêtre contextuelle (facultatif)
Méthode est affichée uniquement comme menu contextuel (cliquez avec le Bouton droit de la souris à le Puits dans le gestionnaire de Puits GeoDin, inclus). Définissez la Valeur sur =vrai, si le module complémentaire ne doit pas s’afficher comme Symbole de la Méthode, mais seulement dans le menu contextuel. La Valeur Texte standard est =faux -> Symbole inclus dans le gestionnaire de méthode.
Attendez (facultatif)
Contrôle si GeoDin doit attendre pour Executer la fonction dans le plug-in. Pour les applications (Fichiers EXE), définissez la valeur sur =vrai, Si la fonction doit être Etre complété, sur aller à travailler inclus GeoDin. La Valeur Texte standard de ce Paramètre est =faux. Note : Lorsqu’un serveur COM est utilisé, GeoDin attend toujours jusqu’à ce que la fonction soit terminée.
Autoriser les méthodes ouvertes (facultatif)
Définit si le plug-in peut être exécuté, Si des Méthodes ayant l’état Ouvert (par ex. Saisie de données). Le réglage Par défaut permet au plug-in de s’exécuter : définissez le Paramètre sur =faux, sur empêcher cela (inclus dans ce cas, un Avertissement sera affiché).
Masquer (facultatif)
Contrôle si le module complémentaire est visible dans le gestionnaire de méthodes (en tant que symbole ou menu contextuel). Par défaut, il est visible. Définissez le paramètre Masquer sur =vrai, sur masquer le plug-in. Ensuite, le plug-in ne peut être appelé qu’à l’aide du Fonction COM "ExecuteMethodParams".
Exécuter après expansion (facultatif)
Contrôle si le plugin est exécuté automatiquement lors de l’ouverture de la branche pour la premier fois. Définissez le paramètre =vrai sur le Démarrage automatique du plugin. Plugins masqués par le Paramètre Masquer=Vrai peut être Commencé automatiquement. Ainsi, il est possible sur appeler une fonction pas par l'Utilisateur de GeoDin, mais qui est exécutée automatiquement lorsque cette branche est ouverte (par exemple après l'ouverture de la Base de données).
Actualiser les dictionnaires de la base de données (facultatif)
Ceci définit, après l’exécution de l’extension, si les Dictionnaires de la Base de données sont déchargés. Si nécessaire, ils seront automatiquement rechargés.
Exemples de DBNode
Exemple 1 :
Signification : l’extension s’affiche sur un nœud de Projet. Le Projet doit déjà être ouvert et être inclus dans une Base de données OneTableSet.
Exemple 2 :
Signification : le plug-in n’est affiché que sur les Projets ouverts de la Base de données « Boreholedatabase ».
Exemple 3 :
Signification : Le plug-in est affiché à les Projets avec le Projet Identification P00001 ou P00002 de la Base de données "Boreholedatabase". Il n'a pas d'importance si les Projets sont ouverts ou fermés.
Exemple 4 :
Signification : Le plug-in s’affiche inclus tous / toutes les Bases de données SQL avec le paramètre OneTableSet activé sur Le documents du type JPG à la position Seconde de la Liste de Méthode (après la méthode « Aperçu avant impression »).
Syntaxe de la définition DBNodeX=
L'Identification du Paramètre doit être saisie obligatoirement, d'autres Paramètres peuvent être ajoutés, séparés sur des virgules.
1
Bases de données
2
Base de données
3
Projet
4
recherche ou Groupe inclus dans la branche Objets
5
recherche ou Groupe inclus la branche Stations de mesure
6
Puits
7
Puits des Stations de mesure
8
Répertoire de documents
9
Document
0
Toutes les bases de données
1
pour Identification=1, le Plugin est affiché uniquement si aucune Base de données n’est actuellement configurée ; pour Identification=2, uniquement dans les Bases de données SQL (pas de fichier, Bases de données basées sur des fichiers)
2
uniquement inclus les Bases de données SQL avec le paramètre OneTableSet
Nom
seulement inclus dans la Base de données particulière avec le Nom saisi
0
quoi qu’il en soit, que la Base de données ou le Projet soit ouvert
1
seulement, si la Base de données OU le Projet est ouvert
2
seulement, Si la Base de données OU le Projet est fermé
vide
inclus tous les projets
PRJID
uniquement inclus dans les Projets avec l'Identification saisie
Vide OU 0
à la Fin de la Liste (après les Méthodes GeoDin)
1..n
à la position saisie, par ex. 1 - le Symbole de la Méthode est affiché au Puits à la 1. position
Vide
à tous / toutes les types de documents
JPG
uniquement à des documents de ce type (ici exemple : images JPG)
Utiliser une application (Fichier EXE) en tant que plug-in
Pour utiliser une application en tant que plug-inclus, vous devez sur saisir le paramètre Executer=Nom du chemin Plein de l'application inclus la définition du plug-in. GeoDin démarre l'application, lorsque la Méthode est appelée, et transfère tous / toutes les Paramètres nécessaire de la branche sélectionné inclus le gestionnaire d’objets GeoDin. Avec ces données, le plug-in peut effectuer des Opérations spéciales pour ces Objets. Les Paramètres sont transférés à l'application inclus la ligne de commande. Selon la branche sélectionné inclus le gestionnaire d’objets GeoDin, le Nombre de Paramètres varie, ce qui est indiqué dans le Tableau suivant :
1
Chaîne de caractères
Nom du module ou Vide
X
X
X
X
2
Entier
Position de l'Ecran à Gauche
X
X
X
3
Entier
Position de l'Ecran vers le haut
X
X
X
4
Entier
Identification de la succursale
X
X
X
X
5
Chaîne de caractères
Nom de la base de données *1
-
X
X
6
Chaîne de caractères
Nom du registre de la Base de données
-
X
X
7
Chaîne de caractères
Base de données de Mot de passe *2
-
X
X
8
Chaîne de caractères
Projet Identification GeoDin, OU chaîne "DB" pour une branche sous une recherche de Base de données
-
-
X
9
Chaîne de caractères OU Entier
Selon la Sélection d'Identification
-
-
X
Le type de Paramètre 9 dépend de l’Identification de la branche, d’où le plug-in est Commencé :
1,2,3
vide
4
nom de fichier d’un fichier temporaire avec PRJ_Identification et LOCIdentification des objets
5
Nom de fichier d'un fichier temporaire contenant une chaîne des INVID des Objets
6
PRJ_Identification ET LOCIdentification du Puits sélectionné
7
INVID du Puits sélectionné sous forme de chaîne
8
nom de fichier d'un fichier temporaire contenant les entiers des ADC_ID des documents
9
ADC_Identification des documents
*1 Nom de la base de données : En plus du Nom de la base de données, cette chaîne inclut également le type de connexion (ADO ou FireDAC) et la Commande de connexion elle-même.
*2 Le mot de passe peut faire partie de la Commande de connexion, par ex. pour les Bases de données Système ou pour les connexions avec un mot de passe stocké. Dans ce cas, la chaîne est vide. Le mot de passe doit être extrait directement de la Commande de connexion.
Si un Nom de fichier avec les ID des Objets est transféré sur les plug-ins, le plug-in est responsable sur de Supprimer ce Fichier ! Si le Fichier n’est pas supprimé, il reste inclus dans le Répertoire TEMP de l’Utilisateur actuellement.
Le Fichier avec les ID Contient autant de lignes que d'Objets sont inclus dans la recherche OU le Groupe.
Le Identification de la branche = 4, chaque ligne Contient le PRJID et le LOCID séparés par des virgules (Exemple : PRJ001,3).
Le branche Identification = 5, chaque Ligne Contient l'INVID (Exemple : PRJ0010004FIL001).
L'Identification de la branche = 8, chaque Ligne Contient l'ADC_Identification (Exemple : 23).
Les paramètres 1 ET 2 de la fenêtre « idéale » Permet de positionner la fenêtre de l'application externe de manière analogue aux Méthodes GeoDin sur le côté droit sous le Symbole de la Méthode ou l'Entrée du menu contextuel.
Utilisation d'un serveur COM comme plug-inclus
Pour Utiliser un serveur COM comme plug-inclus, vous devez sur saisir le paramètre Serveur=nom complet de l'interface du serveur COM inclus dans la définition du plug-in. Le nom complet se compose du nom du serveur COM et du nom de l’interface, qui sont séparés par un point, par ex. GeODinPlugin.PluginInterface.
L’interface doit fournir une fonction avec le Nom sur GeODinExecutePlugin, qui reçoit une chaîne comme Paramètre de transfert et renvoie un Paramètre OleVariant :
Note : La syntaxe de la définition de la fonction dépend du langage de programmation, dans lequel le plug-in est créé.
La chaîne, qui est transférée inclus dans les paramètres, a la structure d’un fichier de configuration avec les sections et les paramètres suivants :
Explication :
La position peut être utilisée par le plugin afin de placer un dialogue correspondant aux positions pour les Méthodes GeoDin. Le Paramètre DBNode Contient l’Identification de la branche sélectionnée (voir la description de DBNode ci-dessus). La Connexion à la base de données est spécifiée par le Nom de la base de données (se compose de Nom et de Commande de connexion séparés par deux-points), les informations de connexion (pour les Bases de données SQL) et éventuellement le Nom du propriétaire. Le Paramètre PRJID est occupé par l’Identification de projet GeoDin, Si les branches sélectionnées sont sur un Projet, sinon ce Paramètre Contient la chaîne Fixer / Ancrer "DB".
Type d'objet Identification :
Objets : PRJ_Identification et LOCIdentification séparés par des virgules
Stations de mesure : INVID sous forme de chaîne
Documents : ADC_Identification des documents
Si les Requêtes système sont utilisées, les Propriétés des Commandes SQL, qui ont entraîné la saisie des Objets dans le gestionnaire de Puits, sont transférées, inclus, dans la section « recherche ».
La Valeur de retour de la fonction est réservée à de futures extensions. La Valeur devrait être définie sur Zéro, car à l'heure actuelle elle n'est pas renvoyée.
Plug-in sur Créer des Rapports
En plus de l’Exécution des plug-ins en tant que Méthode inclus dans le Puits du gestionnaire de plug-ins GeoDin, les plug-ins peuvent également être utilisés sur Créer des Rapports. Ce type de plug-ins peut être Utilisé dans Mises en page et Graphique pour réaliser un type fort particulier de Rapport inclus dans un Graphique. Pour développer un tel plug-in, c’est une tâche complexe, parce qu’une classe GeoDin au Format de papier XML doit être créé et renvoyé en tant que Paramètre sur la fonction. Une description d’une classe GeoDin au Format de papier XML n’est pas incluse ici (les informations sont fournies à la demande) ; seul le réglage des plug-ins de Rapport est décrit ici :
1. Liste des plugins de rapport disponibles
inclus la section [Plugins de rapport] chaque plug-in est défini par une Ligne et donné un Nom.
Exemple :
2. Définition d’un seul plug-in de Rapport de la Liste
Pour chaque plug-in défini dans la Liste [Plugins de rapport] Un segment distinct inclus dans le fichier de configuration GEODIN.INI avec le nom du plug-in défini dans l’étape 1 doit sur être créé.
Exemple :
Nom
Nom à Eléments de graphique "Rapport"
Serveur
Nom de l’interface du serveur COM
Module
nom du module facultatif
ExécuterSansDonnées
Sélection du type d’Exécution du plug-in
Le nom du module est transféré au plug-in, afin que différents Rapports puissent être créé dans une fonction COM. En définissant l’option ExecuteWithOutData=faux le plug-in est Commencé par GeoDin, Si le Graphique est une Sélectionner une mise en page sans connexion de données. En définissant l’option ExecuteWithOutData=vrai Ça ne commence qu’inclus dans un Graphique avec des données connectées.
Pour utiliser un serveur COM en tant que plug-in de Rapport, saisissez dans la définition du plug-in le Paramètre Serveur=nom complet de l'interface du serveur COM. Le Plein Nom se compose du Nom du serveur COM ET du Nom de l'interface, qui sont séparés par des virgules, par ex. GeODinPlugin.PluginInterface.
L'interface saisie doit fournir une fonction sur le Nom GeODinGetGraphicReport, qui reçoit une chaîne comme paramètre de transfert et un OleVariant comme paramètre de retour :
Note : La syntaxe de la définition de la fonction dépend du langage de programmation, dans lequel le plug-in est créé.
La chaîne, qui est transférée inclus params, a la structure d’un fichier de configuration avec les sections et les paramètres semblable décrits ci-dessus pour les plug-ins du serveur. En retour, un flux de données XML conformément sur la classe GeoDin C_GraphicDrawReport est attendu.
Numéros d’erreur
Les numéros d’Erreur sont définis pour tous / toutes les fonctions. Ils sont renvoyés par Valeur d’exception.
1
Erreur du Système (les ressources du Système sont épuisées, c.-à-d.)
2
Fonction pas autorisée sous licence
3
Erreur d’initialisation (COM-Server n’a pas OU incomplètement Commencé)
4
Le Fichier correspondant à Sélectionner une mise en page (Paramètre LayoutFileName) ou La mise en page / Rapport de la Liste de mise en page ne peut pas être chargé (nom incorrect, Fichier manquant, défectueux, etc.)
5
Erreur inclus La mise en page (p. ex. pas un objet Bordure de graphique existant)
6
La Base de données ne peut pas être ouverte (Nom de la base de données incorrect, identifiant de connexion incorrect)
7
Impossible de charger le Puits (Projet incorrect ou défectueux, ID d'objet, Fichiers défectueux dans le Répertoire GeoDin SYSLIB)
8
Le Fichier sélectionné inclus dans le Paramètre OutFileName ne peut pas être enregistré (nom de fichier incorrect, droits)
9
Le périphérique de sortie (Imprimer) sélectionné est Non défini inclus le Fichier de configuration GeoDin.INI.
10
Le périphérique d'Imprimer défini par l'Entrée de configuration ne peut pas être trouvé inclus dans la Liste des pilotes d'Imprimante installés.
11
Erreur lors de la création du Fichier d’impression (par ex. configuration incorrecte du Format de papier, le Pilote de l’Imprimante ne prend pas en charge ce format)
12
Erreur lors du transfert du Fichier d'Imprimer Complété en Résultat de la fonction (définir SpoolTimeOut)
13
Création de l’Entrée du Puits OU du Groupe du Puits n’est pas possible (ID d'objet incorrecte, Type de puits incorrect)
14
Invalide MethodID - la fonction n'est pas Disponible
15
Une Sélection n’est pas possible parce que l’objet marqué ne peut pas être quitté — Gauche. Exemple : Si l’objet actuellement est modifié et, en raison de Erreur de syntaxe, inclus dans les données, le marquage sur un autre objet n’est pas possible.
16
L'expression ne peut pas être démarrée car aucune fenêtre graphique n'est ouverte.
Référence : Méthodes COM
Valeur d’exception
Fonctions sur identifier l'état d'Erreur.
Cette fonction affiche l’état d’Erreur de la fonction appelée précédemment. La Valeur de retour est 0, Si la fonction appelée précédemment a fonctionné correctement. Les numéros d’Erreur possibles sont décrits sous Numéros d’erreur.
(Texte standard edition nécessaire)
Renvoie du texte d'erreur d'un appel de fonction ayant précédemment échoué. Si ExceptionValue <> 0 le message d'Erreur Plein peut être consulté avec cette fonction.
Gestionnaire d’objets visible
Fonction sur Montrer ou Masquer la fenêtre GeoDin.
En définissant cette Propriété sur "Vrai" ou "Faux", la Visibilité du gestionnaire de Puits GeoDin est contrôlée.
Informations de licence
Fonctions sur déterminer les Informations concernant la licence.
Cette fonction est Disponible à partir de l'édition Essentiel.
La réponse Contient des informations à propos de GeoDin et les modules Disponible.
Les informations sur la solution avec le Nombre de version constituent une sortie continue, Si elles sont Disponible.
Sélectionner un emplacement
Fonctions sur marquer (Sélection) un Puits inclus le gestionnaire de Puits.
Cette fonction est Disponible à partir du module Base et au-dessus.
L'objet spécifié est marqué, inclus dans le gestionnaire d'objets GeoDin, et devient l'objet actuellement sélectionné. Comme Identification d'objet, la valeur -1 peut également être transmise. Dans ce cas, le projet GeoDin est marqué, inclus dans le gestionnaire d'objets, et devient l'objet actuellement sélectionné.
Base de données
Nom de Connexion à la base de données, par exemple « GeoDin COM example »
Nom d'utilisateur
Nom de connexion de la Base de données (pour Access, un caractère Espace ' ', Non de chaîne Vide !)
Mot de passe
Mot de passe de connexion à la Base de données (pour accéder à un caractère Espace ' ', pas de chaîne Vide !)
ID du projet
L’identification de projet GeoDin (6 chiffres)
ID d'objet
ID d'objet GeoDin
La Valeur de retour de la fonction est 0, Si la fonction est exécutée. La Valeur de retour est 1, Si une Erreur s'est produite. Voir Valeur d’exception ET ExceptionMsg.
Sélectionner un objet
Le Puits spécifié (Base de données, Projet, recherche, Puits, Stations de mesure) est marqué dans le gestionnaire de Puits GeoDin et devient le Puits actuellement.
Le contrôle de la fonction est accessible par une chaîne inclus le Format de papier d’un Bloc de configuration :
Les Paramètres ont la signification suivante :
Base de données
Nom de Connexion à la base de données, par exemple « GeoDin COM example »
Nom d'utilisateur
Nom de connexion à la Base de données (pour Access, Vide, un caractère Espace ' ' est utilisé en interne !)
Mot de passe
Mot de passe de connexion à la Base de données (pour Access, Vide, un caractère Espace ' ' est utilisé en interne !)
Type d'objet
0 - La branche de base de données ou la branche de projet doit être sélectionnée. Pour sélectionner la branche de base de données, le paramètre Nœud parent doit être défini sur =Base de données, les paramètres recherche et ID d'objet restent vides (aucune entrée). Pour sélectionner une branche de projet, le paramètre Nœud parent doit être défini sur =Projet, le paramètre ID d'objet doit contenir l'Identification du Projet (par ex. PuitsIdentification=PRJ001), le Paramètre recherche reste Vide (Non Entrée). 1 - La branche "Objets" ou une Requête objet doit être sélectionné. 2 - La branche "Stations de mesure" ou une recherche de mesure ou une Station de mesure doit être sélectionné.
Nœud parent
=Base de données: définit que le Puits à être sélectionné doit être directement sous la Base de données comme une recherche ou à l'intérieur d'une recherche de ce type. Le Paramètre recherche= définit le Nom de la recherche de ce type. =Base de donnéesRecherches: définit que le Puits à être sélectionné doit être inclus dans la branche Objets (ObjectType=1) ou inclus les mesures de branche (ObjectType=2) de la Base de données. Le Paramètre recherche= définit le Nom de la recherche de ce type. =Projet: définit que le Puits à sélectionner doit être directement sous la recherche ou à l'intérieur d'une recherche de ce type. Le Paramètre recherche= définit le Nom d'une recherche de ce type. =ProjetQueries: définit que le Puits à sélectionner doit être soit inclus dans les Objets de branche (ObjectType=1) ou inclus les mesures de branche (ObjectType=2) du Projet. Le Paramètre recherche= définit le Nom de la recherche.
recherche
Ce Paramètre optionnel définit le Nom de la recherche à être sélectionné ou la recherche, qui Contient le Puits à être sélectionné. Si ce Paramètre n'est pas saisi, GeoDin sélectionne automatiquement les Requêtes «Tous les points» ou la recherche correspondante ou le type de mesure, qui est défini par l'Identification de mesure (trois chiffres) inclus dans l'INVID.
ID d'objet
Le Paramètre ID d'objet spécifie le Puits choisi. Si ID d'objet est Vide ou Contient seulement une Identification de Projet à six chiffres, seulement les branches (inclus ce cas Requêtes), qui sont définies par Nœud parent et recherche, sont sélectionné Sans sélectionner un certain Puits ou Stations de mesure. Un ID d'objet doit être sur l'Identification du Projet directement et doit consister sur une chaîne à quatre chiffres, par exemple PRJ0010022 = Projet Identification : PRJ001 et l’identification de l’objet 22. Le nombre de l’identification de l’objet doit sur Etre complété avec des zéros et doit sur être composé d’exactement quatre caractères. Si une station de mesure doit être sélectionnée, un INVID à seize chiffres doit être saisi, par exemple PRJ001022FIL001. Une exception est la Sélection d’une Requête de mesure de point GeoDin du type « Filtre » OU « Echantillon ». En utilisant un ID d'objet du type = PRJ001????FIL (ObjectType=2, NœudParent=ProjectQueries, recherche=Vide) par exemple la recherche "Filtre" inclus dans la branche des Stations de mesure du Projet PRJ001 peut être sélectionné Sans choisir une certaine Stations de mesure inclus dans cette branche.
Étendre
Ce Paramètre définit si la branche sélectionné doit être ouverte en même temps. Utiliser les entrées =vrai OU =faux sur déterminer le processus d’ouverture. La Texte standard valeur de Étendre est =vrai.
La Valeur de retour de la fonction est 0, Si la fonction a été exécutée. La Valeur de retour est 1, Si une Erreur s'est produite. Voir Valeur d’exception et Exceptions.
Créer une sélection d'objet
Un ou plusieurs Objets sont ajoutés sur le gestionnaire d’Objets GeoDin. Facultativement, une Méthode avec Paramètres peut être Commencé à un Puits ou à un Groupe d’Objets.
Base de données
Nom de Connexion à la base de données, p. ex. "GeoDin COM example"
Nom d'utilisateur
Nom de connexion de la Base de données (pour Access, un caractère Espace ' ', Non de chaîne Vide !)
Mot de passe
Mot de passe de connexion à la Base de données (pour accéder à un caractère Espace ' ', pas de chaîne Vide !)
IDs d'objet
Chaîne avec un ou plusieurs IDs de Puits. Ceux-ci sont interprétés comme des Valeurs INVID inclus dans le cas du Type d'objet = 1 OU 2. Au cas où le Type d’objet = 3 ils sont interprétés comme des valeurs ADC_Identification. Les INVIdentifications peuvent être prises des Tableaux LOCREG, FILREG ou PRBREG ou être construites selon les règles. Les ADC_Identifications doivent être contenus inclus le Tableau ADC_DATA. En saisissant une seule Identification, un seul Puits est ajouté et sélectionné. Lors de la saisie de plusieurs Identifications, celles-ci doivent être séparées par CRLF ($0D$0A) (Puits de liste de chaînes avec plusieurs lignes). Si plusieurs Objets sont ajoutés, un Groupe en Résultats, qui est sélectionné après avoir été ajouté.
Type d'objet
En utilisant PuitsType=0 les Objets sont interprétés comme un Puits. En utilisant ObjectType=1 les Objets sont ajoutés comme Stations de mesure. Cette option est particulièrement pertinente pour les INVID de la Tableau LOCREG, car ils peuvent être soit des Objets, soit des Stations de mesure. L'ajout d'INVID des Tableaux FILREG ou PRBREG avec le PuitsType=0 entraîne une Erreur. En utilisant PuitsType=3 les documents sont ajoutés et les ID sont interprétés comme des ADC_ID.
RefName
Si IDs d'objet Contient seulement un Puits, ce Paramètre est Non utilisé. Pour plusieurs Objets, ce Paramètre devrait Contient un Nom de Groupe pour simplifier la navigation de l'Utilisateur (si une chaîne Vide est choisie le Groupe est nommé "Nouveau groupe").
MethodID
Indication facultative d'un MethodID. Démarre la Méthode correspondante. Est transféré comme MethodID -1, Si Non Méthode est Commencé.
MethodParams
Est seulement utilisé, Si MethodID <> -1. Est utilisé pour contrôler l'appel sur la Méthode. Voir ExecuteMethodParams.
La Valeur de retour de la fonction est 0, Si la fonction est exécutée. La Valeur de retour est 1, Si une Erreur s'est produite. Voir Valeur d’exception ET ExceptionMsg.
MethodListAsString
Fonctions pour le Démarrage des Méthodes GeoDin.
Renvoie une Liste de Méthodes, qui peuvent être appelées à partir du Puits sélectionné. La chaîne de Résultat peut être composée de plusieurs Lignes (séparées par CRLF), où chaque Ligne est une Méthode. Une Entrée de Méthode se compose du MethodID suivi d’une virgule et du Nom de la Méthode (p. ex. 2,Editer le graphique). Le MethodID peut être Utilisé dans la Méthode ExecuteMethod. Si aucune Méthode n’est Disponible, la chaîne renvoyée est Vide.
ExecuteMethod
Cette fonction est Disponible inclus dans le module GeoDin de Base. D’autres modules Mai être nécessaires, selon la Méthode à utiliser (p. ex. Journaux, Laboratoires...).
Les MethodIDs Disponible par l’intermédiaire de cette fonction (ET par l’intermédiaire de ExecuteMethodParams) sont documentés sur Paramètres de la Méthode.
La Valeur de retour de la fonction est 0, Si la fonction est exécutée. La Valeur de retour est 1, Si une Erreur s'est produite.
ExecuteMethodParams
Cette fonction est Disponible inclus dans le module GeoDin de Base. D’autres modules Mai être nécessaires, selon la Méthode à utiliser (p. ex. Journaux, Laboratoires...).
Démarre une Méthode GeoDin avec des Paramètres. Les identifiants valides de Méthode sont décrits sur ExecuteMethod ET inclus Paramètres de la Méthode.
La Valeur de retour de la fonction est 0, Si la fonction est exécutée. La Valeur de retour est 1, Si une Erreur s'est produite.
GetImage
Fonction pour créer une image.
Note : Cette fonction est uniquement Disponible avec une License GeoDin Server. Cette fonctionnalité est Disponible dans le module du serveur d'images.
Base de données
Nom de la Connexion à la base de données, p. ex. "GeoDin COM Example"
Nom d'utilisateur
Nom de connexion de la Base de données (pour Access, un caractère Espace ' ', Non de chaîne Vide !)
Mot de passe
Mot de passe de connexion à la Base de données (pour accéder à un caractère Espace ' ', pas de chaîne Vide !)
ID du projet
Identification de projet GeoDin / identification (6 caractères)
ID d'objet
Identification d'objet GeoDin / numéro d'identification
Nom de version
Chaîne vide '' ou les versions pertinentes des journaux du trou de forage / profil du sol et du plan d'installation sur afficher. Ce Paramètre n'est pris en charge que pour les types d'objets de l'autorité géologique régionale bavaroise (Landesamt). Nom de version Contient soit une chaîne sans caractère de tabulation — le nom de la version du profil du sol est alors indiqué ici — soit Nom de version Contient deux chaînes, reliées par un caractère de tabulation, cela équivaut alors sur le plan sémantique au nom de la version du profil du sol suivi du nom de la version du plan d'installation (SVVersion+chr(9)+ASBVersion). Dans le cas des types d'objets du Landesamt bavarois, les noms des versions sont définis par la PKEY.
Nom du fichier de mise en page
Nom de fichier plein / complet du fichier de mise en page, p. ex. "C:\PROGRAMs\GEODIN\Mises en page\BOREHO1.GLO" OU 'C:\PROGRAMDATA\GEODIN\Mises en page\BOHRPR1.GLO'
Nom du fichier de sortie
Soit une chaîne Vide (pas de fichier créé), soit un Nom de fichier plein / complet pour le Fichier image JPG résultant, p. ex. "C:\SAMPLE1.JPG"
Type d'image
1 (=JPG); 2 (=JPG, des données manquantes ou des éléments graphiques incorrects sont affichés en pointillés, semblable à l'Aperçu avant impression); 11 (=PNG); 12 (=PNG, affiché en pointillés) ; 21 (=EMF); 22 (=EMF, affiché en pointillés); 31 (=WMF); 32 (=WMF, affiché en pointillés)
Résolution maximale
Résolution d'une image bitmap pour le côté le plus long du Format de papier du Sélectionner une mise en page choisi, par ex. 1500
Compression
Gamme de valeurs de 0 sur 100. Contrôle la qualité / compression des images JPG et la vitesse / compression des images PNG. Des informations détaillées sont données ci-dessous.
Echelle
Echelle verticale de l’objet dans La mise en page (écrase les Paramètres dans La mise en page ; les options « Dimensionner sur page » et « Correction automatique en cas d'erreur de représentation » ne sont pas affectées et peuvent conduire à un ajustement automatique de l’Echelle ; les préréglages « Lire de » dans La mise en page sont ignorés).
Numéro de page
Numéro de page à afficher
Nombre de pages
Retour du numéro de page de la visualisation de l’objet actuellement dans l’Echelle sélectionnée
La fonction renvoie l’image sous forme d’OleVariant, de sorte qu’aucun détour via l’OutFile n’est nécessaire.
Note : Le Paramètre Compression n’est pas utilisé par les images EMF ou WMF lors de leur création.
Si vous créez une image EMF, le Paramètre Résolution maximale peut être utilisé pour contrôler la Résolution. En transmettant 0, la Résolution de l’image EMF est calculée en interne (semblable à une exportation directe depuis l’interface utilisateur du programme GeoDin). Si une Valeur > 0 est transmise, la plage horizontale maximale de l’image EMF est ajustée de sorte que la valeur saisie ne soit pas dépassée. L’image résultante peut avoir une plage horizontale plus faible que la valeur saisie, car les Limites de l’image EMF (boîte englobante) sont alignées sur les éléments Graphique contenus. De ce fait, la visualisation avec La mise en page identique peut conduire à des images EMF avec une plage horizontale différente pour différents Sondages, tandis que la plage des images est identique si des images bitmap sont créées.
Utilisation du Paramètre Compression :
JPG : qualité et compression
0 = faible qualité / haute compression
100 = haute qualité / faible compression
Tailles d’exemple avec Résolution maximale = 1500 pour une page A4 avec la mise en page standard « Profil de forage » :
0
48
pas utilisable
25
85
traînées fort intenses
50
109
traînées visibles
75
135
bon affichage
85
157
bon affichage
100
320
image fort claire mais fort grande
PNG : Vitesse et compression
0 = fort chronophage / compression haute
100 = fort rapide / compression faible
0
42
extrêmement chronophage (>30 sec)
25
72
création efficace (5 sec)
50
99
création rapide
75
157
création rapide
75
564
fichier fort volumineux
100
564
fichier fort volumineux
Valeurs supérieures à 70 ne devraient pas être utilisées ; la bibliothèque utilisée crée ces fichiers PNG de façon sporadiquement défectueuse, si bien que les images ne peuvent pas être affichées avec tous les programmes.
Largeur du graphique
Renvoie la largeur du graphique, qui a été créé lors du dernier appel à GetImage. La fonction ne doit être utilisée que si, inclus dans l'application appelée, il n'y a pas de possibilité d'appeler soi-même ces paramètres.
Hauteur du graphique
Renvoie la hauteur du graphique, qui a été créé lors du dernier appel à GetImage. La fonction ne doit être utilisée que si, inclus dans l'application appelée, il n'y a pas de possibilité d'appeler soi-même ces paramètres.
Nombre de pages du graphique
Renvoie le numéro de page, qui a été créé lorsque GetImage ou GetPrintFile a été appelé la dernière fois. Il est égal au paramètre de sortie PageCount des deux fonctions. La fonction ne doit être utilisée que si l'application appelante ne peut pas gérer le paramètre de sortie de l'une ou l'autre de ces fonctions.
SysInfo
Fonction permettant de déterminer les informations système.
Cette fonction est disponible à partir de l'édition Essentiel.
Elle renvoie des informations système selon le paramètre choisi. Les paramètres suivants sont disponibles :
SysInfo(GeODinINIFileName): renvoie le chemin complet et le nom de fichier du GeoDin.ini actuel.SysInfo(ProgramDataFolder): renvoie le chemin des données du programme.SysInfo(Répertoire de l'application): renvoie le répertoire de l'application.
Paramètres de la Méthode
Les sections suivantes décrivent le MethodParams les chaînes acceptées par ExecuteMethod et ExecuteMethodParams pour les Méthodes GeoDin individuelles (identifiées par leur MethodID).
Gestion des données
MethodID = 1 (Gestion des données) - MethodParams:
A) aucune Entrée
La Saisie de données est Commencé (éditeur de Données générales); si cette Méthode est déjà Commencé, le masque de données actuellement actif (Données générales, Données de couche, etc.) reste actif.
B) Sélection du masque d'éditeur souhaité en fournissant une chaîne de données de Paramètre de la forme :
Les numéros disponibles sont :
1
Données générales
2
Données de couche
3
Données d'échantillon
4
Données de l'installation
5
Mesures de forage / sondages
6
Données additionnel (1:n), selon le Type de puits, p. ex. le Tableau des eaux souterraines
Editer le graphique
MethodID = 2 (Editer le graphique) - MethodParams:
A) aucune Entrée
La Liste de mise en page standard est ouverte. La Mise en page actuelle de la Liste de mise en page est affichée.
B) Saisie d’un Nom de fichier (de mise en page), qui doit afficher le Puits.
C) "Sélectionner une mise en page:nom de la mise en page"
La Liste de mise en page standard est ouverte et la mise en page "layoutname" est sélectionnée. Optionnellement, la liste de mise en page, qui doit être utilisée, peut être décrite comme un chemin :
E) "Message : Nom du Rapport"
La Liste de mise en page standard est ouverte et le Rapport "reportname" est sélectionné. Optionnellement, la Liste de mise en page, qui doit être utilisée, peut être décrite comme chemin :
Ouvrir le graphique
MethodID = 4 (Ouvert Graphique) - MethodParams:
Un nom de chemin complet d’un graphique, d’une mise en page ou d’une liste de mises en page GeoDin est attendu. Le fichier est ouvert dans la fenêtre graphique.
Importer des valeurs mesurées
MethodID = 12 (Importer Valeurs mesurées) - MethodParams:
Les noms des Fichiers sont attendus sous forme de chemin Plein Longueur.
Imprimer le Graphique ou le Rapport
MethodID = 13 (Imprimer le Graphique ou le Rapport) - MethodParams:
Non Entrée : L'impression est effectuée Sans boîte de dialogue d'impression à l'Imprimante actuellement utilisée. Si aucun Graphique n'est ouvert (Vue détaillée ou vue d'ensemble de la mise en page) ou s'il n'y a aucun Objets liés à La mise en page dans la vue d'ensemble de la mise en page, rien n'est imprimé ET le numéro d'Erreur 16 est renvoyé.
La sortie imprimée peut éventuellement être configurée en saisissant un bloc de Paramètre :
Nom du périphérique :
Pour l'Imprimante sur Utiliser, inclus GEODIN.INI, une section avec les informations de l'Imprimante doit être saisie. Exemple :
Une description plus détaillée de cette section se trouve dans les informations sur la fonction « GetImprimerFichier ». Nom du périphérique doit contenir une Entrée valide de cette section de configuration.
Nom du fichier :
Si vous devez Utiliser le Paramètre "PrintFileName", entrez un Plein Nom de fichier. Un Fichier existant du même Nom est Ecrasé.
Par exemple, le Bloc de Paramètre ressemblerait à ceci, Si vous voulez Utiliser la fonction Imprimer sur Créer un Fichier PDF :
Lancer le plug-in
MethodID = 14 (Démarrage plug-in) - MethodParams:
Un Bloc de configuration doit être transféré, lequel Contient Au moins l'Entrée :
Comme Nom le Nom distinct de la fonction du plug-in doit être sur saisi.
Note : Le sujet ici n’est pas le Paramètre « Nom », qui est visible dans le gestionnaire de Puits comme le nom de la Plugins, mais le nom de la section de configuration de ce plug-in. Le plug-in doit être configuré et exécutable pour la branche actuellement (node) dans le gestionnaire d’objets. Il peut être masqué dans la liste de méthodes elle-même (Paramètre "Masquer" dans la configuration du plug-in).
Optionnellement, le Bloc de configuration peut contenir une autre section portant le Nom «PluginParams» et N'importe quels Paramètres. Exemple :
Cette section de configuration est transférée sur le plug-in (uniquement les plug-ins de serveur COM) entièrement et n'est pas analysée par GeoDin. De ce fait, N'importe quel Paramètre peut être transféré sur le plug-in en étant appelé via la fonction COM.
Vérifiez les mesures
MethodID = 53 (Vérifier les valeurs mesurées) - MethodParams:
Utiliser la section «Régression» sur vérifier les Valeurs mesurées en utilisant une Analyse de Régression.
La Valeur Sélectionner une mise en page Contient le Nom du Graphique de Régression sur être utilisé.
De plus amples informations sur cette Méthode peuvent être trouvées inclus le chapitre Vérifiez les mesures ET inclus dans la description Calcul de régression de l'Elément des Séries de temps.
Exemple :
Mis à jour
Ce contenu vous a-t-il été utile ?