open62541pp 0.16.0
C++ wrapper of open62541
Loading...
Searching...
No Matches
opcua::VariableAttributes Class Reference

#include <types_composed.hpp>

Inheritance diagram for opcua::VariableAttributes:
[legend]

Detailed Description

Public Member Functions

 VariableAttributes ()
 
Bitmask< NodeAttributesMaskgetSpecifiedAttributes () const noexcept
 
const LocalizedTextgetDisplayName () const noexcept
 
auto & setDisplayName (const LocalizedText &displayName)
 
const LocalizedTextgetDescription () const noexcept
 
auto & setDescription (const LocalizedText &description)
 
Bitmask< WriteMaskgetWriteMask () const noexcept
 
auto & setWriteMask (Bitmask< WriteMask > writeMask) noexcept
 
Bitmask< WriteMaskgetUserWriteMask () const noexcept
 
auto & setUserWriteMask (Bitmask< WriteMask > userWriteMask) noexcept
 
const VariantgetValue () const noexcept
 
auto & setValue (const Variant &value)
 
template<typename... Args>
auto & setValueScalar (Args &&... args)
 
template<typename... Args>
auto & setValueArray (Args &&... args)
 
const NodeIdgetDataType () const noexcept
 
auto & setDataType (const NodeId &dataType)
 
template<typename T >
auto & setDataType ()
 
ValueRank getValueRank () const noexcept
 
auto & setValueRank (ValueRank valueRank) noexcept
 
Span< const uint32_t > getArrayDimensions () const noexcept
 
Span< uint32_t > getArrayDimensions () noexcept
 
auto & setArrayDimensions (Span< const uint32_t > arrayDimensions)
 
Bitmask< AccessLevelgetAccessLevel () const noexcept
 
auto & setAccessLevel (Bitmask< AccessLevel > accessLevel) noexcept
 
Bitmask< AccessLevelgetUserAccessLevel () const noexcept
 
auto & setUserAccessLevel (Bitmask< AccessLevel > userAccessLevel) noexcept
 
double getMinimumSamplingInterval () const noexcept
 
auto & setMinimumSamplingInterval (double minimumSamplingInterval) noexcept
 
bool getHistorizing () const noexcept
 
auto & setHistorizing (bool historizing) noexcept
 
constexpr TypeWrapper ()=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 ()=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 TypeWrapperoperator= (const TypeWrapper &other)
 
constexpr TypeWrapperoperator= (const UA_VariableAttributes &native)
 
constexpr TypeWrapperoperator= (TypeWrapper &&other) noexcept
 
constexpr TypeWrapperoperator= (UA_VariableAttributes &&native) noexcept
 
constexpr void swap (TypeWrapper &other) noexcept
 
constexpr void swap (UA_VariableAttributes &native) noexcept
 
- Public Member Functions inherited from opcua::Wrapper< UA_VariableAttributes >
constexpr Wrapper ()=default
 
constexpr Wrapper (const UA_VariableAttributes &native)
 
constexpr Wrapper (UA_VariableAttributes &&native) noexcept
 
constexpr operator UA_VariableAttributes & () noexcept
 
constexpr operator const UA_VariableAttributes & () const noexcept
 
constexpr UA_VariableAttributesoperator-> () noexcept
 
constexpr const UA_VariableAttributesoperator-> () const noexcept
 
constexpr UA_VariableAttributeshandle () noexcept
 
constexpr const UA_VariableAttributeshandle () const noexcept
 

Additional Inherited Members

- Public Types inherited from opcua::Wrapper< UA_VariableAttributes >
using NativeType
 
- Static Public Member Functions inherited from opcua::TypeWrapper< UA_VariableAttributes, UA_TYPES_VARIABLEATTRIBUTES >
static constexpr TypeIndex getTypeIndex ()
 
- Protected Member Functions inherited from opcua::TypeWrapper< UA_VariableAttributes, UA_TYPES_VARIABLEATTRIBUTES >
constexpr void clear () noexcept
 
- Protected Member Functions inherited from opcua::Wrapper< UA_VariableAttributes >
constexpr const UA_VariableAttributesnative () const noexcept
 
constexpr UA_VariableAttributesnative () noexcept
 

Constructor & Destructor Documentation

◆ VariableAttributes()

opcua::VariableAttributes::VariableAttributes ( )
inline

