Page principale | Liste par ordre alphabétique | Liste des composants | Liste des fichiers | Composants | Déclarations | Pages associées

Référence du fichier kuka_api.h

Aller au code source de ce fichier.

Composants

struct  kukaAxis_s
 Description d'une configuration en fonction de chaque articulation. Plus de détails...

struct  kukaFrame_s
 Description d'un point (position/orientation) dans l'espace. Plus de détails...

struct  kukaPos_s
 Description sans equivoque d'un point (position/orientation). Plus de détails...

struct  kukaError_s
 Description des erreurs. Plus de détails...

struct  kukaVal
 Union de valeurs typées. Plus de détails...

struct  kukaVar_s
 Définition d'une variable. Plus de détails...


Types simples.

typedef float kukaReal_t
typedef int kukaInt_t
typedef int kukaBool_t
typedef char kukaChar_t
typedef kukaChar_t kukaString_t [KUKA_STRING_LEN]

Types structurées.

typedef kukaAxis_s kukaAxis_t
typedef kukaFrame_s kukaFrame_t
typedef kukaPos_s kukaPos_t

Enumération des types de variables.

typedef enum kukaType_e kukaType_t
enum  kukaType_e {
  KUKA_UNKNOWN = 0x0000 | 0x000,
  KUKA_SIMPLE = 0x0000 | 0x0001,
  KUKA_INT = 0x0010 | KUKA_SIMPLE,
  KUKA_REAL = 0x0020 | KUKA_SIMPLE,
  KUKA_BOOL = 0x0030 | KUKA_SIMPLE,
  KUKA_CHAR = 0x0040 | KUKA_SIMPLE,
  KUKA_STRING = 0x0050 | KUKA_SIMPLE,
  KUKA_STRUCT = 0x0000 | 0x0002,
  KUKA_AXIS = 0x0010 | KUKA_STRUCT,
  KUKA_FRAME = 0x0020 | KUKA_STRUCT,
  KUKA_POS = 0x0030 | KUKA_STRUCT,
  KUKA_ERROR = 0x0000 | 0x000a
}

Déclarations relatives aux erreurs.

typedef enum kukaErrorType_e kukaErrorType_t
typedef kukaError_s kukaError_t
enum  kukaErrorType_e {
  KUKA_KUKA_E = 0x0010 | KUKA_ERROR,
  KUKA_CROSS_E = 0x0020 | KUKA_ERROR,
  KUKA_RPC_E = 0x0030 | KUKA_ERROR,
  KUKA_API_E = 0x0040 | KUKA_ERROR
}

Définition de la composition d'une variable.

typedef kukaVal kukaVal

Définition d'une variable.

typedef kukaVar_s kukaVar_t

Fonctions de base

Ces fonctions retournent 1 si elles ont généré une erreur. L'erreur est consultable via la variable statique kukaError de la lib kuka_api.
Note:
Un pointeur sur kukaError s'obtient en invoquant kuka_getError.


int kuka_initialize (char *serveur)
int kuka_uninitialize (void)
int kuka_getVar (kukaVar_t *varInOut)
int kuka_setVar (kukaVar_t *varIn)
int kuka_loadModule (char *module)
int kuka_unloadModule (void)

Fonctions utilitaires

void kuka_displayVar (kukaVar_t *var)
void kuka_getError (kukaVar_t **kukaError)

Description détaillée

Ce fichier décrit l'interface d'utilisation de kuka. Cette interface définit des fonctions de "bas-niveaux", et un rapport d'erreur permettant de construire par dessus une interface dont les fonctions seraient plus spécifiques ( par exemple move, openGripper, ...).

Documentation du type

typedef float kukaReal_t
 

Les 'real' renvoyés par kuka seront interprétés comme des 'float' en c.

typedef int kukaInt_t
 

Les 'int' renvoyés par kuka seront interprétés comme des 'int' en c.

typedef int kukaBool_t
 

Les 'bool' renvoyés par kuka seront interprétés comme des 'int' en c.

typedef char kukaChar_t
 

Les 'char' simples n'existent pas en krl, il y a seulement des chaines de charactères.

Voir également:
kukaString_t

typedef kukaChar_t kukaString_t[KUKA_STRING_LEN]
 

Les chaines de charactères du KRL seront interprétés comme des tableaux de char en c.

typedef struct kukaAxis_s kukaAxis_t
 

