Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | Friends | List of all members
TOptional< TNonNullPtr< OptionalType > > Struct Template Reference

#include <NonNullPointer.h>

Public Member Functions

 TOptional (const TNonNullPtr< OptionalType > &InPointer)
 
 TOptional ()
 
 TOptional (FNullOpt)
 
TOptional & operator= (const TOptional &Other)
 
TOptional & operator= (OptionalType *InPointer)
 
void Reset ()
 
OptionalType * Emplace (OptionalType *InPointer)
 
bool operator== (const TOptional &rhs) const
 
bool operator!= (const TOptional &rhs) const
 
bool IsSet () const
 
FORCEINLINE operator bool () const
 
OptionalType * GetValue () const
 
OptionalType * operator-> () const
 
OptionalType & operator* () const
 
OptionalType * Get (OptionalType *DefaultPointer) const
 

Private Attributes

OptionalType * Pointer
 

Friends

FArchive & operator<< (FArchive &Ar, TOptional &Optional)
 

Detailed Description

template<typename OptionalType>
struct TOptional< TNonNullPtr< OptionalType > >

Specialization of TOptional for TNonNullPtr value types

Definition at line 171 of file NonNullPointer.h.

Constructor & Destructor Documentation

◆ TOptional() [1/3]

template<typename OptionalType >
TOptional< TNonNullPtr< OptionalType > >::TOptional ( const TNonNullPtr< OptionalType > & InPointer)
inline

Construct an OptionaType with a valid value.

Definition at line 175 of file NonNullPointer.h.

◆ TOptional() [2/3]

template<typename OptionalType >
TOptional< TNonNullPtr< OptionalType > >::TOptional ( )
inline

Construct an OptionalType with no value; i.e. unset

Definition at line 181 of file NonNullPointer.h.

◆ TOptional() [3/3]

template<typename OptionalType >
TOptional< TNonNullPtr< OptionalType > >::TOptional ( FNullOpt )
inline

Construct an OptionalType with an invalid value.

Definition at line 187 of file NonNullPointer.h.

Member Function Documentation

◆ Emplace()

template<typename OptionalType >
OptionalType * TOptional< TNonNullPtr< OptionalType > >::Emplace ( OptionalType * InPointer)
inline

Definition at line 209 of file NonNullPointer.h.

◆ Get()

template<typename OptionalType >
OptionalType * TOptional< TNonNullPtr< OptionalType > >::Get ( OptionalType * DefaultPointer) const
inline
Returns
The optional value when set; DefaultValue otherwise.

Definition at line 243 of file NonNullPointer.h.

◆ GetValue()

template<typename OptionalType >
OptionalType * TOptional< TNonNullPtr< OptionalType > >::GetValue ( ) const
inline
Returns
The optional value; undefined when IsSet() returns false.

Definition at line 236 of file NonNullPointer.h.

◆ IsSet()

template<typename OptionalType >
bool TOptional< TNonNullPtr< OptionalType > >::IsSet ( ) const
inline
Returns
true when the value is meaningful; false if calling GetValue() is undefined.

Definition at line 232 of file NonNullPointer.h.

◆ operator bool()

template<typename OptionalType >
FORCEINLINE TOptional< TNonNullPtr< OptionalType > >::operator bool ( ) const
inlineexplicit

Definition at line 233 of file NonNullPointer.h.

◆ operator!=()

template<typename OptionalType >
bool TOptional< TNonNullPtr< OptionalType > >::operator!= ( const TOptional< TNonNullPtr< OptionalType > > & rhs) const
inline

Definition at line 220 of file NonNullPointer.h.

◆ operator*()

template<typename OptionalType >
OptionalType & TOptional< TNonNullPtr< OptionalType > >::operator* ( ) const
inline

Definition at line 240 of file NonNullPointer.h.

◆ operator->()

template<typename OptionalType >
OptionalType * TOptional< TNonNullPtr< OptionalType > >::operator-> ( ) const
inline

Definition at line 238 of file NonNullPointer.h.

◆ operator=() [1/2]

template<typename OptionalType >
TOptional & TOptional< TNonNullPtr< OptionalType > >::operator= ( const TOptional< TNonNullPtr< OptionalType > > & Other)
inline

Definition at line 192 of file NonNullPointer.h.

◆ operator=() [2/2]

template<typename OptionalType >
TOptional & TOptional< TNonNullPtr< OptionalType > >::operator= ( OptionalType * InPointer)
inline

Definition at line 198 of file NonNullPointer.h.

◆ operator==()

template<typename OptionalType >
bool TOptional< TNonNullPtr< OptionalType > >::operator== ( const TOptional< TNonNullPtr< OptionalType > > & rhs) const
inline

Definition at line 215 of file NonNullPointer.h.

◆ Reset()

template<typename OptionalType >
void TOptional< TNonNullPtr< OptionalType > >::Reset ( )
inline

Definition at line 204 of file NonNullPointer.h.

Friends And Related Symbol Documentation

◆ operator<<

template<typename OptionalType >
FArchive & operator<< ( FArchive & Ar,
TOptional< TNonNullPtr< OptionalType > > & Optional )
friend

Definition at line 225 of file NonNullPointer.h.

Member Data Documentation

◆ Pointer

template<typename OptionalType >
OptionalType* TOptional< TNonNullPtr< OptionalType > >::Pointer
private

Definition at line 246 of file NonNullPointer.h.

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