rm::Variable类 参考

OPC UA 变量 更多...

#include <rmvl/opcua/variable.hpp>

rm::Variable 的协作图:

Public 成员函数
	Variable ()=default
template<unsigned int N>
	Variable (const char(&str)[N])
	字面量字符串构造，设置默认值 更多...
template<typename Tp , typename Enable = std::enable_if_t<std::is_fundamental_v<Tp> || std::is_same_v<Tp, const char *>>>
	Variable (const Tp &val)
	单值构造 更多...
template<typename Tp , typename Enable = std::enable_if_t<std::is_fundamental_v<Tp> && !std::is_same_v<bool, Tp>>>
	Variable (const std::vector< Tp > &arr)
	列表构造 更多...
	Variable (VariableType &vtype)
	从变量类型构造新的变量节点 更多...
	Variable (const Variable &val)
	Variable (Variable &&val)
Variable &	operator= (const Variable &val)
Variable &	operator= (Variable &&val)
constexpr bool	empty () const
	判断变量节点是否为空 更多...
template<typename Tp >
Tp	cast ()
	将变量节点转化为指定类型的数据 更多...
const VariableType *	type () const
	获取用 rm::VariableType 表示的变量类型 更多...
const auto &	data () const
	获取数据 更多...
UA_TypeFlag	getDataType () const
	获取形如 UA_TYPES_<xxx> 的数据类型 更多...
const UA_UInt32 &	size () const
	获取数组维度指针 更多...
void	setAccessLevel (uint8_t access_level)
	设置访问性 更多...
uint8_t	getAccessLevel () const
	获取访问性 更多...
int	getValueRank () const
	获取数据阶数、秩 更多...

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

Public 属性
std::string	browse_name {}
	浏览名称 BrowseName 更多...
std::string	display_name {}
	展示名称 DisplayName 更多...
std::string	description {}
	变量的描述 更多...

详细描述

OPC UA 变量

构造及析构函数说明

Variable() [1/7]

rm::Variable::Variable ( )

default

Variable() [2/7]

template<unsigned int N>

rm::Variable::Variable ( const char(&)  str[N] )

inline

字面量字符串构造，设置默认值

参数

[in]

str

字面量字符串

Variable() [3/7]

template<typename Tp , typename Enable = std::enable_if_t<std::is_fundamental_v<Tp> || std::is_same_v<Tp, const char *>>>

rm::Variable::Variable ( const Tp &  val )

inline

单值构造

模板参数

Tp	变量的存储数据类型，必须是基础类型、const char * 或 const char (&)[N] 表示的字符串类型

参数

[in]

val

标量、数量值

Variable() [4/7]

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

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

inline

列表构造

模板参数

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

参数

[in]

arr

列表、数组

Variable() [5/7]

rm::Variable::Variable ( VariableType &  vtype )

inlineexplicit

从变量类型构造新的变量节点

参数

[in]

vtype

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

Variable() [6/7]

rm::Variable::Variable ( const Variable &  val )

inline

Variable() [7/7]

rm::Variable::Variable ( Variable &&  val )

inline

成员函数说明

cast() [1/2]

template<typename Tp >

Tp rm::Variable::cast ( )

inline

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

模板参数

Tp

变量的数据类型

返回

该数据类型的数据

函数调用图:

cast() [2/2]

template<typename Tp >

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

inlinestatic

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

模板参数

Tp

变量的数据类型

参数

[in]

val

变量节点

返回

Tp 该数据类型的数据

函数调用图:

data()

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

inline

获取数据

empty()

constexpr bool rm::Variable::empty ( ) const

inlineconstexpr

判断变量节点是否为空

getAccessLevel()

uint8_t rm::Variable::getAccessLevel ( ) const

inline

获取访问性

getDataType()

UA_TypeFlag rm::Variable::getDataType ( ) const

inline

获取形如 UA_TYPES_<xxx> 的数据类型

getValueRank()

int rm::Variable::getValueRank ( ) const

inline

获取数据阶数、秩

返回

数据阶数

返回值

<tt>UA_VALUERANK_SCALAR</tt>

或 1

operator=() [1/2]

Variable& rm::Variable::operator=

(

const Variable &

val

)

operator=() [2/2]

Variable& rm::Variable::operator=

(

Variable &&

val

)

setAccessLevel()

void rm::Variable::setAccessLevel ( uint8_t  access_level )

inline

设置访问性

参数

[in]

access_level

访问性

size()

const UA_UInt32& rm::Variable::size ( ) const

inline

获取数组维度指针

注解

单独的数则返回 1，未初始化则返回 0

type()

const VariableType* rm::Variable::type ( ) const

inline

获取用 rm::VariableType 表示的变量类型

参见

_type

返回

变量类型

类成员变量说明

browse_name

std::string rm::Variable::browse_name {}

浏览名称 BrowseName

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

description

std::string rm::Variable::description {}

变量的描述

display_name

std::string rm::Variable::display_name {}

展示名称 DisplayName

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

---

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

• rmvl/opcua/variable.hpp