guía de usuario parte 10scada.com/content/userguides/statusenterprise_es/st… · ·...

Guía de Usuario Parte 10

Referencia del Modelo de Objetos

Status Enterprise Referencia del Modelo de Objetos

1

Contenidos 1 TÉRMINOS, DEFINICIONES Y ABREVIATURAS. ............................................................................... 4

1.1 Términos ............................................................................................................................... 4 1.1.1 Activo. ................................................................................................................................ 4 1.1.2 Modelo de Datos ................................................................................................................ 4 1.1.3 “Mimic” o Representación .................................................................................................. 4 1.1.4 Plantilla de “Mimic” ............................................................................................................ 4 1.1.5 Status Object Model .......................................................................................................... 4 1.1.6 Espacio de trabajo o “Workspace” .................................................................................... 4 1.2 Abreviaturas .......................................................................................................................... 4

2 RESUMEN

2.1.1 OPC UA ............................................................................................................................. 5 2.1.2 “SResult” ............................................................................................................................ 5 2.2 Clase StatusServerClient ...................................................................................................... 5 2.2.1 Propiedades ....................................................................................................................... 5 2.2.2 Métodos ............................................................................................................................. 6 2.2.3 Eventos .............................................................................................................................. 6 2.3 LoginDialog ........................................................................................................................... 6 2.4 Clase StatusObjectModel ..................................................................................................... 7 2.4.1 Propiedades ....................................................................................................................... 7 2.4.2 Métodos ............................................................................................................................. 8 2.4.3 Eventos ............................................................................................................................ 10 2.4.4 Sintaxis de la Consulta para GetNodeIdsFromQuery ..................................................... 10

3 CLASE BASE DEL MODELO DE OBJETOS ................................................................................... 11

3.1 Base de Objetos ................................................................................................................. 11 3.1.1 Propiedades ..................................................................................................................... 11 3.1.2 Metodos ........................................................................................................................... 11 3.1.3 Eventos ............................................................................................................................ 12 3.2 “RootCollectionBase” .......................................................................................................... 12 3.2.1 Metodos ........................................................................................................................... 12 3.3 “StatusObjectType” ............................................................................................................. 12 3.3.1 Propiedades ..................................................................................................................... 13 3.3.2 Metodos ........................................................................................................................... 13 3.3.3 Eventos ............................................................................................................................ 14

4 TIPOS Y PROPIEDADES. ............................................................................................................. 15

4.1 Tipo de Activo ..................................................................................................................... 15 4.1.1 Propiedades ..................................................................................................................... 15 4.1.2 Metodos ........................................................................................................................... 15 4.1.3 Eventos ............................................................................................................................ 16 4.2 Elmento de Datos ............................................................................................................... 16 4.2.1 Propiedades ..................................................................................................................... 16 4.2.2 Metodos ........................................................................................................................... 17 4.3 Elemento “Analog” .............................................................................................................. 17 4.3.1 Propiedades ..................................................................................................................... 17 4.4 Elemento “Discrete Data” ................................................................................................... 18 4.4.1 Properties......................................................................................................................... 18 4.5 Elemento “Byte Array” ........................................................................................................ 18 4.6 Elemento Enumeración ...................................................................................................... 18 4.6.1 Propiedades ..................................................................................................................... 18

5 ACTIVO

5.1.1 Propiedades ..................................................................................................................... 19


2

5.1.2 Metodos ........................................................................................................................... 19

6 ARCHIVOS ................................................................................................................................ 20

6.1 “UserFile” ............................................................................................................................ 20 6.1.1 Propiedades ..................................................................................................................... 20

7 REGISTRO ................................................................................................................................ 21

7.1 “LoggingConfiguration” ....................................................................................................... 21 7.1.1 Propiedades ..................................................................................................................... 21

8 ESPACIOS DE TRABAJO Y SEGURIDAD ....................................................................................... 22

8.1 Cuenta de Usuario .............................................................................................................. 22 8.1.1 Propiedades ..................................................................................................................... 22 8.2 Rol ....................................................................................................................................... 22 8.2.1 Propiedades ..................................................................................................................... 22 8.3 Espacios de Trabajo ........................................................................................................... 22 8.3.1 Propiedades ..................................................................................................................... 22

9 SUSCRIBIENDONOS A ALARMAS Y CAMBIOS DE DATOS. ............................................................. 23

9.1 Suscrpción .......................................................................................................................... 23 9.1.1 Propiedades ..................................................................................................................... 23 9.1.2 Metodos ........................................................................................................................... 23


3

Imágenes y Tablas Imagen 1 – Inicio de Sesión del Servidor Status .......................................................................................... 7


4

1 Términos, Definiciones y Abreviaturas. Este Documento comenta en lineas generales la experiencia de la interfaz de usuario para el cliente del entorno de ejecución Windows de Status Enerprise, comocido como el Explorador de Soluciones Status.

1.1 Términos

1.1.1 Activo. Una instancia de un Tipo. Una representación lógica de una “cosa” específica in el Sistema que estamos monitorizando.

