Public Member Functions | Public Attributes | List of all members
ZipArchiveLib::CBitFlag Struct Reference

#include <BitFlag.h>

Public Member Functions

 CBitFlag ()
 
 CBitFlag (int value)
 
void Change (int flags, bool set)
 
bool ChangeWithCheck (int flags, bool set)
 
void Clear (int flags)
 
bool ClearWithCheck (int flags)
 
bool IsSetAll (int flags) const
 
bool IsSetAny (int flags) const
 
 operator int () const
 
CBitFlagoperator= (const CBitFlag &flag)
 
bool operator== (int value)
 
bool operator== (const CBitFlag &flag)
 
void Set (int flags)
 
bool SetWithCheck (int flags)
 

Public Attributes

int m_value
 

Detailed Description

Provides functionality for bit operations on an integer value.

Definition at line 32 of file BitFlag.h.

Constructor & Destructor Documentation

ZipArchiveLib::CBitFlag::CBitFlag ( )
inline

Initializes a new instance of the CBitFlag class.

Definition at line 44 of file BitFlag.h.

ZipArchiveLib::CBitFlag::CBitFlag ( int  value)
inline

Initializes a new instance of the CBitFlag class.

Parameters
valueThe initial value.

Definition at line 55 of file BitFlag.h.

Member Function Documentation

void ZipArchiveLib::CBitFlag::Change ( int  flags,
bool  set 
)
inline

Changes the given flags.

Parameters
flagsThe flags to change.
setIf true, the flags will be set; otherwise the flags will be cleared.

Definition at line 177 of file BitFlag.h.

bool ZipArchiveLib::CBitFlag::ChangeWithCheck ( int  flags,
bool  set 
)
inline

Changes the given flags and examines if this caused a modification to the current object.

Parameters
flagsThe flags to change.
setIf true, the flags will be set; otherwise the flags will be cleared.
Returns
true, if the operation caused a modification; false otherwise.

Definition at line 163 of file BitFlag.h.

void ZipArchiveLib::CBitFlag::Clear ( int  flags)
inline

Clears the given flags.

Parameters
flagsThe flags to clear.

Definition at line 77 of file BitFlag.h.

bool ZipArchiveLib::CBitFlag::ClearWithCheck ( int  flags)
inline

Clears the given flags and examines if this caused a modification to the current object.

Parameters
flagsThe flags to clear.
Returns
true, if the operation caused modification; false otherwise.

Definition at line 141 of file BitFlag.h.

bool ZipArchiveLib::CBitFlag::IsSetAll ( int  flags) const
inline

Returns the value indicating whether all of the given flags are set.

Parameters
flagsThe flags to examine.
Returns
true, if all of the given flags are set; false otherwise.

Definition at line 106 of file BitFlag.h.

bool ZipArchiveLib::CBitFlag::IsSetAny ( int  flags) const
inline

Returns the value indicating whether any of the given flags is set.

Parameters
flagsThe flags to examine.
Returns
true, if any of the given flags is set; false otherwise.

Definition at line 91 of file BitFlag.h.

ZipArchiveLib::CBitFlag::operator int ( ) const
inline

Returns the current value.

Definition at line 185 of file BitFlag.h.

void ZipArchiveLib::CBitFlag::Set ( int  flags)
inline

Sets the given flags.

Parameters
flagsThe flags to set.

Definition at line 66 of file BitFlag.h.

bool ZipArchiveLib::CBitFlag::SetWithCheck ( int  flags)
inline

Sets the given flags and examines if this caused a modification to the current object.

Parameters
flagsThe flags to set.
Returns
true, if the operation caused modification; false otherwise.

Definition at line 121 of file BitFlag.h.

Member Data Documentation

int ZipArchiveLib::CBitFlag::m_value

The current value.

Definition at line 39 of file BitFlag.h.


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

The ZipArchive Library Copyright © 2000 - 2022 Artpol Software - Tadeusz Dracz. Generated at Sat Dec 17 2022 19:57:04.