Almacén de referencia de API de C#

La clase
IUANode
suministra las API. Las instancias de clase son puntos iniciales para buscar los nodos que se van a devolver.
IMPORTANTE: Si hay varios nodos con el mismo nombre, es posible que se devuelva un nodo no deseado.
CONSEJO:
En Visual Studio y Visual Studio Code, la especificación del tipo exacto (
<T>
) mejora la finalización del código inteligente y facilita la identificación de errores al escribir el código.
En tiempo de ejecución, resulta obvio si el nodo que se busca es del tipo solicitado. Si el nodo buscado no es del tipo solicitado, la API devuelve
null
.
La clase
InformationModel
suministra las API, mostradas por el módulo
FTOptix.HMIProject
.
CONSEJO: En tiempo de diseño, la API solo funciona si el tipo especificado es un tipo predefinido (contenido en los módulos de FTOptix).
CONSEJO: De forma predeterminada, los vínculos dinámicos definidos en un NetLogic son de solo lectura, mientras que los vínculos dinámicos creados con la interfaz de usuario
FactoryTalk Optix Studio
son de lectura y escritura.

Argumentos

browsePath
(string)
Puede ser una de las siguientes opciones:
  • BrowseName
    del objeto
  • La ruta del objeto en el modelo de información, expresada de manera exclusiva como una secuencia de valores
    BrowseName
    separados por
    /
T
Clase C#
IUANode
que corresponde a la clase del objeto C# que se va a devolver.
IUANode
Una clase C# que corresponde a la clase del objeto C# que se va a devolver.
aliasName
(string)
Puede ser una de las siguientes opciones:
  • BrowseName
    del alias
  • La ruta del nodo en el modelo de información, expresada de manera exclusiva como una secuencia de valores
    BrowseName
    separados por
    /
browseName
(string)
El
BrowseName
del nodo que se va a buscar.
T
Una clase C# IUANode, correspondiente a la clase de objeto C# que se va a devolver.
child
(IUANode)
Un objeto C# que corresponde al nodo de proyecto creado.
browseName
(QualifiedName)
El
BrowseName
del nuevo objeto.
objectTypeId
(NodeId)
El
NodeID
del tipo de nodo del cual se deriva el nuevo objeto.
superTypeId
(NodeId)
El
NodeID
del tipo de nodo del cual se deriva el nuevo objeto.
browseName
(QualifiedName)
El
BrowseName
de la nueva variable.
dataTypeId
(NodeId)
El tipo de datos contenido en la nueva variable.
CONSEJO: Un nodo dentro de la clase
DataTypes
representa el tipo de datos. Por ejemplo,
OpcUa.DataTypes.Boolean
.
browseName
(QualifiedName)
El
BrowseName
del nuevo tipo de variable.
arrayDimensions
(uint[ ])
Opcional. El tamaño de la matriz.
variableTypeId
(NodeId)
El tipo de variable del que se deriva el nuevo tipo de variable.
CONSEJO: Un nodo dentro de la clase
VariableTypes
representa el tipo de datos. Por ejemplo,
FTOptix.CoDeSys.VariableTypes.Tag
.
dataTypeId
(NodeId)
El tipo de datos contenido en el nuevo tipo de variable.
CONSEJO: Un nodo dentro de la clase
DataTypes
representa el tipo de datos. Por ejemplo,
OpcUa.DataTypes.Boolean
.
timeoutMilliseconds
(doble)
El período de tiempo de espera, expresado en milisegundos, después del cual la API lanza una excepción.
CONSEJO: Si no se especifica, el valor predeterminado del argumento es
30000
(30 segundos).
variables
(IUAVariable)
El objeto C#
IUAVariable
para agregar al objeto en el que se invoca el método.
variables
(RemoteVariable)
El objeto C#
RemoteVariable
que identifica una celda de una matriz unidimensional o multidimensional que se va a agregar al objeto en el que se invoca el método.
variables
(IEnumerable<IUAVariable>)
La lista
IUAVariable
que se va a agregar al objeto en el que se invoca el método.
variables
(IEnumerable<RemoteVariable>)
La lista
RemoteVariable
que se va a agregar al objeto en el que se invoca el método.
message
(string)
El mensaje que se va a generar.
category
(string)
La categoría de mensaje.
source
(IUAVariable)
BrowseName
de la variable de origen.
mode
(DynamicLinkMode)
Un argumento opcional que especifica el modo de vínculo dinámico.
Los siguientes modos de vínculos dinámicos están disponibles:
DynamicLinkMode.Read
(default)
Lectura (del nodo de origen al primario).
DynamicLinkMode.Write
Escritura (de primario a origen).
DynamicLinkMode.ReadWrite
Lectura y escritura (bidireccional).
ResourceURI
Un objeto C# que contiene la ruta indicada en el argumento.
localizedText
(LocalizedText)
Un objeto C# en el que las propiedades
TextId
y
NamespaceIndex
identifican la clave de interés.
childVariableValues
(IEnumerable)
La lista de las variables cuyo valor desea escribir, expresada como un par de las propiedades de clase
RemoteChildVariableValue
siguientes:
RelativePath
(string)
Ruta relativa a la variable dentro del nodo.
Value
(UAValue)
El valor de la variable.

Retornos

T
Un objeto C# que coincide con el nodo solicitado.
IUANode
Un objeto C# que coincide con el nodo solicitado.
IUANode
Un objeto C# que corresponde al objeto encontrado.
T
Un objeto C# que corresponde al nodo encontrado.
IUAObject
Un objeto C# que corresponde al objeto de proyecto creado.
T
Un objeto C# que corresponde al objeto de proyecto creado.
IUAVariable
Un objeto C# que corresponde a la variable de proyecto creada.
IUAVariableType
Un objeto C# que coincida con el tipo de variable del proyecto creado.

Propiedades de CSV

FieldDelimiter
El carácter utilizado para delimitar las columnas. Si no se especifica esta propiedad, su valor predeterminado es el carácter de coma (
,
).
public char FieldDelimiter { get; set; } = ',';
QuoteChar
El carácter utilizado para adjuntar el contenido de cada campo, lo que permite usar el carácter
FieldDelimiter
en el contenido de un campo, si fuera necesario. Si no se especifica esta propiedad, su valor predeterminado es el carácter de comillas dobles (
"
).
public char QuoteChar { get; set; } = '"';
Entregue su opinión
¿Tiene dudas o comentarios acerca de esta documentación? Por favor deje su opinión aquí.