Entrepôt de référence d'API C#
Les API sont fournies par la classe
IUANode
. Les instances de classe sont des points de départ pour rechercher les nœuds à renvoyer.
IMPORTANT:
S’il existe plusieurs nœuds du même nom, un nœud indésirable peut être renvoyé.
CONSEIL:
Dans Visual Studio et Visual Studio Code, la spécification du type exact (
<T>
) améliore la finalisation du code intelligent et facilite l’identification des erreurs lors de l’écriture du code.Lors de l’exécution, on sait avec certitude si le nœud recherché est du type demandé. Si le nœud recherché n’est pas du type demandé, l’API renvoie
null
.Les API sont fournies par la classe
InformationModel
affichée par le module FTOptix.HMIProject
.
CONSEIL:
Au moment de la conception, l’API fonctionne uniquement si le type spécifié est prédéfini (contenu dans les modules FTOptix).
CONSEIL:
Par défaut, les liens dynamiques définis dans un NetLogic sont en mode lecture seule, tandis que les liens dynamiques créés avec l’interface utilisateur
FactoryTalk Optix Studio
sont en mode lecture et écriture.Arguments
- browsePath(string)
- Peut être :
- BrowseNamede l'objet .
- Le chemin d’accès à l’objet dans le modèle d’information, exprimé de manière unique comme une séquence de valeursBrowseNameséparées par/
- T
- Classe C#IUANodecorrespondant à la classe de l'objet C# à renvoyer.
- IUANode
- Classe C# correspondant à la classe de l’objet C# à renvoyer.
- aliasName(string)
- Peut être :
- BrowseNamede l'alias.
- Le chemin d’accès au nœud dans le modèle d’information, exprimé de manière unique sous la forme d’une séquence de valeursBrowseNameséparées par/
- browseName(string)
- LeBrowseNamedu nœud à rechercher.
- T
- Classe C# IUANode correspondant à la classe d’objet C# à renvoyer.
- child(IUANode)
- Objet C# correspondant au nœud de projet à ajouter.
- browseName(QualifiedName)
- LeBrowseNamedu nouvel objet.
- objectTypeId(NodeId)
- LeNodeIDdu type dont le nouvel objet est dérivé.
- superTypeId(NodeId)
- LeNodeIDdu type dont le nouvel objet est dérivé.
- browseName(QualifiedName)
- LeBrowseNamede la nouvelle variable.
- dataTypeId(NodeId)
- Le type de données contenu dans la nouvelle variable.CONSEIL: Un nœud à l’intérieur de la classeDataTypesreprésente le type de données. Par exemple,OpcUa.DataTypes.Boolean.
- browseName(QualifiedName)
- LeBrowseNamedu nouveau type de variable.
- arrayDimensions(uint[])
- Facultatif. La taille du tableau.
- variableTypeId(NodeId)
- Le type de variable à partir duquel le nouveau type de variable est dérivé.CONSEIL: Un nœud à l’intérieur de la classeVariableTypesreprésente le type de données. Par exemple,FTOptix.CoDeSys.VariableTypes.Tag.
- dataTypeId(NodeId)
- Le type de données contenu dans le nouveau type de variable.CONSEIL: Un nœud à l’intérieur de la classeDataTypesreprésente le type de données. Par exemple,OpcUa.DataTypes.Boolean.
- timeoutMillisecondsDouble
- Le délai d’expiration, exprimé en millisecondes, après lequel l’API génère une exception.CONSEIL: Si elle n’est pas spécifiée, la valeur par défaut de l’argument est30000(30 secondes).
- variables(IUAVariable)
- L’objet C#IUAVariableà ajouter à l’objet sur lequel la méthode est appelée.
- variables(RemoteVariable)
- L’objet C#RemoteVariablequi identifie une cellule d’un tableau unidimensionnel ou multidimensionnel à ajouter à l’objet sur lequel la méthode est appelée.
- variables(IEnumerable<IUAVariable>)
- La listeIUAVariableà ajouter à l’objet sur lequel la méthode est appelée.
- variables(IEnumerable<RemoteVariable>)
- La listeRemoteVariableà ajouter à l’objet sur lequel la méthode est appelée.
- message(string)
- Le message à générer.
- category(string)
- La catégorie de message.
- source(IUAVariable)
- LeBrowseNamede la variable source.
- mode(DynamicLinkMode)
- Un argument facultatif spécifiant le mode de lien dynamique.Les modes de lien dynamique suivants sont disponibles :
- DynamicLinkMode.Read(default)
- Lecture (depuis le nœud source vers le parent).
- DynamicLinkMode.Write
- Écriture (depuis le parent vers la source).
- DynamicLinkMode.ReadWrite
- Lecture et écriture (bidirectionnel).
- ResourceURI
- Un objet C# contenant le chemin d'accès indiqué dans l’argument.
- localizedText(LocalizedText)
- Un objet C# que les propriétésTextIdetNamespaceIndexutilisent pour identifier la clé en question.
- childVariableValues(IEnumerable)
- La liste des variables dont écrire la valeur, exprimée sous la forme de la paire suivante de propriétés de la classeRemoteChildVariableValue:
- RelativePath(string)
- Chemin relatif vers la variable à l'intérieur du nœud.
- Value(UAValue)
- Valeur de la variable.
Renvoie
- T
- Objet C# correspondant au nœud demandé.
- IUANode
- Objet C# correspondant au nœud demandé.
- IUANode
- Objet C# correspondant à l’objet trouvé.
- T
- Objet C# correspondant au nœud trouvé.
- IUAObject
- Objet C# correspondant à l'objet de projet créé.
- T
- Objet C# correspondant à l'objet de projet créé.
- IUAVariable
- Objet C# correspondant à la variable de projet créée.
- IUAVariableType
- Objet C# correspondant au type de variable de projet créé.
Propriétés CSV
- FieldDelimiter
- Caractère utilisé pour délimiter les colonnes. Si cette propriété n’est pas spécifiée, sa valeur est définie par défaut sur la virgule (,).public char FieldDelimiter { get; set; } = ',';
- QuoteChar
- Caractère utilisé pour placer le contenu de chaque champ, ce qui permet d’utiliser le caractèreFieldDelimiterdans le contenu d’un champ si nécessaire. Si cette propriété n’est pas spécifiée, sa valeur est définie par défaut sur les guillemets doubles (").public char QuoteChar { get; set; } = '"';
Fournir une réponse