opcua::ua::VariableAttributes Class Reference

#include <types.hpp>

Inheritance diagram for opcua::ua::VariableAttributes:

Detailed Description

UA_VariableAttributes wrapper class.

See also

https://reference.opcfoundation.org/Core/Part4/v105/docs/7.24.3

Definition at line 469 of file types.hpp.

Public Member Functions
	VariableAttributes ()
Bitmask< NodeAttributesMask >	specifiedAttributes () const noexcept
Bitmask< NodeAttributesMask >	getSpecifiedAttributes () const noexcept
const LocalizedText &	displayName () const noexcept
const LocalizedText &	getDisplayName () const noexcept
auto &	setDisplayName (LocalizedText displayName)
const LocalizedText &	description () const noexcept
const LocalizedText &	getDescription () const noexcept
auto &	setDescription (LocalizedText description)
Bitmask< WriteMask >	writeMask () const noexcept
Bitmask< WriteMask >	getWriteMask () const noexcept
auto &	setWriteMask (Bitmask< WriteMask > writeMask) noexcept
Bitmask< WriteMask >	userWriteMask () const noexcept
Bitmask< WriteMask >	getUserWriteMask () const noexcept
auto &	setUserWriteMask (Bitmask< WriteMask > userWriteMask) noexcept
const Variant &	value () const noexcept
const Variant &	getValue () const noexcept
auto &	setValue (Variant value)
template<typename... Args>
auto &	setValueScalar (Args &&... args)
template<typename... Args>
auto &	setValueArray (Args &&... args)
const NodeId &	dataType () const noexcept
const NodeId &	getDataType () const noexcept
auto &	setDataType (NodeId dataType)
template<typename T >
auto &	setDataType ()
ValueRank	valueRank () const noexcept
ValueRank	getValueRank () const noexcept
auto &	setValueRank (ValueRank valueRank) noexcept
Span< const uint32_t >	arrayDimensions () const noexcept
Span< uint32_t >	arrayDimensions () noexcept
Span< const uint32_t >	getArrayDimensions () const noexcept
Span< uint32_t >	getArrayDimensions () noexcept
auto &	setArrayDimensions (Span< const uint32_t > arrayDimensions)
Bitmask< AccessLevel >	accessLevel () const noexcept
Bitmask< AccessLevel >	getAccessLevel () const noexcept
auto &	setAccessLevel (Bitmask< AccessLevel > accessLevel) noexcept
Bitmask< AccessLevel >	userAccessLevel () const noexcept
Bitmask< AccessLevel >	getUserAccessLevel () const noexcept
auto &	setUserAccessLevel (Bitmask< AccessLevel > userAccessLevel) noexcept
double	minimumSamplingInterval () const noexcept
double	getMinimumSamplingInterval () const noexcept
auto &	setMinimumSamplingInterval (double minimumSamplingInterval) noexcept
bool	historizing () const noexcept
bool	getHistorizing () const noexcept
auto &	setHistorizing (bool historizing) noexcept
constexpr	TypeWrapper () noexcept=default
constexpr	TypeWrapper (const T &native)
constexpr	TypeWrapper (T &&native) noexcept
constexpr	TypeWrapper (const TypeWrapper &other)
constexpr	TypeWrapper (TypeWrapper &&other) noexcept
Public Member Functions inherited from opcua::TypeWrapper< UA_VariableAttributes, UA_TYPES_VARIABLEATTRIBUTES >
constexpr	TypeWrapper () noexcept=default
constexpr	TypeWrapper (const UA_VariableAttributes &native)
constexpr	TypeWrapper (UA_VariableAttributes &&native) noexcept
constexpr	TypeWrapper (const TypeWrapper &other)
constexpr	TypeWrapper (TypeWrapper &&other) noexcept
	~TypeWrapper ()
