GEOLOCATION
Voir égalementGére les données géographiques, y compris les zones, les positions des utilisateurs et le suivi.
Les modes qui traitent les positions des utilisateurs ne sont effectifs que pour les utilisateurs connectés avec l'application mobile SnapVue, et si les extensions pour le suivi sont installées.
| Mode | Mnémonique | Syntaxe |
| 1 | GETUSERPOSITION | 1 |
| 2 | GETLATITUDE | 2 |
| 3 | GETLONGITUDE | |
| 4 | GETALTITUDE | |
| 5 | FORMATPOSITION | 3 |
| 6 | ISVALIDPOSITION | 4 |
| 7 | GETDISTANCE | 5 |
| 8 | GETUSERZONE | 1 |
| 9 | GETUSERPOSACCURACY | 6 |
| 10 | GETUSERSATPOSITION | 7 |
| 11 | GETUSERSINZONE | 8 |
| 13 | GETUSERSCOUNT | 9 |
| 14 | ISUSERINZONE | 10 |
| 15 | ISUSERATPOSITION | 11 |
| 16 | GETSPECIFICUSER | 12 |
| 17 | GETUSERSCOUNTFROMSTR | 13 |
| 18 | GETCLOSESTUSERBYPOS | 14 |
| 19 | GETZONEPOSITION | 15 |
Propriétés communes à plus d'un mode
|
Argument |
Définition |
| UserName | Nom d'un utilisateur tel que configuré dans les comptes utilisateurs. Type STR |
| Position | Chaîne de caractère dans le format "lat:Value lon:Value alt:Value" où Value sont des nombres de tout type numérique exprimés en degrés. Exemple "lat:1.23 lon:4.56 alt:7.89" |
| Longitude | Valeur de longitude en degrés. Tout type numérique. |
| Latitude | Valeur de latitude en degrés. Tout type numérique. |
| Altitude | Valeur d'altitude en mètres. Tout type numérique. |
| ProfileRole | Rôle d'un utilisateur, tel que défini par la propriété Rôledu profil attaché au compte utilisateur. Type STR. |
| ProfileLevelMin | Niveau de profil le plus bas. Les niveaux de profils ne sont disponibles que si l'option Stratégie de sécurité avancée est activée. Tout type numérique. |
| ProfileLevelMax | Niveau de profil le plus haut. Les niveaux de profils ne sont disponibles que si l'option Stratégie de sécurité avancée est activée. Tout type numérique. |
| ZoneId | Nom d'une zone telle que configurée dans le nœud Données géographiques de l'Application Explorer. Type STR. |
| ListOfUsers |
Liste d'utilisateurs telle que retournée par GETUSERSATPOSITION ou GETUSERSINZONE. Type STR. |
| Radius |
Un rayon en mètres. Tout type numérique. |
Syntaxe 1
StrVal = GEOLOCATION (Mode, UserName);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 1 | GETUSERPOSITION |
Récupère la position (latitude, longitude, altitude) de l'utilisateur UserName. |
| 8 | GETUSERZONE |
Récupère le nom de la zone dans laquelle l'utilisateur UserName est actuellement situé. Retour : Le nom de la zone. Une chaîne vide est renvoyée si l'utilisateur n'existe pas ou si sa position est inconnue. |
Syntaxe 2
DblVal = GEOLOCATION (Mode, Position);
Type de retour : DOUBLE.
Exécution
|
Mode |
Mnémonique |
Action |
| 2 | GETLATITUDE |
Extrait la longitude de la position Position. Retour : La valeur de la longitude en degrés si OK, 0 sinon (longitude invalide ou absente). |
| 3 | GETLONGITUDE |
Récupère la position de la longitude de la position Position. Retour : La valeur de l'altitude en mètres si OK, 0 sinon (altitude invalide ou absente). |
| 4 | GETALTITUDE |
Extrait l'altitude de la position Position. Retour : La distance en mètres si OK, -1 sinon. |
Il est recommandé de tester la validité de l'argument Position avec le mode ISVALIDPOSITION avant d'utiliser l'un de ces modes pour extraire les composantes de la position. En effet, le concepteur du script peut ainsi s'assurer que la valeur de retour 0 est bien la valeur extraite (latitude ou altitude 0 par exemple), ou s'il s'agit d'un retour indiquant la position passée en argument est incorrecte.
Syntaxe 3
StrVal = GEOLOCATION (Mode, Latitude, Longitude, Altitude);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 7 | FORMATPOSITION |
Formate la valeur d'une chaîne de position en utilisant la longitude, la latitude et l'altitude fournies. Retour : Une chaîne de caractère dans le format Position, si OK, 0 sinon (arguments invalides). |
Syntaxe 4
IntVal = GEOLOCATION (Mode, Position);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 6 | ISVALIDPOSITION |
Vérifie si le format de la chaîne de caractères Position fournie est une position valide. Retour : 1 si la position est valide, 0 si elle ne l'est pas, -1 sinon (arguments invalides). |
Syntaxe 5
DblVal = GEOLOCATION (Mode, PositionA, PositionB);
Type de retour : DOUBLE
|
Argument |
Définition |
|
PositionA PositionB |
Positions géographiques dans le format Position. |
Exécution
|
Mode |
Mnémonique |
Action |
| 8 | GETDISTANCE |
Calcule la distance entre deux points. Retour : La distance en mètres si OK, -1 sinon. |
Syntaxe 6
DblVal = GEOLOCATION (Mode, UserName);
Type de retour : DOUBLE.
Exécution
|
Mode |
Mnémonique |
Action |
| 9 | GETUSERPOSACCURACY |
Calcule le rayon de précision de la position de l'utilisateur spécifié. Retour : Le rayon en mètres si OK, -1 sinon. |
Syntaxe 7
StrVal = GEOLOCATION (Mode, Latitude, Longitude, Radius[, ProfileRole [, ProfileLevelMin [, ProfileLevelMax]]]);
Type de retour : STR
Exécution
|
Mode |
Mnémonique |
Action |
| 10 | GETUSERSATPOSITION |
Récupère la liste des utilisateurs présents à proximité de la position spécifiée par Latitude, Longitude et Radius. La liste d'utilisateurs peur optionnellement être filtrée par rôle et niveau de profil. Retour : Chaîne de caractères contenant une liste d'utilisateurs séparés par des virgules. Une chaîne vide est renvoyée si les arguments sont invalides ou si aucun utilisateur n'est détecté à proximité de la position. |
Syntaxe 8
StrVal = GEOLOCATION (Mode, ZoneId[, ProfileRole [, ProfileLevelMin [, ProfileLevelMax]]]);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 11 | GETUSERSINZONE |
Récupère la liste des utilisateurs présents dans la zone ZoneId. La liste d'utilisateurs peut optionnellement être filtrée par rôle et niveau de profil. Retour : Chaîne de caractères contenant la liste d'utilisateurs séparés par des virgules. Une chaîne vide est renvoyée si les arguments sont invalides ou si aucun utilisateur n'est détecté à proximité de la position. |
Syntaxe 9
IntVal = GEOLOCATION (Mode[, ProfileRole [, ProfileLevelMin [, ProfileLevelMax]]]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 13 | GETUSERSCOUNT |
Récupère le nombre total d'utilisateurs dans l'ensemble du projet, optionnellement filtré par rôle et niveau de profil. Retour : Nombre d'utilisateurs si OK, -1 sinon. |
Syntaxe 10
IntVal = GEOLOCATION (Mode, UserName, ZoneId);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 14 | ISUSERINZONE |
Récupère la position de la zone ZoneId. Retour : 1 si l'utilisateur est localisé dans la zone, 0 s'il ne l'est pas, -1 sinon (arguments invalides, utilisateur inconnu, pas d'information de position pour l'utilisateur). |
Syntaxe 11
IntVal = GEOLOCATION (Mode, UserName, Latitude, Longitude, Radius);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 15 | ISUSERATPOSITION |
Vérifie si l'utilisateur se trouve à la position spécifiée par Latitude, Longitude et Radius. Retour : 1 si l'utilisateur est localisé à la position, 0 s'il ne l'est pas, -1 sinon (arguments invalides, utilisateur inconnu, pas d'information de position pour l'utilisateur). |
Syntaxe 12
StrVal = GEOLOCATION (Mode, ListOfUsers, Index);
Type de retour : STR.
|
Argument |
Définition |
| Index | Une position dans la liste d'utilisateurs. Tout type numérique. |
Exécution
|
Mode |
Mnémonique |
Action |
| 16 | GETSPECIFICUSER |
Récupère le nom de l'utilisateur à la position Index dans la liste des utilisateurs ListOfUsers. Retour : Chaîne contenant le nom d'un utilisateur si OK, une chaîne vide sinon (arguments invalides). |
Syntaxe 13
IntVal = GEOLOCATION (Mode, ListOfUsers);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 17 | GETUSERSCOUNTFROMSTR |
Récupérer le nombre d'utilisateurs dans la ListOfUsers. Retour : Nombre d'utilisateurs si OK, une chaîne vide sinon (arguments invalides). |
Syntaxe 14
StrVal = GEOLOCATION (Mode, Latitude, Longitude[, ProfileRole [, ProfileLevelMin [, ProfileLevelMax [, Index]]]]);
Type de retour : STR
|
Argument |
Définition |
| Index | Index de l'utilisateur dans la liste. 1 = le premier le plus proche, 2 = le deuxième le plus proche, etc.. |
Exécution
|
Mode |
Mnémonique |
Action |
| 18 | GETCLOSESTUSERBYPOS |
Récupère le nom de l'utilisateur le plus proche de la position spécifiée par Latitude et Longitude, optionnellement filtré par rôle et niveau de profil. Retour : Une chaîne contenant le nom d'un utilisateur si OK, sinon une chaîne vide (arguments invalides, aucun utilisateur ne correspond à des critères, aucune information de position disponible). |
Syntaxe 15
StrVal = GEOLOCATION (Mode, ZoneId);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 19 | GETZONEPOSITION |
Récupère la position de la zone ZoneId. Retour : La position de la zone en tant que chaîne formatée Position si OK, sinon une chaîne vide (arguments invalides). |