1.1.2 Modelo de Datos El “Data Model” es una representación lógica de un sistema que queremos monitorizar o controlar, definido con “Types, Components, Alarms” y “Assets”.

1.1.3 “Mimic” o Representación Un “Mimic” o pantalla de gráficos con imágenes y varios controles de interfaces de usuario conectadas a datos en tiempo-real, usadas para monitorizar y controlar datos externos, usualmente datos provenientes de equipamiento y procesos; a veces llamado pantalla HMI (Interfaz Humano-Maquina) o cuadro de mandos.

1.1.4 Plantilla de “Mimic” Una pantalla asociada a un tipo específico de activo. Las plantillas de pantallas pueden ser abiertas con cualquier activo que sea de los mismos tipos o activos a los que esté asociada.

1.1.5 Status Object Model Una librería .NET que puede ser usada para interactuar con tu Modelo de Datos permitiendo la creación de un flujo de trabajo y otras complejas interacciones en tu sistema.

1.1.6 Espacio de trabajo o “Workspace” Un Objeto de accesibilidad para restringir el acceso en el Modelo de Datos. Los Usuarios y Roles pueden ser asociados con un “Workspace”. Las propiedades, Activos y otros objetos del Modelo de Datos pueden también ser asociados con un “Workspace”. Los Usuarios solo pueden acceder a objetos que están dentro de los “Workspace” a los cuales pertenecen.

1.2 Abreviaturas

Abreviatura Definición

DA Acceso a Datos

HMI Interfaz Humano-Máquina

ODBC “Open Database Connectivity”

OPC Fundación OPC

PLC Controlador Lógico Programable

SCADA Supervisión de Control y Adquisición de Datos

UA Arquitectura Unificada

XAML “Extensible Application Markup Language” de Microsoft


5

2 Resumen El Modelo de Objetos Status es una librería .NET que te permite el acceso mediante programación al Servidor Status con clases de nivel alto. Tu puedes monitorizar los cambios de los valores de las propiedades de los activos, creando nuevos objetos en el modelo de Objetos, monitorizar alarmas, actualizar valores de propiedades y generar un modelo de datos. El Modelo de Objetos Status es útil para crear tus propias aplicaciones personalizadas, que comuniquen con el Servidor Status. Usando el Modelo de Objetos tu podrás crear aplicaciones de flujos de trabajo, de ejecución de fabricación, aplicaciones por lotes y enlazar a otros sistemas en tu organización con datos provenientes del Servidor Status.

2.1.1 OPC UA

Muchos de los Tipos usados como parametros en llamadas a métodos del Modelo de Objetos son Tipos que pertenecen a OPC UA.

2.1.2 “SResult”

“SResult” es una estructura usada para notificaciones de error. A menos que esté especificado de otra forma, todos los métodos en el modelo de obetos devuelven “SResult OK” como éxito. Para llamadas sin éxito, “SResult” devuelve códigos de estado OPC UA e información de excepciones con las líneas generales de porqué una llamada exitosa no ha podido ser completada.

2.2 Clase StatusServerClient La Clase “StatusServerClient” es responsable de conectar al servidor y alojar la sesión cliente OPC UA. Esta es la calse que es devuelta desde el “LoginDialog”, pero tu tendrías que usar directamente el inicio de sesión sin cabecera. Para conseguir la clase StatusObjectModel desde el StatusServerClient, llama al método GetObjectModel(). Para terminar una sesión con el Servidor Status llama al método EndSession();

2.2.1 Propiedades

Propiedad Tipo Descripción

AuthenticationType AuthenticationType El Tipo de autenticación que usa cuando conecta con el Status Server.

Certificate X509Certificate Un certificado opcional para usar durante la autenticación con el servidor.

MessageSecurityMode MessageSecurityMode Especifica el tipo de mensaje de seguridad usado entre el cliente y el servidor.

Password string A contraseña del usuario.

SecurityPolicy SecurityPolicy El tipo de política de seguridad usada cuando conectamos al servidor.


6

UserName string El Nombre de usuario usado para la autenticación.

2.2.2 Métodos

Método Parámetros Descripción

Connect - ninguno - Conecta el servidor Status con la sesión actual.

EndSession - ninguno - Finaliza la sesión con el servidor y desconecta el cliente.

GetObjectModel out StatusObjectModel statusObjectModel - el modelo de objetos que debe ser devuelto al llamante.

Suministra el “StatusObjectModel” para la sesión actual.

2.2.3 Eventos

Evento Tipo Descripción

MajorProgressEvent ProgressNotificationHandler Dispara un evento del progreso de carga del modelo de datos que ha cambiado suministrando la información actualizada para mostrar al usuario.

MinorProgressEvent ProgressNotificationHandler Dispara un evento del modelo de datos que carga los cambios.

2.3 LoginDialog

La clase LoginDialog muestra el interfaz del usuario para iniciar sesión en el Status Server. Esto crea un StatusServerClient y llama a los métodos apropiados para conectar al Servidor Status.


7

