PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Attributes | List of all members
Arp::Plc::Commons::Meta::StandardAttributes Class Reference

Collection of StandardAttribute flags More...

#include <StandardAttributes.hpp>

Public Member Functions

 StandardAttributes (StandardAttribute value=StandardAttribute::None)
 Constructs a StandardAttributes instance.
 
 StandardAttributes (const StandardAttributes &arg)=default
 Copy constructor.
 
 StandardAttributes (StandardAttributes &&arg) noexcept=default
 Move constructor.
 
StandardAttributesoperator= (const StandardAttributes &arg)=default
 Copy assignment operator.
 
StandardAttributesoperator= (StandardAttributes &&arg) noexcept=default
 Move assignment operator
 
 ~StandardAttributes (void) noexcept=default
 Destructs this instance and frees all resources.
 
 operator StandardAttribute (void) const
 Implicit type conversion to StandardAttribute
 
size_t GetCacheSize (void) const
 Get the cache size More...
 
bool IsSet (StandardAttribute flag) const
 Check if a flag is set More...
 
bool IsAnySet (StandardAttribute flags) const
 Check if any of the given flags is set More...
 
size_t CountSet () const
 Gets the number of set flags More...
 
StandardAttribute GetValue (void) const
 Gets the underlying value More...
 

Static Public Attributes

static const StandardAttributes None
 

Detailed Description

Collection of StandardAttribute flags

Member Function Documentation

◆ CountSet()

size_t Arp::Plc::Commons::Meta::StandardAttributes::CountSet ( ) const

Gets the number of set flags

Returns
number of set flags

◆ GetCacheSize()

size_t Arp::Plc::Commons::Meta::StandardAttributes::GetCacheSize ( void  ) const

Get the cache size

Returns
Number of using cache size

◆ GetValue()

StandardAttribute Arp::Plc::Commons::Meta::StandardAttributes::GetValue ( void  ) const

Gets the underlying value

Returns
underlying SatndardAttribute value

◆ IsAnySet()

bool Arp::Plc::Commons::Meta::StandardAttributes::IsAnySet ( StandardAttribute  flags) const

Check if any of the given flags is set

Parameters
flagsStandardAttributes to check
Returns
true, if any of the flags is set

◆ IsSet()

bool Arp::Plc::Commons::Meta::StandardAttributes::IsSet ( StandardAttribute  flag) const

Check if a flag is set

Parameters
flagStandardAttribute to check
Returns
true, if the flag is set

The documentation for this class was generated from the following files: