mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git
synced 2025-09-29 05:17:33 +00:00
Update doc
This commit is contained in:
@@ -21,7 +21,15 @@ namespace sta
|
||||
using flag_type = F; /**< Enum type used for flag bits */
|
||||
|
||||
public:
|
||||
/**
|
||||
* @brief Default constructor.
|
||||
*/
|
||||
EnumFlags();
|
||||
/**
|
||||
* @brief Copy constructor.
|
||||
*
|
||||
* @param other Flags to copy
|
||||
*/
|
||||
EnumFlags(const EnumFlags & other);
|
||||
/**
|
||||
* @brief Construct from single flag.
|
||||
@@ -75,22 +83,62 @@ namespace sta
|
||||
// Operator overloads
|
||||
//
|
||||
|
||||
// Comparison
|
||||
/**
|
||||
* @brief Equal to operator.
|
||||
*
|
||||
* @param rhs Flags to compare
|
||||
* @return True if flags are equal
|
||||
*/
|
||||
bool operator ==(const EnumFlags & rhs) const;
|
||||
/**
|
||||
* @brief Not equal to operator.
|
||||
*
|
||||
* @param rhs Flags to compare
|
||||
* @return True if flags are not equal
|
||||
*/
|
||||
bool operator !=(const EnumFlags & rhs) const;
|
||||
|
||||
// Bitwise operators
|
||||
/**
|
||||
* @brief Bitwise AND operator.
|
||||
*
|
||||
* @param rhs Other flags
|
||||
* @return Result of bitwise AND
|
||||
*/
|
||||
EnumFlags operator &(const EnumFlags & rhs) const;
|
||||
/**
|
||||
* @brief Bitwise OR operator.
|
||||
*
|
||||
* @param rhs Other flags
|
||||
* @return Result of bitwise OR
|
||||
*/
|
||||
EnumFlags operator |(const EnumFlags & rhs) const;
|
||||
|
||||
// Assignment
|
||||
/**
|
||||
* @brief Bitwise AND assignment operator.
|
||||
*
|
||||
* @param rhs Other flags
|
||||
* @return Reference to this
|
||||
*/
|
||||
EnumFlags & operator &=(const EnumFlags & rhs);
|
||||
/**
|
||||
* @brief Bitwise OR assignment operator.
|
||||
*
|
||||
* @param rhs Other flags
|
||||
* @return Reference to this
|
||||
*/
|
||||
EnumFlags & operator |=(const EnumFlags & rhs);
|
||||
|
||||
// Conversion
|
||||
/**
|
||||
* @brief Explicitly convert flags to uint32_t.
|
||||
*/
|
||||
explicit operator uint32_t();
|
||||
|
||||
private:
|
||||
/**
|
||||
* @brief Construct from uint32_t flags.
|
||||
*
|
||||
* @param flags Flags
|
||||
*/
|
||||
EnumFlags(uint32_t flags);
|
||||
|
||||
private:
|
||||
|
Reference in New Issue
Block a user