sopc_event.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_EVENT_H_
#define SOPC_EVENT_H_
 
#include "sopc_types.h"
 
typedef struct _SOPC_Event SOPC_Event;
 
void SOPC_Event_Clear(SOPC_Event* pEvent);
 
void SOPC_Event_Delete(SOPC_Event** ppEvent);
 
SOPC_Event* SOPC_Event_CreateCopy(const SOPC_Event* pEvent, bool genNewId);
 
const SOPC_NodeId* SOPC_Event_GetEventTypeId(const SOPC_Event* pEvent);
 
const SOPC_ByteString* SOPC_Event_GetEventId(const SOPC_Event* pEvent);
 
SOPC_ReturnStatus SOPC_Event_SetEventId(SOPC_Event* pEvent, const SOPC_ByteString* pEventId);
 
SOPC_ReturnStatus SOPC_Event_SetSourceName(SOPC_Event* pEvent, const SOPC_String* pSourceName);
 
SOPC_ReturnStatus SOPC_Event_SetSourceNode(SOPC_Event* pEvent, const SOPC_NodeId* pSourceNode);
 
SOPC_NodeId* SOPC_Event_GetSourceNode(SOPC_Event* pEvent);
 
SOPC_DateTime SOPC_Event_GetTime(const SOPC_Event* pEvent);
 
SOPC_ReturnStatus SOPC_Event_SetTime(SOPC_Event* pEvent, SOPC_DateTime time);
 
SOPC_ReturnStatus SOPC_Event_SetReceiveTime(SOPC_Event* pEvent, SOPC_DateTime receiveTime);
 
SOPC_ReturnStatus SOPC_Event_SetLocalTime(SOPC_Event* pEvent, const OpcUa_TimeZoneDataType* pLocalTime);
 
SOPC_ReturnStatus SOPC_Event_SetMessage(SOPC_Event* pEvent, const SOPC_LocalizedText* pMessage);
 
SOPC_ReturnStatus SOPC_Event_SetSeverity(SOPC_Event* pEvent, uint16_t severity);
 
SOPC_ReturnStatus SOPC_Event_SetVariable(SOPC_Event* pEvent,
                                         uint16_t nbQnPath,
                                         SOPC_QualifiedName* qualifiedNamePathArray,
                                         const SOPC_Variant* var);
 
SOPC_ReturnStatus SOPC_Event_SetVariableFromStrPath(SOPC_Event* pEvent, const char* qnPath, const SOPC_Variant* var);
 
const SOPC_Variant* SOPC_Event_GetVariableFromStrPath(const SOPC_Event* pEvent, const char* qnPath);
 
const SOPC_Variant* SOPC_Event_GetVariableAndType(const SOPC_Event* pEvent,
                                                  uint16_t nbQnPath,
                                                  SOPC_QualifiedName* qualifiedNamePathArray,
                                                  const SOPC_NodeId** outDataType,
                                                  int32_t* outValueRank);
 
const SOPC_Variant* SOPC_Event_GetVariableAndTypeFromStrPath(const SOPC_Event* pEvent,
                                                             const char* qnPath,
                                                             const SOPC_NodeId** outDataType,
                                                             int32_t* outValueRank);
 
SOPC_ReturnStatus SOPC_Event_SetNodeId(SOPC_Event* pEvent, const SOPC_NodeId* nodeId);
 
typedef void SOPC_Event_ForEachVar_Fct(const char* qnPath,
                                       SOPC_Variant* var,
                                       const SOPC_NodeId* dataType,
                                       int32_t valueRank,
                                       uintptr_t user_data);
 
void SOPC_Event_ForEachVar(SOPC_Event* event, SOPC_Event_ForEachVar_Fct* func, uintptr_t user_data);
 
size_t SOPC_Event_GetNbVariables(SOPC_Event* event);
 
#endif // SOPC_EVENT_H_