FDMXPort

Base class for a higher level abstraction of a DMX input or output.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXProtocol

Header

/Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXPort.h

Include

#include "IO/DMXPort.h"

Syntax

Remarks

Base class for a higher level abstraction of a DMX input or output. Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity.

Variables

Name Description

Protected variable

EDMXCommunicati...

 

CommunicationType

The communication type of this port

Protected variable

FString

 

DeviceAddress

The address of the device that handles communication, e.g. the network interface for art-net

Protected variable

int32

 

ExternUniverseStart

The start address this being transposed to.

Protected variable

int32

 

LocalUniverseStart

The Local Start Universe

Protected variable

int32

 

NumUniverses

Number of Universes

Public variable

FSimpleMulticas...

 

OnPortUpdated

Broadcast when the port is updated

Protected variable

FString

 

PortName

Variables that need be initialized from derived classes.

Protected variable

IDMXProtocolPtr

 

Protocol

The protocol of this port

Constructors

Name Description

Protected function

FDMXPort()

Protected default constructor, child classes need to take care of member initialization

Destructors

Name Description

Public function Virtual

~FDMXPort()

~End DMXPort Interface declaration

Functions

Name Description

Protected function

void

 

AddRawListener

(
    TSharedRef< FDMXRawListener > InRaw...
)

Adds a Raw Listener that receives all raw signals received on this port.

Public function Const

int32

 

ConvertExternToLocalUniverseID

(
    int32 ExternUniverseID
)

Converts an extern Universe ID to a local Universe ID

Public function Const

int32

 

ConvertLocalToExternUniverseID

(
    int32 LocalUniverseID
)

Converts a local Universe ID to an extern Universe ID

Public function Const

EDMXCommunic...

 

GetCommunicationType()

Public function Const

const FStrin...

 

GetDeviceAddress()

Public function Const

int32

 

GetExternUniverseEnd()

Public function Const

int32

 

GetExternUniverseOffset()

Returns the offset of the extern universe. LocalUniverse == ExternUniverse - ExternUniverseOffset

Public function Const

int32

 

GetExternUniverseStart()

Public function Const

int32

 

GetLocalUniverseEnd()

Public function Const

int32

 

GetLocalUniverseStart()

Public function Const

const FGuid ...

 

GetPortGuid()

Returns the Guid of the Port

Public function Const

const FStrin...

 

GetPortName()

Public function Const

const IDMXPr...

 

GetProtocol()

Public function Const

bool

 

IsExternUniverseInPortRange

(
    int32 Universe
)

Returns true if the Extern Universe is in this Port's Universe range

Public function Const

bool

 

IsLocalUniverseInPortRange

(
    int32 Universe
)

Returns true if the Intern Universe is in this Port's Universe range

Public function Const

bool

 

IsRegistered()

~Begin DMXPort Interface declaration

Protected function Const

bool

 

IsValidPortSlow()

Tests whether the port is valid

Protected function

bool

 

Register()

Registers the port with its protocol. Returns true if successfully registered

Protected function

void

 

RemoveRawListener

(
    TSharedRef< FDMXRawListener > InRaw...
)

Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener.

Protected function

void

 

Unregister()

Unregisteres the port if it was registered with its protocol