rm::VariableType类 参考

OPC UA 变量类型 更多...

#include <rmvl/opcua/variable.hpp>

rm::VariableType 的协作图:

Public 成员函数
	VariableType ()=default
template<typename Tp , typename DecayT = typename std::decay_t<Tp>, typename = std::enable_if_t<std::is_fundamental_v<DecayT>>>
	VariableType (Tp val)
	单值构造，设置默认值
template<typename Tp , typename = std::enable_if_t<std::is_convertible_v<Tp, std::string>>>
	VariableType (Tp &&str)
	字符串构造，设置默认值
template<typename Tp , typename Enable = std::enable_if_t<std::is_fundamental_v<Tp> && !std::is_same_v<bool, Tp>>>
	VariableType (const std::vector< Tp > &arr)
	列表构造，设置默认值
template<typename Tp >
Tp	cast () const
	将变量节点转化为指定类型的数据
const auto &	data () const
	获取默认数据
DataType	getDataType () const
	获取数据类型
constexpr bool	empty () const
	判断变量类型节点是否为空
uint32_t	size () const
	获取大小

静态 Public 成员函数
template<typename Tp >
static Tp	cast (const rm::VariableType &val)
	将变量类型节点转化为指定类型的数据

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

详细描述

OPC UA 变量类型

构造及析构函数说明

VariableType() [1/4]

rm::VariableType::VariableType ( )

default

Python:
	rm.VariableType(		) ->	<VariableType object>
	rm.VariableType(	val	) ->	<VariableType object>

VariableType() [2/4]

template<typename Tp , typename DecayT = typename std::decay_t<Tp>, typename = std::enable_if_t<std::is_fundamental_v<DecayT>>>

rm::VariableType::VariableType ( Tp val )

inline

Python:
	rm.VariableType(		) ->	<VariableType object>
	rm.VariableType(	val	) ->	<VariableType object>

单值构造，设置默认值

模板参数

Tp	变量的存储数据类型，必须是可包含 cv 限定符的基础类型及其引用类型

参数

[in]

val

标量、数量值

VariableType() [3/4]

template<typename Tp , typename = std::enable_if_t<std::is_convertible_v<Tp, std::string>>>

rm::VariableType::VariableType ( Tp && str )

inline

Python:
	rm.VariableType(		) ->	<VariableType object>
	rm.VariableType(	val	) ->	<VariableType object>

字符串构造，设置默认值

模板参数

Tp	字符串变量的存储数据类型，必须是 std::string、std::string_view、C 风格字符串指针或者字符串字面量

参数

[in]

str

字符串

VariableType() [4/4]

template<typename Tp , typename Enable = std::enable_if_t<std::is_fundamental_v<Tp> && !std::is_same_v<bool, Tp>>>

rm::VariableType::VariableType ( const std::vector< Tp > & arr )

inline

Python:
	rm.VariableType(		) ->	<VariableType object>
	rm.VariableType(	val	) ->	<VariableType object>

列表构造，设置默认值

模板参数

Tp	变量的存储数据类型，必须是基础类型

参数

[in]

arr

列表、数组

成员函数说明

cast() [1/2]

template<typename Tp >

Tp rm::VariableType::cast ( ) const

inline

Python:
	rm.VariableType.cast(		) ->	<Real Type Value>

将变量节点转化为指定类型的数据

模板参数

Tp

变量的数据类型

返回

该数据类型的数据

cast() [2/2]

template<typename Tp >

static Tp rm::VariableType::cast ( const rm::VariableType & val )

inlinestatic

Python:
	rm.VariableType.cast(		) ->	<Real Type Value>

将变量类型节点转化为指定类型的数据

模板参数

Tp

变量类型的数据类型

参数

[in]

val

变量类型节点

返回

Tp 该数据类型的数据

函数调用图:

data()

const auto & rm::VariableType::data ( ) const

inline

获取默认数据

empty()

bool rm::VariableType::empty ( ) const

inlineconstexpr

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

判断变量类型节点是否为空

getDataType()

DataType rm::VariableType::getDataType ( ) const

inline

Python:
	rm.VariableType.getDataType(		) ->	<DataType>

获取数据类型

size()

uint32_t rm::VariableType::size ( ) const

inline

Python:
	rm.VariableType.size(		) ->	<Size>

获取大小

注解

未初始化则返回 0

类成员变量说明

browse_name

std::string rm::VariableType::browse_name {}

浏览名称 BrowseName

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

description

std::string rm::VariableType::description {}

变量类型的描述 - zh-CN

display_name

std::string rm::VariableType::display_name {}

展示名称 DisplayName

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

ns

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

命名空间索引，默认为 1

---

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

• rmvl/opcua/variable.hpp