rm::Event类 参考

OPC UA 事件 更多...

#include <rmvl/opcua/event.hpp>

rm::Event 的协作图:

Public 成员函数
	Event ()=default
	构造 rm::Event 对象类型
void	add (const std::string &browse_name, int prop)
	添加非默认属性至事件类型中
int &	operator[] (const std::string &browse_name)
	访问指定的非默认属性
const std::unordered_map< std::string, int > &	data () const
	获取 int 整型的非默认属性列表
EventType	type () const
	获取事件类型

静态 Public 成员函数
static Event	makeFrom (const EventType &etype)
	从事件类型创建新的事件

Public 属性
uint16_t	ns {1U}
	命名空间索引，默认为 1
std::string	source_name
	默认属性：事件源名称
std::string	message
	默认属性：事件消息，包含关于事件的描述
uint16_t	severity {}
	默认属性：事件严重程度

详细描述

OPC UA 事件

构造及析构函数说明

Event()

rm::Event::Event ( )

default

Python:
	rm.Event(		) ->	<Event object>

构造 rm::Event 对象类型

成员函数说明

add()

void rm::Event::add ( const std::string & browse_name, int prop )

inline

Python:
	rm.Event.add(	browse_name, prop	) ->	None

添加非默认属性至事件类型中

参数

[in]	browse_name	非默认属性的浏览名 BrowseName
[in]	prop	int 整型属性值

data()

const std::unordered_map< std::string, int > & rm::Event::data ( ) const

inline

Python:
	rm.Event.data(		) ->	prop map

获取 int 整型的非默认属性列表

rmvl/opcua 模块支持修改的 默认属性 包括：

BrowseName	类型	含义
SourceName	String	事件源名称
Message	String	事件消息，包含关于事件的描述
Severity	UInt16	事件严重程度

返回

非默认属性列表

makeFrom()

static Event rm::Event::makeFrom ( const EventType & etype )

inlinestatic

Python:
	rm.Event.makeFrom(	etype	) ->	<rm.Event object>

从事件类型创建新的事件

参数

[in]

etype

既存的待作为事件类型信息的使用 rm::EventType 表示的变量类型

返回

新的事件

函数调用图:

operator[]()

int & rm::Event::operator[] ( const std::string & browse_name )

inline

Python:
	rm.Event.__getitem__(	browse_name	) ->	prop
	rm.Event.__setitem__(	browse_name, prop	) ->	None

访问指定的非默认属性

参数

[in]

browse_name

非默认属性的浏览名 BrowseName

返回

int 整型非默认属性的左值引用

type()

EventType rm::Event::type ( ) const

inline

Python:
	rm.Event.type(		) ->	<EventType>

获取事件类型

类成员变量说明

message

std::string rm::Event::message

默认属性：事件消息，包含关于事件的描述

ns

uint16_t rm::Event::ns {1U}

命名空间索引，默认为 1

severity

uint16_t rm::Event::severity {}

默认属性：事件严重程度

source_name

std::string rm::Event::source_name

默认属性：事件源名称

---

该类的文档由以下文件生成:

• rmvl/opcua/event.hpp