constexpr TypeWrapper &	operator= (const TypeWrapper &other)
constexpr TypeWrapper &	operator= (const UA_VariableAttributes &native)
constexpr TypeWrapper &	operator= (TypeWrapper &&other) noexcept
constexpr TypeWrapper &	operator= (UA_VariableAttributes &&native) noexcept
Public Member Functions inherited from opcua::Wrapper< T >
constexpr	Wrapper () noexcept=default
constexpr	Wrapper (const T &native) noexcept
constexpr	Wrapper (T &&native) noexcept
constexpr Wrapper &	operator= (const T &native) noexcept
constexpr Wrapper &	operator= (T &&native) noexcept
constexpr	operator T& () noexcept
constexpr	operator const T & () const noexcept
constexpr T *	operator-> () noexcept
constexpr const T *	operator-> () const noexcept
constexpr T *	handle () noexcept
constexpr const T *	handle () const noexcept
constexpr void	swap (Wrapper &other) noexcept
constexpr void	swap (T &native) noexcept

Additional Inherited Members
Public Types inherited from opcua::Wrapper< T >
using	NativeType = T
Static Public Member Functions inherited from opcua::TypeWrapper< UA_VariableAttributes, UA_TYPES_VARIABLEATTRIBUTES >
static constexpr TypeIndex	typeIndex ()
Protected Member Functions inherited from opcua::TypeWrapper< UA_VariableAttributes, UA_TYPES_VARIABLEATTRIBUTES >
constexpr void	clear () noexcept
Protected Member Functions inherited from opcua::Wrapper< T >
constexpr const T &	native () const noexcept
constexpr T &	native () noexcept
Related Symbols inherited from opcua::TypeWrapper< UA_VariableAttributes, UA_TYPES_VARIABLEATTRIBUTES >
String	toString (const UA_VariableAttributes &object, const UA_DataType &type)
String	toString (const UA_VariableAttributes &object)
Related Symbols inherited from opcua::Wrapper< T >
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr WrapperType *	asWrapper (NativeType *native) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr const WrapperType *	asWrapper (const NativeType *native) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr WrapperType &	asWrapper (NativeType &native) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr const WrapperType &	asWrapper (const NativeType &native) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr NativeType *	asNative (WrapperType *wrapper) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr const NativeType *	asNative (const WrapperType *wrapper) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr NativeType &	asNative (WrapperType &wrapper) noexcept
template<typename WrapperType , typename NativeType = typename WrapperType::NativeType>
constexpr const NativeType &	asNative (const WrapperType &wrapper) noexcept

Constructor & Destructor Documentation

VariableAttributes()

opcua::ua::VariableAttributes::VariableAttributes ( )

inline

Construct with default attribute definitions.

Definition at line 474 of file types.hpp.

Member Function Documentation

specifiedAttributes()

Bitmask< NodeAttributesMask > opcua::ua::VariableAttributes::specifiedAttributes ( ) const

inlinenoexcept

Definition at line 477 of file types.hpp.

getSpecifiedAttributes()

Bitmask< NodeAttributesMask > opcua::ua::VariableAttributes::getSpecifiedAttributes ( ) const

inlinenoexcept

Deprecated:

Use specifiedAttributes instead

Definition at line 477 of file types.hpp.

displayName()

const LocalizedText & opcua::ua::VariableAttributes::displayName ( ) const

inlinenoexcept

Definition at line 477 of file types.hpp.

getDisplayName()

const LocalizedText & opcua::ua::VariableAttributes::getDisplayName ( ) const

inlinenoexcept

Deprecated:

Use displayName instead

Definition at line 477 of file types.hpp.

setDisplayName()

auto & opcua::ua::VariableAttributes::setDisplayName ( LocalizedText  displayName )

inline

Examples

server.cpp, and server_instantiation.cpp.

Definition at line 477 of file types.hpp.

description()

const LocalizedText & opcua::ua::VariableAttributes::description ( ) const

inlinenoexcept

Definition at line 477 of file types.hpp.

getDescription()

const LocalizedText & opcua::ua::VariableAttributes::getDescription ( ) const

inlinenoexcept

Deprecated:

Use description instead

Definition at line 477 of file types.hpp.

setDescription()

auto & opcua::ua::VariableAttributes::setDescription ( LocalizedText  description )

inline

Definition at line 477 of file types.hpp.

writeMask()