Imagen 1 – Inicio de Sesión del Servidor Status

LoginDialog loginDialog = new LoginDialog(); loginDialog.Owner = this; if (loginDialog.ShowDialog() == false) { return SResult.Create(StatusCodes.Bad, StatusStrings.USER_CANCELED,""); } _statusServerClient = loginDialog.StatusServerClient; return SResult.Good;

2.4 Clase StatusObjectModel StatusObectModel es la raíz del modelo de objetos para Status Enterprise. Es Usado para acceder a las colecciones raíz del modelo de objetos y prove algunas llamadas a métodos de sistema.

2.4.1 Propiedades

Propiedad Tipo Deescripción

AssetTypes AssetTypes Una colección de los tipos de raíz en el modelo de objetos.

DiscreteItemTexts DiscreteItemTexts Una colección de “DiscreteItemTexts” en el modelo de objetos

EngineeringUnits EngineeringUnits Una colección de “EngineeringUnits” en el modelo de objetos


8

Enumerations Enumerations Una colección de Enumeraciones en el modelo de objetos.

LoggingConfigurations LoggingConfigurations Las configuraciones de Inicio de Sesión disponibles en el modelo de Datos.

Roles Roles Los Roles configurados para el modelo de objetos.

UserAccounts UserAccounts Las cuentas de usuario configuradas para el modelo.

Views Views Una colección de Vistas del modelo de objetos.

Workspaces Workspaces Los Espacios de Trabajo configurados para el modelo.

2.4.2 Métodos

Method Parameters Description

BulkWrite WriteValuesCollection writeValues – descripciones de las propiedades y valores que deben de ser escritos.

out DiagnosticsInfoCollection diagnostics – información de diagnostico de cada elemento que sea escrito.

out StatusCodeCollection statusCodes – códigos de estado para cada elemento que sea escrito.

Escribe un bloque de cambios de valores de propiedades en el servidor.

CreateSubscription out Subscription subscription – La suscripción nueva que ha sido creada.

Crea una nueva suscripción que puede ser usada para monitorizar cambios en propiedades.

DeleteAllSubscriptions - ninguno - Borra todas las suscripciones y cancela las suscripciones a todos los elementos de datos.

DeleteSubscription Subscription subscription – La suscripción a borrar. Borra la suscripcion y cancela las suscripciones a todos los elementos de datos.

GetAttributeValues List<NodeId> nodeIds – Lista de IDs de los nodos para conseguir valores

uint attribute – El ID del atributo que se ha registrado. Usa OPC UA para los valores de los atributos.

out DataValueCollection dataValueCollection – El resultado de los valores para cada nodo.

Directamente consigue el valor para cada nodo desde el servidor sin crear “ObjectBase” dando un atributo especifico (DisplayName, Value, etc).

GetAttributeValues List<NodeId> nodeIds – Lista de IDs de los nodos para conseguir valores

List<uint> attribute – Lista de IDs de atributos que se han registrado. Usa OPC UA para los valores de los atributos.

out DataValueCollection dataValueCollection – El resultado de los valores para cada nodo.

Directamente consigue el valor para cada nodo desde el servidor sin crear “ObjectBase” dando un atributo especifico (DisplayName, Value, etc).

GetReferences List<NodeId> nodeIds – La lista de los IDs de los nodos.

NodeId referenceTypeId – La referencia de los tipos de los nodos para navegación.

out BrowseResultCollection – La lista de los “BrowseResult” que contiene la referencia de los nodos.

Consigue las referencias dadas de cada nodo basados en la “referencetypeId” dada.

GetNodeIdFromBrowsePath String browsePath – La ruta al nodo.

out NodeId nodeId – el nodo si se encuentra.

Consigue el ID del nodo desde la ruta especificada usando la raíz como el punto de partida.


9

GetNodeIdsFromBrowsePaths NodeId startNode – La ID del nodo de inicio

List<string> relativePaths – Las rutas relativas

out List<NodeId> nodeIds – La lista de los nodos encontrado

out SResult<SResult> results – La lista de “DResults” para cada ruta

Consigue el ID del noso desde su ruta relativa usando el nodo de inicio provisto.

GetNodeIdsFromBrowsePaths List<string> browsePaths – Las rutas de navegación

out List<NodeId> nodeIds – Lista de nodos encontrados

out List<SResult> results – Lista de éxitos y fracasos para cada nodo

Consigue el ID del nodo desde la ruta usando como carpeta raíz el nodo de inicio.

GetNodeIdsFromQuery NodeId startingNodeId – El nodo de Inicio

string query – La consulta para filtrar los elementos del nodo

out List<NodeId> - La lista de nodos encontrados resultante

Consigue la lista de Nodos para un Nodo dado filtrado por una consulta

GetSubscriptions Out List<Subscription> subscriptions – La lista de suscripciones encontradas

Consigue las suscripciones actuales sobre el modelo de objetos.

HistoryRead List<NodeId> nodeIds – Los nodos sobre los que se está leyendo el Histórico.