typedef struct kukaFrame_s kukaFrame_t
 

typedef struct kukaPos_s kukaPos_t
 

typedef enum kukaType_e kukaType_t
 

typedef enum kukaErrorType_e kukaErrorType_t
 

typedef struct kukaError_s kukaError_t
 

typedef struct kukaVal kukaVal
 

typedef struct kukaVar_s kukaVar_t
 

Documentation du type de l'énumération

enum kukaType_e
 

Cette enumération permet de lister les types dont nous disposons. De 10 à 19 nous avons les types simples De 20 à 29 nous avons les types structures De

Éléments énumérés:
KUKA_UNKNOWN 
KUKA_SIMPLE  Les types simples sont les kukaInt_t, kukaReal_t, kukaBool_t, kukaChar_t et les kukaString_t
KUKA_INT 
KUKA_REAL 
KUKA_BOOL 
KUKA_CHAR 
KUKA_STRING 
KUKA_STRUCT  Les types structure sont les : kukaAxis_s, kukaFrame_s, kukaPos_s
KUKA_AXIS 
KUKA_FRAME 
KUKA_POS 
KUKA_ERROR 

enum kukaErrorType_e
 

Enumération des différents types d'erreur.

Éléments énumérés:
KUKA_KUKA_E  Ces erreur sont générées par le robot (coté serveur donc).
KUKA_CROSS_E  Ces erreur sont générées par les appels de fonctions d'accés au composant com crosscommexe (coté serveur donc).
KUKA_RPC_E  Ces erreur sont générées par les appels de fonctions rpc (coté client donc).
KUKA_API_E  Ces erreur sont générées par les appels de fonctions de l'api (coté client donc).

Documentation de la fonction

int kuka_initialize (  char *  serveur  ) 
 

kuka_initialize :

  • se connecte au serveur rpc,
  • invoque l'initialisation du cross (qui initialise COM),
  • invoque la connection au cross.

Paramètres:
serveur est un pointeur vers la chaine de charactères contenant le nom du serveur ("kuka" généralement).
Renvoie:
1 si échec.

0 si succés.

int kuka_uninitialize (  void   ) 
 

kuka_uninitialize permet simplement de tout finaliser et de tout déconnecter.

Renvoie:
1 si échec.

0 si succés.

int kuka_getVar (  kukaVar_t *  varInOut  ) 
 

kuka_getVar permet de récupérer la valeur d'une variable en fonction de son nom et de son type.

Paramètres:
varInOut est un pointeur vers la variable.
Les pré-conditions pour cette variable sont :
  • le champ nom contient le nom de la variable.
  • le champ valeur.type contient le type de la varable.

Les post-conditions pour cette variable sont :

  • en cas de succés le champ valeur.kukaVal_u.kuka*** contient la valeur
  • en cas d'echec varInOut contient une copie de kukaError.

Renvoie:
1 si échec.

0 si succés.

int kuka_setVar (  kukaVar_t *  varIn  ) 
 

kuka_setVar permet de définir la valeur d'une variable en fonction de son nom et de son type.

Paramètres:
varIn est un pointeur vers la variable.
Les pré-condition pour cette variable sont :
  • le champ nom contient le nom de la variable.
  • le champ valeur.type contient le type de la varable.

Les Post-conditions pour cette variable sont : *varIn reste inchangé.

Renvoie:
1 si échec.

0 si succés.

int kuka_loadModule (  char *  module  ) 
 

Attention:
Ne pas utiliser pour l'instant

int kuka_unloadModule (  void   ) 
 

Attention:
Ne pas utiliser pour l'instant

void kuka_displayVar (  kukaVar_t *  var  ) 
 

Cette fonction permet d'afficher les informations d'une variable sur la sortie standard.

void kuka_getError (  kukaVar_t **  kukaError  ) 
 

Cette fonction a une double utilité :

  • elle affecte au pointeur kukaError l'adresse d'une variable déclarée statique dans la lib kuka_api. Grace à ce pointeur nous pouvons consulter un "rapport d'erreur".
  • elle met à jour le "rapport d'erreur".

Voir également:
kukaError_s
Paramètres:
kukaError==NULL la fonction met à jour le rapport d'erreur.
kukaError!=NULL récupère le rapport d'erreur

Cette documentation a été généré le 8 Sep 2003 par Doxygen version 1.3.2.
Pour tout renseignements :