Bitmask< WriteMask > opcua::ua::VariableAttributes::writeMask ( ) const

inlinenoexcept

Definition at line 477 of file types.hpp.

getWriteMask()

Bitmask< WriteMask > opcua::ua::VariableAttributes::getWriteMask ( ) const

inlinenoexcept

Deprecated:

Use writeMask instead

Definition at line 477 of file types.hpp.

setWriteMask()

auto & opcua::ua::VariableAttributes::setWriteMask ( Bitmask< WriteMask >  writeMask )

inlinenoexcept

Definition at line 477 of file types.hpp.

userWriteMask()

Bitmask< WriteMask > opcua::ua::VariableAttributes::userWriteMask ( ) const

inlinenoexcept

Definition at line 477 of file types.hpp.

getUserWriteMask()

Bitmask< WriteMask > opcua::ua::VariableAttributes::getUserWriteMask ( ) const

inlinenoexcept

Deprecated:

Use userWriteMask instead

Definition at line 477 of file types.hpp.

setUserWriteMask()

auto & opcua::ua::VariableAttributes::setUserWriteMask ( Bitmask< WriteMask >  userWriteMask )

inlinenoexcept

Definition at line 477 of file types.hpp.

value()

const Variant & opcua::ua::VariableAttributes::value ( ) const

inlinenoexcept

Definition at line 478 of file types.hpp.

getValue()

const Variant & opcua::ua::VariableAttributes::getValue ( ) const

inlinenoexcept

Deprecated:

Use value instead

Definition at line 478 of file types.hpp.

setValue()

auto & opcua::ua::VariableAttributes::setValue ( Variant  value )

inline

Definition at line 478 of file types.hpp.

setValueScalar()

template<typename... Args>

auto & opcua::ua::VariableAttributes::setValueScalar ( Args &&...  args )

inline

See also

Variant::Variant

Definition at line 482 of file types.hpp.

setValueArray()

template<typename... Args>

auto & opcua::ua::VariableAttributes::setValueArray ( Args &&...  args )

inline

See also

Variant::Variant

Definition at line 488 of file types.hpp.

dataType()

const NodeId & opcua::ua::VariableAttributes::dataType ( ) const

inlinenoexcept

Definition at line 492 of file types.hpp.

getDataType()

const NodeId & opcua::ua::VariableAttributes::getDataType ( ) const

inlinenoexcept

Deprecated:

Use dataType instead

Definition at line 492 of file types.hpp.

setDataType() [1/2]

auto & opcua::ua::VariableAttributes::setDataType ( NodeId  dataType )

inline

Examples

custom_datatypes/server_custom_datatypes.cpp.

Definition at line 492 of file types.hpp.

setDataType() [2/2]

template<typename T >

auto & opcua::ua::VariableAttributes::setDataType ( )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Deduce the dataType from the template type.

Definition at line 497 of file types.hpp.

valueRank()

ValueRank opcua::ua::VariableAttributes::valueRank ( ) const

inlinenoexcept

Definition at line 501 of file types.hpp.

getValueRank()

ValueRank opcua::ua::VariableAttributes::getValueRank ( ) const

inlinenoexcept

Deprecated:

Use valueRank instead

Definition at line 501 of file types.hpp.

setValueRank()

auto & opcua::ua::VariableAttributes::setValueRank ( ValueRank  valueRank )

inlinenoexcept

Definition at line 501 of file types.hpp.

arrayDimensions() [1/2]

Span< const uint32_t > opcua::ua::VariableAttributes::arrayDimensions ( ) const

inlinenoexcept

Definition at line 508 of file types.hpp.

arrayDimensions() [2/2]

Span< uint32_t > opcua::ua::VariableAttributes::arrayDimensions ( )

inlinenoexcept

Definition at line 508 of file types.hpp.

getArrayDimensions() [1/2]

Span< const uint32_t > opcua::ua::VariableAttributes::getArrayDimensions ( ) const

inlinenoexcept

Deprecated:

Use arrayDimensions instead

Definition at line 508 of file types.hpp.

getArrayDimensions() [2/2]