readDetails HistoricalReadDetails – Los detalles del Histórico a leer.

out List<DataValueCollection> historicalValues

Consgue el Histórico de los nodos especificados.

MoveType AssetType type – El Tipo a mover.

AssetType newParentType – El nuevo Tipo “padre”-

Mueve el Tipo especificado desde una subclase de su supertipo a una nueva subclase del nuevo Tipo Padre.

ObjectFromNodeId NodeId nodeId – La ID del objeto a encontrar del Modelo de Objetos.

out SResult sresult - el éxito o fracaso de la operación.

Devuelve el modelo de objeto para el nodo especificado.

ObjectsFromNodeIds List<NodeId> nodeIds – LA ID del nodo del modelo de objetos del objeto a conseguir.

out List<ObjectBase> objects – El objeto encontrado.

Consigue los objetos del modelo de objetos para la ID especificada del nodo.

Refresh -none- Refresca la colección en el modelo desde el servidor.

ValidateSession -none- Valida la sesión para ver si tenemos una conexión válida.

ValidateSessionWithException -none- Valida la sesión para ver si nosotros tenemos una conexión válida, produce una excepción si la sesión no es válida.

ValidateSessionWithMessage -none- Valida la sesión si ve que teemos una sesión válida, muestra el mensaje “SResult” si la sesión no es válida.

WriteValue NodeId nodeId – El nodo del objeto

uint attribute – El atributo para escritura

unit sCode – La calidad del dato a ser escrito

object value – El valor a ser escrito

DateTime timestamp – el origen del sello de tiempo

Escribe un valor en el servidor usando el ID del nodo


10

2.4.3 Eventos Evento Parámetros Descripción

PropertyChanged PropertyChangedEventHandler Disparado cuando una propiedad cambia en un elemento.

2.4.4 Sintaxis de la Consulta para GetNodeIdsFromQuery Syntax 1

?StartRow={starting row number}?RowsToReturn={number of rows to return}

Example:

?StartRow=1?RowsToReturn=50

Syntax 2

?StartRow={starting row number}?RowsToReturn={number of rows to return}?Filter={property name}|{operator}|{value};[Optional {Join};{property name}|{operator}|{value};]

Example:

?StartRow=1?RowsToReturn=50?Filter=Priority|=|High;And;Project|=|Status Enterprise;


11

3 Clase Base del Modelo de Objetos

3.1 Base de Objetos La Base de Objetos en la calse base de todos los objetos definidos en el modelo de objetos.

3.1.1 Propiedades


BrowseName QualifiedName Consigue o fija el nombre de navegación para el elemento del modelo de objetos.

DataType NodeId Consigue el Nodo del tipo para el valor de su elemento del modelo de objetos, tipicamente usado con clases derivadas de DataItem.

DataTypeDisplayName string Consigue mostrar el nombre del Tipo de Dato.

Description LocalizedText La descripción del elemento en el modelo de objetos.

DisplayName LocalizedText Consigue o fija el nombre amostrar del elemento en el modelo de objetos.

EventNotifier bool Consigue o fija una señal indicando que este nodo ha disparado eventos.

FullBrowsePath string Consigue la ruta absoluta de este objeto relativo para la raíz del modelo de objetos.

IsHistorizing boolean Consigue o fija una señal indicando que este elemento debe de ser registrado. Solo usado con clases derivadas de DataItem.

ModelingRule ModelingRules Consigue o fija la regla de modelado para el elemento, puede ser opcional u obligatoria.

NodeId NodeId Consigue la ID del nodo única para un elemento de datos.

ObjectModel StatusObjectModel Consigue la instancia StatusObjectModel.

Owner ObjectBase Consigue el elemento del modelo de objetos que es el “padre” del propietario de este elemento, nulo para elementos raíz

TypeDefinition NodeId Consigue el Nodo para el elemento del Modelo de Objetos que define el Tipo para este elemento.

TypeDefinitionDisplayName string Consigue el nombre a mostrar para la Definicion del Tipo.

Value object Consigue o fija el valor para este elemento, usualmente usado con elementos subclasificados desde DataItem.

ValueRank int Consigue o fija un ranking de valor, usado con colecciones. Actualmente no utilizado.

3.1.2 Metodos

Metodo Parametros Descripción

GetNodeIdFromRelativePath string browsePath – La ruta relativa para el nodo deseado.

out NodeId nodeId – el nodo encontrado.

Consigue el nodo hijo para este elemento provisto de una ruta relativa para el elemento.

GetNodeIdsFromRelativePaths List<string> browsePaths – Las rutas relativas para los nodos deseados.

Consigue los nodos hijos para este elemento provisto de una ruta relativa para el elemento.


12

out List<NodeId> nodeIds – Devuelve los nodos encontrados

IsInputParameter MethodParameter methodParameter – el parámetro del método para la llamada.

optional bool bRemove – Si devuelve un “true” el parámetro será eliminado.

Marca el objeto para ser un parámetro de entrada para una llamada a un método

3.1.3 Eventos

Evento Parametros Descripción

