CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdSaveStateFlagsMask< T, flagsMask > Class Template Reference

#include <SaveState.h>

Public Member Functions

 OdSaveStateFlagsMask (T &variable)
 
 OdSaveStateFlagsMask (T &variable, const T &newValue)
 
 ~OdSaveStateFlagsMask ()
 
 operator const T & () const
 

Detailed Description

template<class T, T flagsMask>
class OdSaveStateFlagsMask< T, flagsMask >

This template class implements SaveState objects which save and restore flags mask.

Remarks
Flags saved locally on construction of OdSaveState objects. Flags restored when OdSaveState objects go out of scope.

<group Other_Classes>

Definition at line 167 of file SaveState.h.

Constructor & Destructor Documentation

◆ OdSaveStateFlagsMask() [1/2]

template<class T , T flagsMask>
OdSaveStateFlagsMask< T, flagsMask >::OdSaveStateFlagsMask ( T &  variable)
inline

Constructor for objects of the OdSaveStateFlagsMask class. Saves flags without assigning it a new value.

Parameters
variable[in] Variable to save.

Definition at line 177 of file SaveState.h.

◆ OdSaveStateFlagsMask() [2/2]

template<class T , T flagsMask>
OdSaveStateFlagsMask< T, flagsMask >::OdSaveStateFlagsMask ( T &  variable,
const T &  newValue 
)
inline

Constructor for objects of the OdSaveStateFlagsMask class. Saves flags and assigns them a new value.

Parameters
variable[in] Variable to save.
newValue[in] New value for flags.

Definition at line 188 of file SaveState.h.

◆ ~OdSaveStateFlagsMask()

template<class T , T flagsMask>
OdSaveStateFlagsMask< T, flagsMask >::~OdSaveStateFlagsMask ( )
inline

Destructor for objects of the OdSaveState class. Restores the old value of a variable.

Definition at line 196 of file SaveState.h.

Member Function Documentation

◆ operator const T &()

template<class T , T flagsMask>
OdSaveStateFlagsMask< T, flagsMask >::operator const T & ( ) const
inline

Returns the saved flags of the variable.

Definition at line 204 of file SaveState.h.


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