rm::Object类 参考

OPC UA 对象 更多...

#include <rmvl/opcua/object.hpp>

rm::Object 的协作图:

Public 成员函数
	Object ()=default
ObjectType	type () const
	获取对象类型 rm::ObjectType
void	add (const Variable &variable)
	添加（额外的）变量节点至 rm::Object 对象中
void	add (const DataSourceVariable &dsv)
	添加（额外的）数据源变量节点至 rm::Object 对象中
void	add (const Method &method)
	添加（额外的）方法节点至 rm::Object 对象中
bool	empty () const
	判断对象是否为空
const std::unordered_map< std::string, rm::Variable > &	getVariables () const
	获取 rm::Variable 表示的变量节点的列表
const std::unordered_map< std::string, rm::DataSourceVariable > &	getDataSourceVariables () const
	获取 rm::DataSourceVariable 表示的数据源变量节点的列表
const std::unordered_map< std::string, rm::Method > &	getMethods () const
	获取 rm::Method 表示的方法节点的列表

静态 Public 成员函数
static Object	makeFrom (const ObjectType &otype)
	从对象类型构创建的对象节点

Public 属性
uint16_t	ns {1U}
	命名空间索引，默认为 1
std::string	browse_name {}
	浏览名称 BrowseName
std::string	display_name {}
	展示名称 DisplayName
std::string	description {}
	对象的描述 - zh-CN

详细描述

OPC UA 对象

构造及析构函数说明

Object()

rm::Object::Object ( )

default

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

成员函数说明

add() [1/3]

void rm::Object::add ( const DataSourceVariable & dsv )

inline

Python:
	rm.Object.add(	variable	) ->	None
	rm.Object.add(	dsv	) ->	None
	rm.Object.add(	method	) ->	None

添加（额外的）数据源变量节点至 rm::Object 对象中

• 若设置了对象类型，则此方法只能添加对象类型中不存在的数据源变量节点

参数

[in]

dsv

数据源变量节点

add() [2/3]

void rm::Object::add ( const Method & method )

inline

Python:
	rm.Object.add(	variable	) ->	None
	rm.Object.add(	dsv	) ->	None
	rm.Object.add(	method	) ->	None

添加（额外的）方法节点至 rm::Object 对象中

• 若设置了对象类型，则此方法只能添加对象类型中不存在的方法节点

参数

[in]

method

方法节点

add() [3/3]

void rm::Object::add ( const Variable & variable )

inline

Python:
	rm.Object.add(	variable	) ->	None
	rm.Object.add(	dsv	) ->	None
	rm.Object.add(	method	) ->	None

添加（额外的）变量节点至 rm::Object 对象中

• 若设置了对象类型，则此方法只能添加对象类型中不存在的变量节点

参数

[in]

variable

变量节点

empty()

bool rm::Object::empty ( ) const

inline

Python:
	rm.Object.empty(		) ->	<Is Empty ?>

判断对象是否为空

返回

是否为空

getDataSourceVariables()

const std::unordered_map< std::string, rm::DataSourceVariable > & rm::Object::getDataSourceVariables ( ) const

inline

获取 rm::DataSourceVariable 表示的数据源变量节点的列表

返回

数据源变量节点列表

getMethods()

const std::unordered_map< std::string, rm::Method > & rm::Object::getMethods ( ) const

inline

Python:
	rm.Object.getMethods(		) ->	methods map

获取 rm::Method 表示的方法节点的列表

返回

方法节点列表

getVariables()

const std::unordered_map< std::string, rm::Variable > & rm::Object::getVariables ( ) const

inline

Python:
	rm.Object.getVariables(		) ->	variables map

获取 rm::Variable 表示的变量节点的列表

返回

变量节点列表

makeFrom()

static Object rm::Object::makeFrom ( const ObjectType & otype )

inlinestatic

Python:
	rm.Object.makeFrom(	otype	) ->	<rm.Object object>

从对象类型构创建的对象节点

参数

[in]

otype

既存的待作为对象节点类型信息的使用 rm::ObjectType 表示的变量类型

返回

新的 rm::Object 对象节点

函数调用图:

type()

ObjectType rm::Object::type ( ) const

inline

Python:
	rm.Object.type(		) ->	<ObjectType>

获取对象类型 rm::ObjectType

类成员变量说明

browse_name

std::string rm::Object::browse_name {}

浏览名称 BrowseName

• 属于非服务器层面的 ID 号，可用于完成路径搜索
• 同一个命名空间 ns 下该名称不能重复

description

std::string rm::Object::description {}

对象的描述 - zh-CN

display_name

std::string rm::Object::display_name {}

展示名称 DisplayName

• 在服务器上对外展示的名字 - en-US
• 同一个命名空间 ns 下该名称可以相同

ns

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

命名空间索引，默认为 1

---

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

• rmvl/opcua/object.hpp