PLCnext API Documentation  22.6.0.43
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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. More...
 
 StandardAttributes (const StandardAttributes &arg)=default
 Copy constructor. More...
 
 StandardAttributes (StandardAttributes &&arg)=default
 Move constructor. More...
 
StandardAttributesoperator= (const StandardAttributes &arg)=default
 Copy assignment operator. More...
 
StandardAttributesoperator= (StandardAttributes &&arg)=default
 Move assignment operator More...
 
 ~StandardAttributes (void)=default
 Destructs this instance and frees all resources. More...
 
 operator StandardAttribute (void) const
 Implicit type conversion to StandardAttribute More...
 
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

Constructor & Destructor Documentation

◆ StandardAttributes() [1/3]

Arp::Plc::Commons::Meta::StandardAttributes::StandardAttributes ( StandardAttribute  value = StandardAttribute::None)
inline

Constructs a StandardAttributes instance.

◆ StandardAttributes() [2/3]

Arp::Plc::Commons::Meta::StandardAttributes::StandardAttributes ( const StandardAttributes arg)
default

Copy constructor.

◆ StandardAttributes() [3/3]

Arp::Plc::Commons::Meta::StandardAttributes::StandardAttributes ( StandardAttributes &&  arg)
default

Move constructor.

◆ ~StandardAttributes()

Arp::Plc::Commons::Meta::StandardAttributes::~StandardAttributes ( void  )
default

Destructs this instance and frees all resources.

Member Function Documentation

◆ CountSet()

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

Gets the number of set flags

Returns
number of set flags

◆ GetCacheSize()

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

Get the cache size

Returns
Number of using cache size

◆ GetValue()

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

Gets the underlying value

Returns
underlying SatndardAttribute value

◆ IsAnySet()

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

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
inline

Check if a flag is set

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

◆ operator StandardAttribute()

Arp::Plc::Commons::Meta::StandardAttributes::operator StandardAttribute ( void  ) const
inline

Implicit type conversion to StandardAttribute

◆ operator=() [1/2]

StandardAttributes& Arp::Plc::Commons::Meta::StandardAttributes::operator= ( const StandardAttributes arg)
default

Copy assignment operator.

◆ operator=() [2/2]

StandardAttributes& Arp::Plc::Commons::Meta::StandardAttributes::operator= ( StandardAttributes &&  arg)
default

Move assignment operator


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