PropertyChanged PropertyChangedEventHandler Disparado cuando hay cualquier cambio en la propiedad de un elemento.

3.2 “RootCollectionBase” “RootCollectionBase” es una clase base usada para la mayoría de las collecciones de elementos del modelo de objetos. Estos incluyen Activos, Tipos de Activos, Cuantas de Usuario, “Espacios de Trabajo”, Roles, Servidores Remotos y configuraciones de inicio de sesión. La masa de propiedades y métodos en esta clase relaciona los elementos encontrados y añade y elimina elementos de la colección.

3.2.1 Metodos


AddComponent StatusObjectType asset – Un activo existente para añadir.

Añade un Activo existente como un componente de este Activo

FindItem NodeId nodeId - El Nodo del elemento del modelo de objetos encontrado en esta colección.

out SResult sresult – información de error.

Devuelve el elemento del modelo de objetos que concuerde con ID del nodo si existe.

FindItem String browseName – El “browseName” del item a encontrar.

out SResult – información de error.

Devuelve el elemento del modelo de objetos que concuerde con la petición si el nombre existe.

FindItemByDisplayName string displayName – El nombre a mostrar del elemento a encontrar.

out SResutl – éxito o fallo de la operación.

Consigue el elemento que concuerde con la petición del nombre a mostrar.

FindItems List<NodeId> nodeIds – el nodo de los elementos a buscar. out SResult sresult – información de error.

Devuelve una colección “ReadOnlyObservable” de elementos el modelo de objetos que concuerden con el Nodo especificado.

3.3 “StatusObjectType” “StatusObjectType” es un subtipo de “ObjectBase”. Muchos de los objetos de alto nivel como un Activo, un “AssetType”, “FileFolder”, “UserFile”, “LoggingConfiguration”, “RemoteServerConfiguration”, Rol yespacio de trabajo son un subtipo de “StatusObjectType”.


13

3.3.1 Propiedades

Propiedades Tipo Descripción

Components ReadOnlyObservableCollection<ObjectBase> Consigue la colección de componentes propietarios para este elemento.

IsOverride boolean Consigue un señal que indica si este objeto está anulado. Aplica a los elementos de Datos y Alarmas, mira la Parte 2 – Diseñador del Modelo de Datos para más información.

IsRootItem boolean Consigue una señal que indica si este es un elemento raíz en el modelo de datos.

MethodCalls ReadOnlyObservableCollection<MethodCall> Consigue una colección de “MethodCall” que es poseida por este elemento.

Properties ReadOnlyObservableCollection<DataItem> Consigue la colección de “DataItems” que son poseidos por este elemento.

ReadOnlyWorkspaces ObjectModelCollection<Workspace> Consigue la lectura solo de los Espacios de Trabajo para este elemento.

Workspaces ObjectModelCollection<Workspace> Consigue una colección de Espacios de Trabajo que son poseidos por este elemento.

3.3.2 Metodos


AddComponent ObjectBase asset – el objeto a añadir. Añade un componente a este elemento.

CreateAlias string browseName – El nombre de navegación para el Activo.

NodeId tagetType – El tipo de ID del Activo

NodeId target – el propietario del Activo, será nulo para un Activo Raíz.

out Alias alias – El Activo creado

Crea un nuevo Activo como un Activo de este Activo.

CreateComponent string browseName – El nombre de Navegación del componente.

string displayName – El nombre a mostrar del componente.

StatusObjectType assetType – el tipo de Activo

NodeId assetTypeId – La ID del tipo de Activo.

out SResult – éxito o fracaso de la operación.

Crea un nuevo activo basado en el tipo de Activo y añade un componente para este elemento.

CreateMethodCall string displayName – El nombre del método

Assembly assembly – el ensamblado actual del método

Type classType – la clase del Tipo

MethodInfo method – La información del Método

out SResult – éxito o fracaso de la operación

Crea una nueva llamada a un Método

CreateMethodCall MethodCall typeMethodCall – el tipo de llamada a método

out SResult sresult – éxito o fracaso de la operación

Crea una nueva llamada al método desde la información de una llamada al método existente


14

DeleteMethod MethodCall methodcall – La llamada al método para eliminar

Elimina una llamada a un método desde el tipo de Activo

FindComponent string browseName – El nombre de navegación del componente a encontrar.

Encuentra el componente con el nombre especificado.

FindProperty string browseName – el nombre de lapropiedad a encontrar.

Encuentra la propiedad con el nombre especificado.

IsSubtypeOf StatusObjectType parentType – el tipo e objeto para comparar.

out SResult sresult – éxito o fracaso de la operación.

Devuelve “true” si el elemento concuerda con el tipo o subtipo del tipo provisto.

TranslateBrowsepathToNodeId string relatrivePath – La subruta para este tipo.

out NodeId selectedObjectBase

Traduce una ruta para un Tipo al nodo correcto.

TranslateBrowsePathToObjectBase string relativePath – La subruta para este Tipo.

out ObjectBase selectedObjectBase -

