Armazém de referência de APIs C#

As APIs são fornecidas pela classe
IUANode
. As instâncias de classe estão iniciando os pontos de pesquisa dos nós a serem retornados.
IMPORTANTE: Se vários nós tiverem o mesmo nome, um nó indesejado poderá ser retornado.
DICA:
No Visual Studio e Visual Studio Code, especificar o tipo exato (
<T>
) melhora a conclusão do código inteligente e facilita a identificação de erros ao gravar o código.
Em tempo de execução, fica evidente se o nó pesquisado é do tipo solicitado. Se o nó pesquisado não for do tipo solicitado, a API retornará
null
.
As APIs são fornecidas pela classe
InformationModel
, exibida pelo módulo
FTOptix.HMIProject
.
DICA: Em tempo de design, a API funcionará somente se o tipo especificado for um tipo predefinido (contido nos módulos FTOptix).
DICA: Por padrão, os vínculos dinâmicos definidos em um NetLogic são somente leitura, enquanto os vínculos dinâmicos criados com a UI do
FactoryTalk Optix Studio
 são de leitura e gravação.

Argumentos

browsePath
 (string)
Pode ser um dos seguintes:
  • O
    BrowseName
     do objeto
  • O caminho do objeto no modelo de informação, expresso exclusivamente como uma sequência de valores de
    BrowseName
     separados por
    /
T
Uma classe C#
IUANode
 que corresponde à classe do objeto C# a ser retornado.
IUANode
Uma classe C# que corresponde à classe do objeto C# a ser retornado.
aliasName
 (string)
Pode ser um dos seguintes:
  • O
    BrowseName
     do alias
  • O caminho para o nó no modelo de informação, expresso exclusivamente como uma sequência de
    BrowseName
    s separados por
    /
browseName
 (string)
O
BrowseName
 do nó a ser encontrado.
T
Uma classe C# IUANode que corresponde à classe do objeto C# a ser retornado.
child
 (IUANode)
Um objeto C# que corresponde ao nó do projeto a ser adicionado.
browseName
 (QualifiedName)
O
BrowseName
 do novo objeto.
objectTypeId
 (NodeId)
O
NodeID
 do tipo do qual o novo objeto é derivado.
superTypeId
 (NodeId)
O
NodeID
 do tipo do qual o novo objeto é derivado.
browseName
 (QualifiedName)
O
BrowseName
 da nova variável.
dataTypeId
 (NodeId)
O tipo de dados contido na nova variável.
DICA: Um nó dentro da classe
DataTypes
 representa o tipo de dados. Por exemplo,
OpcUa.DataTypes.Boolean
.
browseName
 (QualifiedName)
O
BrowseName
 do novo tipo de variável.
arrayDimensions
 (uint[ ])
Opcional. O tamanho da matriz.
variableTypeId
 (NodeId)
O tipo da variável do qual o novo tipo de variável é derivado.
DICA: Um nó dentro da classe
VariableTypes
 representa o tipo de dados. Por exemplo,
FTOptix.CoDeSys.VariableTypes.Tag
.
dataTypeId
 (NodeId)
O tipo de dados contido no novo tipo de variável.
DICA: Um nó dentro da classe
DataTypes
 representa o tipo de dados. Por exemplo,
OpcUa.DataTypes.Boolean
.
timeoutMilliseconds
 (double)
O período de tempo limite, expresso em milissegundos, após o qual a API lança uma exceção.
DICA: Se não especificado, o valor padrão do argumento é
30000
 (30 segundos).
variables
 (IUAVariable)
O objeto C#
IUAVariable
 a ser adicionado ao objeto no qual o método é invocado.
variables
 (RemoteVariable)
O objeto C#
RemoteVariable
 que identifica uma célula de uma matriz unidimensional ou multidimensional a ser adicionada ao objeto no qual o método é invocado.
variables
 (IEnumerable<IUAVariable>)
A lista
IUAVariable
 a ser adicionada ao objeto no qual o método é invocado.
variables
 (IEnumerable<RemoteVariable>)
A lista
RemoteVariable
 a ser adicionada ao objeto no qual o método é invocado.
message
 (string)
A mensagem a ser gerada.
category
 (string)
A categoria de mensagens.
source
 (IUAVariable)
O
BrowseName
 da variável de origem.
mode
 (DynamicLinkMode)
Um argumento opcional que especifica o modo de vínculo dinâmico.
Os seguintes modos de vínculo dinâmico estão disponíveis:
DynamicLinkMode.Read
 (default)
Leitura (do nó de origem ao pai).
DynamicLinkMode.Write
Gravação (do pai à origem).
DynamicLinkMode.ReadWrite
Leitura e gravação (bidirecional).
ResourceURI
Um objeto C# que contém o caminho indicado no argumento.
localizedText
 (LocalizedText)
Um objeto C# que as propriedades
TextId
 e
NamespaceIndex
 identificam a chave de interesse.
childVariableValues
 (IEnumerable)
A lista das variáveis cujo valor desejamos escrever, expressas como um par das seguintes propriedades da classe
RemoteChildVariableValue
:
RelativePath
 (string)
O caminho em relação à variável dentro do nó.
Value
 (UAValue)
O valor da variável.

Retornos

T
Um objeto C# que corresponde ao nó solicitado.
IUANode
Um objeto C# que corresponde ao nó solicitado.
IUANode
Um objeto C# que corresponde ao objeto encontrado.
T
Um objeto C# que corresponde ao nó encontrado.
IUAObject
Um objeto C# que corresponde ao objeto do projeto criado.
T
Um objeto C# que corresponde ao objeto do projeto criado.
IUAVariable
Um objeto C# que corresponde à variável do projeto criada.
IUAVariableType
Um objeto C# que corresponde ao tipo de variável do projeto criado.

Propriedades CSV

FieldDelimiter
O caractere usado para delimitar as colunas. Se essa propriedade não for especificada, seu valor assume como padrão o caractere de vírgula (
,
).
public char FieldDelimiter { get; set; } = ',';
QuoteChar
O caractere utilizado para incluir o conteúdo de cada campo, o que permite usar o caractere
FieldDelimiter
 no conteúdo de um campo, se necessário. Se essa propriedade não for especificada, seu valor assume como padrão o caractere de aspas duplas (
"
).
public char QuoteChar { get; set; } = '"';
Dê sua opinião
Tem dúvidas ou comentários sobre esta documentação? Por favor, envie seu comentário aqui.