IRSOL
C++ code implementing socket server for interacting with Baumer camera.
irsol::camera::internal::FeaturePermissions Struct Reference

Encapsulates the permissions of a camera feature. More...

#include <discovery.hpp>

Public Member Functions

 FeaturePermissions (bool isAvailable, bool isReadable, bool isWritable)
 Constructs FeaturePermissions from boolean flags.
 
bool isAvailable () const
 Checks if the feature is available.
 
bool isReadable () const
 Checks if the feature is readable.
 
bool isWritable () const
 Checks if the feature is writable.
 
bool operator< (const FeaturePermissions &other) const
 Comparison operator for ordering FeaturePermissions.
 

Public Attributes

FeaturePermissionValue value
 Combined permission flags.
 

Detailed Description

Encapsulates the permissions of a camera feature.

Stores permission flags indicating availability, readability, and writability. Provides convenience methods to query individual permissions.

Definition at line 39 of file discovery.hpp.

Constructor & Destructor Documentation

◆ FeaturePermissions()

irsol::camera::internal::FeaturePermissions::FeaturePermissions ( bool  isAvailable,
bool  isReadable,
bool  isWritable 
)
inline

Constructs FeaturePermissions from boolean flags.

Parameters
isAvailableWhether the feature is available.
isReadableWhether the feature is readable.
isWritableWhether the feature is writable.

Definition at line 50 of file discovery.hpp.

55 {}
FeaturePermissionValue
Enumeration for feature permission bit flags.
Definition discovery.hpp:25
@ NOT_AVAILABLE
Feature is not available.
Definition discovery.hpp:27
@ AVAILABLE
Feature is available.
Definition discovery.hpp:28
@ UNSET
Permission state not set.
Definition discovery.hpp:26
@ READABLE
Feature is readable.
Definition discovery.hpp:29
@ WRITABLE
Feature is writable.
Definition discovery.hpp:30
bool isAvailable() const
Checks if the feature is available.
Definition discovery.hpp:61
FeaturePermissionValue value
Combined permission flags.
Definition discovery.hpp:41
bool isReadable() const
Checks if the feature is readable.
Definition discovery.hpp:70
bool isWritable() const
Checks if the feature is writable.
Definition discovery.hpp:79

Member Function Documentation

◆ isAvailable()

bool irsol::camera::internal::FeaturePermissions::isAvailable ( ) const
inline

Checks if the feature is available.

Returns
true if available, false otherwise.

Definition at line 61 of file discovery.hpp.

62 {
64 }

◆ isReadable()

bool irsol::camera::internal::FeaturePermissions::isReadable ( ) const
inline

Checks if the feature is readable.

Returns
true if readable, false otherwise.

Definition at line 70 of file discovery.hpp.

71 {
73 }

◆ isWritable()

bool irsol::camera::internal::FeaturePermissions::isWritable ( ) const
inline

Checks if the feature is writable.

Returns
true if writable, false otherwise.

Definition at line 79 of file discovery.hpp.

80 {
82 }

◆ operator<()

bool irsol::camera::internal::FeaturePermissions::operator< ( const FeaturePermissions other) const
inline

Comparison operator for ordering FeaturePermissions.

Enables usage as a key in ordered containers like std::map.

Parameters
otherThe other FeaturePermissions to compare with.
Returns
true if this permission value is less than the other.

Definition at line 92 of file discovery.hpp.

93 {
94 return value < other.value;
95 }

Member Data Documentation

◆ value

FeaturePermissionValue irsol::camera::internal::FeaturePermissions::value

Combined permission flags.

Definition at line 41 of file discovery.hpp.


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