Traduce una ruta de Tipos hacia el objeto correcto.

3.3.3 Eventos

Event Parameters Description

ComponentCollectionChanged NotifyCollectionChangedEventHandler Disparado cuando hay un cambio en los componentes.


15

4 Tipos y propiedades.

4.1 Tipo de Activo La clase “AssetType” define los tipos de objetos del modelo de datos. Heredados desde “StatusObjectType”. La calse “AssetType” puede ser usada para programar la jerarquía del modelo de datos.

4.1.1 Propiedades

Property Type Description

IsDeleted bool Consigue una señal que indica si el elemento ha sido eliminado.

IsSystemType bool Consigue una señal indicando si el elemento es un tipo de sistema.

SubTypes AssetTypes Consigue una lista de tipos que son subtipos de un elemento.

SuperType AssetType Consigue los tipos que estos elementos tienen subclasificados si el elemento no es un tipo raíz.

4.1.2 Metodos


CanRename string proposedName – un nuevo nombre propuesto

Indica si el objeto puede ser renombrado con el nuevo nombre propuesto.

CreateComponent string browseName – el nombre del Activo.

StatusObjectType assetType – el tipo de Activo.

out Asset asset – el Asset nuevo creado.

Crea un Activo basado en el tipo suministrado.

CreateComponentReference AssetType assetType – el tipo de los puntos de referencia.

String browseName – el nombre de la referencia.

out ObjectReference – La nueva referencia creada.

Crea una referencia para un objeto.

CreateProperty string browseName – el nombre de navegación y a mostrar de la propiedad.

NodeId dataTypeId – La ID del nodo de la propiedad del tipo a crear.

out DataItem dataItem – El nuevo elemento creado.

Object defualtValue – El valor por defecto de las nuevas instancias del elemento, el valor por defecto es nulo.

string description – la descripción del elemento.

Creates a new property of the specified type. Types include DataItems, AnalogItems and Discrete Items.

Los IDs de los tipos de datos para estos elementos son definidos en las librerías OPC UA.

DeleteComponent ObjectBase asset – el objeto a eliminar.

Borra un Activo desde el servidor y lo elimina de la descripción del tipo de Activo.


16

DeleteComponentCollection StatusObjectList statusObjectList – el objeto a eliminar.

Borra la lista desde el servidor y la elimina de la descripción del tipo de Activos.

DeleteDataItem DataItem dataItem – el objeto a eliminar.

Borra los elementos de los datos del servidor y los elimina de la descripción del tipo de Activo.

DeleteProperty DataItem asset – el componente a eliminar.

Deletes a component from this asset type

FindProperty string componentName – the name of the component to find

Encuentra el componente con el nombre de navegación especificado.

IsSubTypeOf StatusObjectType parentType – El tipo de objeto a comparar.

out SResult sresult – éxito o fracaso de la operación.

Devuelve “true” si el tipo es un subtipo del tipo especificado.

RefreshComponents - ninguno - Refresca componentes para este tipo, sus supertipos y subtipos para el cliente.

RefreshProperties - ninguno - Refresca las propiedades para este tipo, sus subtipos y supertipos para este cliente.

Rename string proposedName – Un nuevo nombre propuesto.

Renombra este Activo.

4.1.3 Eventos

Event Parameters Description

Deleted EventHandler Fired whenever an asset is deleted

4.2 Elmento de Datos

Un “DataItem” es dos cosas, una definición de un tipo y una instancia de la propiedad en el Activo. El

“DataItem” es un subtipo de “ObjectBase”. Otros elementos de datos más especializados como

“AnalogItem” y “DiscreteItem” son subtipos de “DataItem”. La clase “DataItem” es usada con valores de

propiedades no numéricas como “string” y “Date Time”. Un elemento de Datos puede mantener un

“BindingConfiguration” la cual define que propiedades del elemento de datos está enlazado a que

servidor remoto. Las actualizaciones para el servidor remoto son actualizadas en el elemento de datos

por el Servidor Status.

4.2.1 Propiedades


AccessLevel byte Consigue o fija el nivel de acceso.

Alarms ReadOnlyObservableCollection<Alarm> Una colección de Alarmas en este elemento.

BrowseName QualifiedName El Nombre de Navegación para el objeto.

IsAnalog bool Indica que esto es un tipo “AnalogItem”

IsDiscrete bool Indica que esto es un tipo “DiscreteItem”

IsEnumeration bool Indica que esto es un tipo “EnumerationItem”

IsOverride boolean Consigue una señal que indica si esta propiedad es una propiedad anulada por la propiedad del supertipo.


17

LogginConfiguration LoggingConfiguration Consigue o Fija la configuración de inicio de sesión para este elemento.

ReadOnly bool “Solo Lectura” consigue o fija la escritura del bit actual del “AccessLevel”

ReadOnlyWorkspaces ObjectModelCollection<Workspace> Consigue la colección de los espacios de trabajo.

Value object Consigue o fija el valor del elemento de Datos.

