TOptional

Forward declaration.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/Optional.h

Include

#include "Misc/Optional.h"

Syntax

template<typename OptionalType>
struct TOptional

Remarks

When we have an optional value IsSet() returns true, and GetValue() is meaningful. Otherwise GetValue() is not meaningful.

Constructors

Name Description

Public function

TOptional()

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

Public function

TOptional

(
    const OptionalType& InValue
)

Construct an OptionaType with a valid value.

Public function

TOptional

(
    OptionalType&& InValue
)

Public function

TOptional

(
    const TOptional& InValue
)

Copy/Move construction

Public function

TOptional

(
    TOptional&& InValue
)

Public function

TOptional

(
    EInPlace,
    ArgTypes&&... Args
)

Destructors

Name Description

Public function

~TOptional()

Functions

Name Description

Public function

OptionalType...

 

Emplace

(
    ArgsType&&... Args
)

Public function Const

const Option...

 

Get

(
    const OptionalType& DefaultValue
)

Public function Const

const Option...

 

GetValue()

Public function

OptionalType...

 

GetValue()

Public function Const

bool

 

IsSet()

Public function

void

 

Reset()

Operators

Name Description

Public function Const

 

operator bool()

Public function Const

const Option...

 

operator*()

Public function

OptionalType...

 

operator*()

Public function

TOptional &

 

operator=

(
    OptionalType&& InValue
)

Public function

TOptional &

 

operator=

(
    const OptionalType& InValue
)

Public function

TOptional &

 

operator=

(
    const TOptional& InValue
)

Public function

TOptional &

 

operator=

(
    TOptional&& InValue
)

Public function Const

const Option...

 

operator->()

Public function

OptionalType...

 

operator->()

Typedefs

Name

Description

ElementType