Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
VdfMaskedOutput Class Reference

Class to hold on to an externally owned output and a mask. More...

#include <maskedOutput.h>

Public Member Functions

 VdfMaskedOutput (VdfOutput *output, const VdfMask &mask)
 
 VdfMaskedOutput (VdfOutput *output, VdfMask &&mask)
 
 operator bool () const
 Cast to bool: returns true if the output is non-null.
 
VdfOutput * GetOutput () const
 Returns the VdfOutput.
 
void SetOutput (VdfOutput *output)
 Sets the output to output.
 
const VdfMask & GetMask () const
 Returns the VdfMask.
 
void SetMask (const VdfMask &mask)
 Sets the mask to mask.
 
void SetMask (VdfMask &&mask)
 Sets the mask to mask.
 
bool operator== (const VdfMaskedOutput &rhs) const
 Equality comparison.
 
bool operator!= (const VdfMaskedOutput &rhs) const
 
bool operator< (const VdfMaskedOutput &rhs) const
 
bool operator<= (const VdfMaskedOutput &rhs) const
 
bool operator> (const VdfMaskedOutput &rhs) const
 
bool operator>= (const VdfMaskedOutput &rhs) const
 
VDF_API std::string GetDebugName () const
 Returns a string describing this masked output.
 

Friends

void swap (VdfMaskedOutput &lhs, VdfMaskedOutput &rhs)
 

Detailed Description

Class to hold on to an externally owned output and a mask. 

   Objects of this class explicitly have two operators defined so that
   they can act as VdfOutput.

Definition at line 31 of file maskedOutput.h.

Constructor & Destructor Documentation

◆ VdfMaskedOutput() [1/3]

VdfMaskedOutput ( )
inline

Definition at line 35 of file maskedOutput.h.

◆ VdfMaskedOutput() [2/3]

VdfMaskedOutput ( VdfOutput *  output,
const VdfMask &  mask 
)
inline

Definition at line 38 of file maskedOutput.h.

◆ VdfMaskedOutput() [3/3]

VdfMaskedOutput ( VdfOutput *  output,
VdfMask &&  mask 
)
inline

Definition at line 41 of file maskedOutput.h.

Member Function Documentation

◆ GetDebugName()

VDF_API std::string GetDebugName ( ) const

Returns a string describing this masked output.

◆ GetMask()

const VdfMask & GetMask ( ) const
inline

Returns the VdfMask.

Definition at line 64 of file maskedOutput.h.

◆ GetOutput()

VdfOutput * GetOutput ( ) const
inline

Returns the VdfOutput.

Definition at line 52 of file maskedOutput.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Cast to bool: returns true if the output is non-null.

Definition at line 46 of file maskedOutput.h.

◆ operator!=()

bool operator!= ( const VdfMaskedOutput &  rhs) const
inline

Definition at line 87 of file maskedOutput.h.

◆ operator<()

bool operator< ( const VdfMaskedOutput &  rhs) const
inline

Definition at line 101 of file maskedOutput.h.

◆ operator<=()

bool operator<= ( const VdfMaskedOutput &  rhs) const
inline

Definition at line 112 of file maskedOutput.h.

◆ operator==()

bool operator== ( const VdfMaskedOutput &  rhs) const
inline

Equality comparison.

Definition at line 82 of file maskedOutput.h.

◆ operator>()

bool operator> ( const VdfMaskedOutput &  rhs) const
inline

Definition at line 116 of file maskedOutput.h.

◆ operator>=()

bool operator>= ( const VdfMaskedOutput &  rhs) const
inline

Definition at line 120 of file maskedOutput.h.

◆ SetMask() [1/2]

void SetMask ( const VdfMask &  mask)
inline

Sets the mask to mask.

Definition at line 70 of file maskedOutput.h.

◆ SetMask() [2/2]

void SetMask ( VdfMask &&  mask)
inline

Sets the mask to mask.

Definition at line 76 of file maskedOutput.h.

◆ SetOutput()

void SetOutput ( VdfOutput *  output)
inline

Sets the output to output.

Definition at line 58 of file maskedOutput.h.

Friends And Related Function Documentation

◆ swap

void swap ( VdfMaskedOutput &  lhs,
VdfMaskedOutput &  rhs 
)
friend

Definition at line 124 of file maskedOutput.h.

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