Workspaces ObjectModelCollection<Workspaces> Consigue la colección de los espacios de trabajo de este dato. El acceso de clientes de esta propiedad debe tambien ser miembro de los espacios de trabajo especificos o es miembro o un rol que es un miembro de uno de los especificados espacios de trabajo.

4.2.2 Metodos


CreateAlarm string browseName – el nombre de navegación de la alarma

string description – la descripción de la alarma

AlarmType alarmType – La ID del tipo de Alarma

out Alarm alarmCondition – La alarma creada

Crea un tipo alarma especifico y lo anexa como un tipo de Activo.

CreateAlarm string browseName – el nombre de la alarma

out SResult sresult – éxito o fracaso de la operación

Crea un nuevo elemento de datos para la propiedad especificada. Si la propiedad ya existe, esta es devuelta. La propiedad debe de existir ya en la definición de tipos.

DeleteAlarm Alarm alarm – la alarma para borrar Borra una alarma desde este tipo de Activo.

GetParent out ObjectBase parent – el “padre” de este elemento. Consigue el “padre” de este elemento.

HistoryRead HistoricalReadDetails readDetails – Una descripción del histórico que debería ser leída del servidor.

out DataValueCollection historicalValues - el histórico recuperado del servidor.

Lee un bloque de datos históricos desde el servidor basados en las restricciones definidas en los detalles de lectura.

4.3 Elemento “Analog” “Analog Item” es un subtipo del elemento de datos. Este es usado con valores de propiedades numéricas como entero o doble.

4.3.1 Propiedades


EngineeringUnit EngineeringUnit Consigue o fija las unidades de ingeniería asociadas con los elementos de datos(metros, yardas, etc...).

High double Consigue o fija el límite alto para el elemento.

Low Double Consigue o fija el nivel bajo para el elemento.


18

4.4 Elemento “Discrete Data” “Discrete Item” es un subtipode elemento de datos. Es usado con valores de propiedades booleanos. No tiene métodos adicionales.

4.4.1 Properties Propiedad Tipo Descripción

DiscreteItemText DiscreteItemText Consigue o fija el perfil a usar de “DiscreteItemText”

ValueText LocalizedText Consigue o fija el valor de texto para el texto desde “DiscreteItemText” “TrueText” o FalseText”

4.5 Elemento “Byte Array” El elemento “Byte Array” es un subtipo del elemento de datos. Puede ser usado con los tipos de archivo de usuario cargados en el sistema. No tiene propiedades adicionales o métodos adicionales.

4.6 Elemento Enumeración El elemento Enumeración es un subtipo del Elemento de Datos. Es usado con las propiedades de tipo Enumeracion. Es almacenado como un entero como indice de un valor string de la enumeración almacenada en la propiedad “ValueText”.

4.6.1 Propiedades Propiedad Tipo Descripción

Enumeration Enumeration Un perfil de Enumeración para un elemento de Enumeración.

ValueText LocalizedText Consigue o fija los valores de texto de los elementos de Enumeración, el valor de texto actual de esta Enumeración.


19

5 Activo Un Activo es una instancia de un Tipo Activo. Esto representa un objeto específico del mundo real en el modelo de objetos. Activo es un subtipo de StatusObjectType.

5.1.1 Propiedades


AssetType AssetType Consigue el tipo de información (las propiedades, métodos, espacios de trabajo, alarmas, y valores por defecto) para el Activo.

5.1.2 Metodos


CreateProperty string browseName – el nombre de la propiedad Crea un nuevo elemento de datos para este activo.

DeleteProperty DataItem dataItem – el elemento de datos a eliminar Borra los elementos de datos o propiedades para este Activo.

RemoveComponent ObjectBase asset – el componente a eliminar Borra un componente desde los tipos de Activos.


20

6 Archivos Las clases para definir archivos o carpetas almacenados en el modelo de objetos, y sus asociaciones con otro objeto del modelo de objetos.

6.1 “UserFile” “UserFile” es un subtipo de “SystemType”. Esto es un archivo almacenado en el modelo de objetos que puede ser recuperado. Las imágenes salvadas como un “UserFile” pueden ser enlazadas a un control de imagen enlazable en un “mimic”.

6.1.1 Propiedades Propiedades Tipo Descripción

CanCache Bool Consigue o fija el valor que indica si el cliente puede cachear el archivo.

Content byte[] Consigue o fija el contenido binario del archivo como un Byte[]

DisplayName String Consigue o fija el nombre para mostrar del objeto.

FileType string Consigue o fija el tipo de archivo (png, bmp, pdf).

MetaData string Consigue o fija metadatos adicionales para asociar al archivo, definido por el usuario.

MimeType string Consigue o fija el tipo “MIME” para el archivo.

OwnerType string Consigue o fija el tipo para el propietario del documento.

OwnerTypeId NodeId El ID nodo para el propietario del codumento.

Parent FileFolder Consigue el propietario del archivo.

Size ulong Consigue el tamaño del archivo en bytes.


21

7 Registro Clases utilizadas para configurar el registro de valores de propiedades de Activos de los datos y la Base de Datos.