Construct with default attribute definitions.

Definition at line 382 of file types_composed.hpp.

Member Function Documentation

◆ getSpecifiedAttributes()

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

Definition at line 385 of file types_composed.hpp.

◆ getDisplayName()

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

Definition at line 385 of file types_composed.hpp.

◆ setDisplayName()

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

Definition at line 385 of file types_composed.hpp.

◆ getDescription()

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

Definition at line 385 of file types_composed.hpp.

◆ setDescription()

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

Definition at line 385 of file types_composed.hpp.

◆ getWriteMask()

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

Definition at line 385 of file types_composed.hpp.

◆ setWriteMask()

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

Definition at line 385 of file types_composed.hpp.

◆ getUserWriteMask()

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

Definition at line 385 of file types_composed.hpp.

◆ setUserWriteMask()

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

Definition at line 385 of file types_composed.hpp.

◆ getValue()

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

Definition at line 386 of file types_composed.hpp.

◆ setValue()

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

Definition at line 386 of file types_composed.hpp.

◆ setValueScalar()

template<typename... Args>
auto & opcua::VariableAttributes::setValueScalar ( Args &&... args)
inline
See also
Variant::fromScalar

Definition at line 390 of file types_composed.hpp.

◆ setValueArray()

template<typename... Args>
auto & opcua::VariableAttributes::setValueArray ( Args &&... args)
inline
See also
Variant::fromArray

Definition at line 396 of file types_composed.hpp.

◆ getDataType()

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

Definition at line 400 of file types_composed.hpp.

◆ setDataType() [1/2]

auto & opcua::VariableAttributes::setDataType ( const NodeId & dataType)
inline

◆ setDataType() [2/2]

template<typename T >
auto & opcua::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 405 of file types_composed.hpp.

◆ getValueRank()

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

Definition at line 409 of file types_composed.hpp.

◆ setValueRank()

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

Definition at line 409 of file types_composed.hpp.

◆ getArrayDimensions() [1/2]

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

Definition at line 416 of file types_composed.hpp.

◆ getArrayDimensions() [2/2]

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

Definition at line 416 of file types_composed.hpp.

◆ setArrayDimensions()

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

Definition at line 416 of file types_composed.hpp.

◆ getAccessLevel()

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

Definition at line 419 of file types_composed.hpp.

◆ setAccessLevel()

auto & opcua::VariableAttributes::setAccessLevel ( Bitmask< AccessLevel > accessLevel)
inlinenoexcept
Examples
server_accesscontrol.cpp, and server_datasource.cpp.

Definition at line 419 of file types_composed.hpp.

◆ getUserAccessLevel()

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

Definition at line 425 of file types_composed.hpp.

◆ setUserAccessLevel()

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

Definition at line 425 of file types_composed.hpp.

◆ getMinimumSamplingInterval()

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

Definition at line 431 of file types_composed.hpp.

◆ setMinimumSamplingInterval()

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

Definition at line 431 of file types_composed.hpp.

◆ getHistorizing()

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

Definition at line 432 of file types_composed.hpp.

◆ setHistorizing()

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

Definition at line 432 of file types_composed.hpp.

◆ TypeWrapper() [1/5]

opcua::TypeWrapper< T, typeIndex >::TypeWrapper ( )
constexprdefault

◆ TypeWrapper() [2/5]

opcua::TypeWrapper< T, typeIndex >::TypeWrapper ( const T & native)
inlineexplicitconstexpr

Constructor with native object (deep copy).

Definition at line 31 of file typewrapper.hpp.

◆ TypeWrapper() [3/5]

opcua::TypeWrapper< T, typeIndex >::TypeWrapper ( T && native)
inlineconstexprnoexcept

Constructor with native object (move rvalue).

Definition at line 35 of file typewrapper.hpp.

◆ TypeWrapper() [4/5]

opcua::TypeWrapper< T, typeIndex >::TypeWrapper ( const TypeWrapper & other)
inlineconstexpr

Copy constructor (deep copy).

Definition at line 43 of file typewrapper.hpp.

◆ TypeWrapper() [5/5]

opcua::TypeWrapper< T, typeIndex >::TypeWrapper ( TypeWrapper && other)
inlineconstexprnoexcept

Move constructor.

Definition at line 47 of file typewrapper.hpp.