1. Epic GamesDeveloper
  3. TUnion

TUnion

Represents a type which is the union of several other types; i.e. it can have a value whose type is of any the union's subtypes.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Containers

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Containers/Union.h
Include #include "Containers/Union.h"

Syntax

template<typename TypeA, typename TypeB, typename TypeC, typename TypeD, typename TypeE, typename TypeF>  
class TUnion

Remarks

Represents a type which is the union of several other types; i.e. it can have a value whose type is of any the union's subtypes. This differs from C union types by being type-safe, and supporting non-trivial data types as subtypes. Since a value for the union must be of a single subtype, the union stores potential values of different subtypes in overlapped memory, and keeps track of which one is currently valid.

TUnion should be considered deprecated and TVariant should be used instead for new code.

Variables

  Type Name Description
Public variable TTypeCompatibleBytes< TypeA > A  
Public variable TTypeCompatibleBytes< TypeB > B  
Public variable TTypeCompatibleBytes< TypeC > C  
Public variable TTypeCompatibleBytes< TypeD > D  
Public variable TTypeCompatibleBytes< TypeE > E  
Public variable TTypeCompatibleBytes< TypeF > F  

Constructors

  Type Name Description
Public function  

TUnion ()

 Default constructor.
Public function  

TUnion ( const TUnion& Other
)

 Copy constructor.
Public function  

TUnion ( typename TCallTraits< TypeA >::ParamType InValue,
TDisambiguater< 0 > Disambiguater
)

 Initialization constructor.
Public function  

TUnion ( typename TCallTraits< TypeB >::ParamType InValue,
TDisambiguater< 1 > Disambiguater
)

 Initialization constructor.
Public function  

TUnion ( typename TCallTraits< TypeC >::ParamType InValue,
TDisambiguater< 2 > Disambiguater
)

 Initialization constructor.
Public function  

TUnion ( typename TCallTraits< TypeD >::ParamType InValue,
TDisambiguater< 3 > Disambiguater
)

 Initialization constructor.
Public function  

TUnion ( typename TCallTraits< TypeE >::ParamType InValue,
TDisambiguater< 4 > Disambiguater
)

 Initialization constructor.
Public function  

TUnion ( typename TCallTraits< TypeF >::ParamType InValue,
TDisambiguater< 5 > Disambiguater
)

 Initialization constructor.

Destructors

  Type Name Description
Public function  

~TUnion ()

 Destructor.

Functions

  Type Name Description
Public function Const uint8  
Public function Const const Subtype &  
Public function Subtype &  
Public function Const bool  
Public function void

Reset ()

 Sets the union's value to NULL.
Public function void If the union's current value is of the given subtype, sets the union's value to a NULL value.
Public function void  
Public function Subtype * Replaces the value of the union with a value of the given subtype.
Public function Subtype *

SetSubtype ( typename TCallTraits< Subtype >::ParamType NewValue
)

 Replaces the value of the union with a value of the given subtype.

Operators

  Type Name Description
Public function TUnion &

operator= ( const TUnion& Other
)

  
Public function Const bool

operator== ( const TUnion& Other
)

 Equality comparison.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page