open62541pp 0.19.0
C++ wrapper of open62541
Loading...
Searching...
No Matches
Public Member Functions | List of all members
opcua::ua::VariableAttributes Class Reference

#include <types.hpp>

Inheritance diagram for opcua::ua::VariableAttributes:
[legend]

Detailed Description

UA_VariableAttributes wrapper class.

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

Definition at line 418 of file types.hpp.

Public Member Functions

 VariableAttributes ()
 
Bitmask< NodeAttributesMaskspecifiedAttributes () const noexcept
 
const LocalizedTextdisplayName () const noexcept
 
autosetDisplayName (LocalizedText displayName)
 
const LocalizedTextdescription () const noexcept
 
autosetDescription (LocalizedText description)
 
Bitmask< WriteMaskwriteMask () const noexcept
 
autosetWriteMask (Bitmask< WriteMask > writeMask) noexcept
 
Bitmask< WriteMaskuserWriteMask () const noexcept
 
autosetUserWriteMask (Bitmask< WriteMask > userWriteMask) noexcept
 
const Variantvalue () const noexcept
 
autosetValue (Variant value)
 
template<typename... Args>
autosetValueScalar (Args &&... args)
 
template<typename... Args>
autosetValueArray (Args &&... args)
 
const NodeIddataType () const noexcept
 
auto & setDataType (NodeId dataType)
 
template<typename T >
auto & setDataType ()
 
ValueRank valueRank () const noexcept
 
autosetValueRank (ValueRank valueRank) noexcept
 
Span< const uint32_tarrayDimensions () const noexcept
 
Span< uint32_tarrayDimensions () noexcept
 
autosetArrayDimensions (Span< const uint32_t > arrayDimensions)
 
Bitmask< AccessLevelaccessLevel () const noexcept
 
autosetAccessLevel (Bitmask< AccessLevel > accessLevel) noexcept
 
Bitmask< AccessLeveluserAccessLevel () const noexcept
 
autosetUserAccessLevel (Bitmask< AccessLevel > userAccessLevel) noexcept
 
double minimumSamplingInterval () const noexcept
 
autosetMinimumSamplingInterval (double minimumSamplingInterval) noexcept
 
bool historizing () const noexcept
 
autosetHistorizing (bool historizing) noexcept
 
constexpr Wrapper () noexcept=default
 
constexpr Wrapper (const Wrapper &other)
 
constexpr Wrapper (const T &native)
 
constexpr Wrapper (Wrapper &&other) noexcept
 
constexpr Wrapper (T &&native) noexcept
 
- Public Member Functions inherited from opcua::Wrapper< T, Handler >
constexpr Wrapper () noexcept=default
 
constexpr Wrapper (const Wrapper &other)
 
constexpr Wrapper (const T &native)
 
constexpr Wrapper (Wrapper &&other) noexcept
 
constexpr Wrapper (T &&native) noexcept
 
 ~Wrapper () noexcept=default
 
constexpr Wrapperoperator= (const Wrapper &other)
 
constexpr Wrapperoperator= (const T &native)
 
constexpr Wrapperoperator= (Wrapper &&other) noexcept
 
constexpr Wrapperoperator= (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, Handler >
using NativeType = T
 
using HandlerType = Handler
 
- Protected Member Functions inherited from opcua::Wrapper< T, Handler >
constexpr const T & native () const noexcept
 
constexpr T & native () noexcept
 
constexpr void clear () noexcept
 

Constructor & Destructor Documentation

◆ VariableAttributes()

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

Construct with default attribute definitions.

Definition at line 424 of file types.hpp.

Member Function Documentation

◆ accessLevel()

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

Definition at line 463 of file types.hpp.

◆ arrayDimensions() [1/2]

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

Definition at line 460 of file types.hpp.

◆ arrayDimensions() [2/2]

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

Definition at line 460 of file types.hpp.

◆ dataType()

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

Definition at line 444 of file types.hpp.

◆ description()

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

Definition at line 427 of file types.hpp.

◆ displayName()

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

Definition at line 427 of file types.hpp.

◆ historizing()

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

Definition at line 476 of file types.hpp.

◆ minimumSamplingInterval()

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

Definition at line 475 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 463 of file types.hpp.

◆ setArrayDimensions()

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

Definition at line 460 of file types.hpp.

◆ setDataType() [1/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 449 of file types.hpp.

◆ setDataType() [2/2]

auto & opcua::ua::VariableAttributes::setDataType ( NodeId  dataType)
inline
Examples
custom_datatypes/server_custom_datatypes.cpp.

Definition at line 444 of file types.hpp.

◆ setDescription()

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

Definition at line 427 of file types.hpp.

◆ setDisplayName()

auto & opcua::ua::VariableAttributes::setDisplayName ( LocalizedText  displayName)
inline
Examples
server.cpp, and server_instantiation.cpp.

Definition at line 427 of file types.hpp.

◆ setHistorizing()

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

Definition at line 476 of file types.hpp.

◆ setMinimumSamplingInterval()

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

Definition at line 475 of file types.hpp.

◆ setUserAccessLevel()

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

Definition at line 469 of file types.hpp.

◆ setUserWriteMask()

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

Definition at line 427 of file types.hpp.

◆ setValue()

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

Definition at line 428 of file types.hpp.

◆ setValueArray()

template<typename... Args>
auto & opcua::ua::VariableAttributes::setValueArray ( Args &&...  args)
inline
Deprecated:
Use setValue(Variant{...}) instead

Definition at line 440 of file types.hpp.

◆ setValueRank()

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

Definition at line 453 of file types.hpp.

◆ setValueScalar()

template<typename... Args>
auto & opcua::ua::VariableAttributes::setValueScalar ( Args &&...  args)
inline
Deprecated:
Use setValue(Variant{...}) instead

Definition at line 433 of file types.hpp.

◆ setWriteMask()

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

Definition at line 427 of file types.hpp.

◆ specifiedAttributes()

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

Definition at line 427 of file types.hpp.

◆ userAccessLevel()

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

Definition at line 469 of file types.hpp.

◆ userWriteMask()

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

Definition at line 427 of file types.hpp.

◆ value()

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

Definition at line 428 of file types.hpp.

◆ valueRank()

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

Definition at line 453 of file types.hpp.

◆ Wrapper() [1/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( )
constexprdefaultnoexcept

◆ Wrapper() [2/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( const T &  native)
inlineexplicitconstexpr

Copy constructor with native object.

Definition at line 151 of file wrapper.hpp.

◆ Wrapper() [3/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( const Wrapper other)
inlineconstexpr

Copy constructor.

Definition at line 147 of file wrapper.hpp.

◆ Wrapper() [4/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( T &&  native)
inlineconstexprnoexcept

Move constructor with native object.

Definition at line 159 of file wrapper.hpp.

◆ Wrapper() [5/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( Wrapper &&  other)
inlineconstexprnoexcept

Move constructor.

Definition at line 155 of file wrapper.hpp.

◆ writeMask()

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

Definition at line 427 of file types.hpp.