7.1 “LoggingConfiguration” “LoggingConfiguration” es un subtipo de un “SystemType”. Esto defina los parámetros para cuando una propiedad devería de ser registrada.

7.1.1 Propiedades


DeviationFormat ExceptionDeviationFormat El tipo de registro.

ExceptionDeviation double La ExceptionDeviation

MaxTimeInterval double El máximo intervalo de registro en ms

MinTimeInterval double El mínimo intervalo de registro en ms


22

8 Espacios de Trabajo y Seguridad Las clases controlan el acceso al servidor y restringen el acceso basado en permisos.

8.1 Cuenta de Usuario Una cuenta de usuario asociada con el sistema, un “SystemType”. El nombre de usuario para la cuenta es el “browseName” desde el navegador de nombres debe ser único.

8.1.1 Propiedades


AuthenticationType UserAuthenticationType Consigue o fija el tipo de autenticación (de sistema o Windows)

Email string Consigue o fija la dirección de email del usuario.

FirstName string Consigue o fija el Nombre del usuario.

IsEnabled boolean Consigue o fija una señal que habilita o dehabilita las cuentas de usuario.

LastName string Consigue o fija el apellido del usuario.

Password string Fija la contraseña de usuario.

Phone string Consigue o fija el numero de teléfono del usuario.

Roles ObjectModelCollection<Role> Consigue o fija los roles de usuarios asociados.

8.2 Rol Un “SystemType” que agrupa cuentas de usuario para formar una colección de usuarios.

8.2.1 Propiedades


UserAccounts ObjectModelCollection<UserAccount> Consigue las cuentas de usuario asociadas a este rol.

8.3 Espacios de Trabajo Un “SystemType” que agrupa cuentas de usuario, roles, tipos y propiedades juntos para restringir el acceso a contenido a determinados usuarios. Por defecto, los activos y las propiedades no tienen espacios de trabajo asignados a ellos, y son accedibles por todos los usuarios. Una vez un activo o propiedad es asociado con un espacio de trabajo, solo los usuarios que pertenecen a ese espacio de trabajo, están habilitados para acceder a él.

8.3.1 Propiedades


IsReadOnly boolean Consigue o fija un valor que indica si el elemento asociado en este espacio de trabajo es de solo lectura.

Roles ObjectModelCollection<Role> Consigue los roles que son miembros de este espacio de trabajo.

UserAccounts ObjectModelCollection<UserAccount> Consigue las cuentas de usuario que son miembros de este espacio de trabajo.


23

9 Suscribiendonos a Alarmas y Cambios de Datos.

9.1 Suscrpción Las suscripciones son objetos del lado cliente que son usados para suscribirnos a los cambios de propiedades sobre los elementos de datos en el modelo, o para suscribirnos a alarmas. Para suscribirnos a los cambios de valores o a una notificación de alarma, crea una suscripción usando StatusObjectModel.CreateSubscription y añade las IDs del nodo de los objetos que desees monitorizar la suscripción. Suscripción no es una subclase de cualquier clase del modelo de objetos.

9.1.1 Propiedades


Id uint La ID es una suscripciónsubyacente de OPC UA

ItemCount uint El número de elementos monitorizados a los que estamos suscritos.

9.1.2 Metodos

Metodos Parametros Descripción

AlarmConditionRefresh - ninguno - Refrescar las Condiciones de Alarmas. Hace peticiones para reenviar alarmas actualizadas.

Dispose - ninguno -

Resume - ninguno - Reanuda la suscripción suspendida actual.

Subscribe NodeId nodeId – la ID del nodo a suscribirse.

out uint clientHandle – el manejo cuando la suscripción es creada.

int updateRate – la tasa sobre la cual queremos que la suscripción se actualice desde el servidor.

MonitoringMode monitoringMode – El modo de monitorización de la suscripción.

uint attributeId – El atributo ID en el nodo que tu quieres suscribirte, el valor del atributo por defecto es 13.

List<NodeId> dataItemIds – Las IDs de los nodos a los que quieres suscribirte.

List<int> updateRates – La tasa de actualización para cada ID de nodo.

List<MonitoringMode> monitoringModes – los modos de monitorización para cada ID.

out List<uint> clientHandles – El manejo individual para cada suscripción.

ObjectBase dataItem – El modelo de objetos al que quieres suscribirte.

Suscribe a un elemento de datos.

SubscribeAlarm NoeId nodeId – El ID del nodo del elemento al que quieres suscribirte.

Suscribe a un elemento de Datos para las notificaciones de Alarmas.


24

Monitoring Filter – Un filtro opcional para restringir las alarmas devueltas.

Suspend - ninguno - Suspende la suscripción actual

UnSubscribe uint clientHandle – el manejo del elemento de datos que estamos suscritos

List<uint> - Una lista de los elementos para manejar la cancelación de la suscripción.

Cancela la suscripción de un elemento de datos.

guía de usuario parte 10scada.com/content/userguides/statusenterprise_es/st… · ·...

Documents