Span< uint32_t > opcua::ua::VariableAttributes::getArrayDimensions ( )

inlinenoexcept

Deprecated:

Use arrayDimensions instead

Definition at line 508 of file types.hpp.

setArrayDimensions()

auto & opcua::ua::VariableAttributes::setArrayDimensions ( Span< const uint32_t >  arrayDimensions )

inline

Definition at line 508 of file types.hpp.

accessLevel()

Bitmask< AccessLevel > opcua::ua::VariableAttributes::accessLevel ( ) const

inlinenoexcept

Definition at line 511 of file types.hpp.

getAccessLevel()

Bitmask< AccessLevel > opcua::ua::VariableAttributes::getAccessLevel ( ) const

inlinenoexcept

Deprecated:

Use accessLevel instead

Definition at line 511 of file types.hpp.

setAccessLevel()

auto & opcua::ua::VariableAttributes::setAccessLevel ( Bitmask< AccessLevel >  accessLevel )

inlinenoexcept

Examples

server_accesscontrol.cpp, and server_datasource.cpp.

Definition at line 511 of file types.hpp.

userAccessLevel()

Bitmask< AccessLevel > opcua::ua::VariableAttributes::userAccessLevel ( ) const

inlinenoexcept

Definition at line 517 of file types.hpp.

getUserAccessLevel()

Bitmask< AccessLevel > opcua::ua::VariableAttributes::getUserAccessLevel ( ) const

inlinenoexcept

Deprecated:

Use userAccessLevel instead

Definition at line 517 of file types.hpp.

setUserAccessLevel()

auto & opcua::ua::VariableAttributes::setUserAccessLevel ( Bitmask< AccessLevel >  userAccessLevel )

inlinenoexcept

Definition at line 517 of file types.hpp.

minimumSamplingInterval()

double opcua::ua::VariableAttributes::minimumSamplingInterval ( ) const

inlinenoexcept

Definition at line 523 of file types.hpp.

getMinimumSamplingInterval()

double opcua::ua::VariableAttributes::getMinimumSamplingInterval ( ) const

inlinenoexcept

Deprecated:

Use minimumSamplingInterval instead

Definition at line 523 of file types.hpp.

setMinimumSamplingInterval()

auto & opcua::ua::VariableAttributes::setMinimumSamplingInterval ( double  minimumSamplingInterval )

inlinenoexcept

Definition at line 523 of file types.hpp.

historizing()

bool opcua::ua::VariableAttributes::historizing ( ) const

inlinenoexcept

Definition at line 524 of file types.hpp.

getHistorizing()

bool opcua::ua::VariableAttributes::getHistorizing ( ) const

inlinenoexcept

Deprecated:

Use historizing instead

Definition at line 524 of file types.hpp.

setHistorizing()

auto & opcua::ua::VariableAttributes::setHistorizing ( bool  historizing )

inlinenoexcept

Definition at line 524 of file types.hpp.

TypeWrapper() [1/5]

constexpr opcua::TypeWrapper< T, Index >::TypeWrapper ( )

constexprdefaultnoexcept

TypeWrapper() [2/5]

constexpr opcua::TypeWrapper< T, Index >::TypeWrapper ( const T &  native )

inlineexplicitconstexpr

Constructor with native object (deep copy).

Definition at line 31 of file typewrapper.hpp.

TypeWrapper() [3/5]

constexpr opcua::TypeWrapper< T, Index >::TypeWrapper ( T &&  native )

inlineconstexprnoexcept

Constructor with native object (move rvalue).

Definition at line 35 of file typewrapper.hpp.

TypeWrapper() [4/5]

constexpr opcua::TypeWrapper< T, Index >::TypeWrapper ( const TypeWrapper &  other )

inlineconstexpr

Copy constructor (deep copy).

Definition at line 43 of file typewrapper.hpp.

TypeWrapper() [5/5]

constexpr opcua::TypeWrapper< T, Index >::TypeWrapper ( TypeWrapper &&  other )

inlineconstexprnoexcept

Move constructor.

Definition at line 47 of file typewrapper.hpp.