FDMXProtocolName

A DMX protocol as a name that can be displayed in UI.

Windows
MacOS
Linux

Inheritance Hierarchy

FDMXNameListItem

FDMXProtocolName

References

Module

DMXProtocol

Header

/Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolTypes.h

Include

#include "DMXProtocolTypes.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType), Category="DMX")
struct FDMXProtocolName : public FDMXNameListItem

Remarks

A DMX protocol as a name that can be displayed in UI. The protocol is directly accessible via GetProtocol

Constructors

Name Description

Public function

FDMXProtocolName()

Public function

FDMXProtocolName

(
    const FName& InName
)

Construct from a protocol name

Public function

FDMXProtocolName

(
    IDMXProtocolPtr InProtocol
)

Construct from a protocol

Functions

Name Description

Public function Static

TArray< FNam...

 

GetPossibleValues()

Get the valid Names for the type

Public function Const

IDMXProtocol...

 

GetProtocol()

Returns the Protocol this name represents

Public function Const

bool

 

IsValid()

IsValid member accessor

Public function Static

bool

 

IsValid

(
    const FName& InName
)

True if this object still represents one of the possible values

Operators

Name Description

Public function Const

 

operator bool()

Bool (is valid) operator

Public function Const

 

operator const FName &()

Public function Const

 

operator const IDMXProtocolPtr()

Public function

 

operator FName &()

Public function

 

operator IDMXProtocolPtr()

Public function Const

bool

 

operator!=

(
    const FDMXProtocolName& Other
)

Public function Const

bool

 

operator!=

(
    const IDMXProtocolPtr& Other
)

Public function Const

bool

 

operator!=

(
    const FName& Other
)

Public function Const

bool

 

operator==

(
    const IDMXProtocolPtr& Other
)

Public function Const

bool

 

operator==

(
    const FDMXProtocolName& Other
)

Public function Const

bool

 

operator==

(
    const FName& Other
)

Constants

Name

Description

bCanBeNone

Whether SNameListPicker should display a None option for this type

OnValuesChanged

Delegate that should be called when the possible values for the type are changed

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss