Navigation
API > API/Plugins > API/Plugins/DMXProtocol
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.
| Name | FDMXPort |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXPort.h |
| Include Path | #include "IO/DMXPort.h" |
Syntax
class FDMXPort : public TSharedFromThis< FDMXPort, ESPMode::ThreadSafe >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXPort
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXPort() |
Protected default constructor, child classes need to take care of member initialization | IO/DMXPort.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDMXPort() |
~End DMXPort Interface declaration | IO/DMXPort.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnPortUpdated | FSimpleMulticastDelegate | Broadcast when the port is updated | IO/DMXPort.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FDMXRawListener | friend | Friend Inputs so they can add and remove themselves to the port. | IO/DMXPort.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 ConvertExternToLocalUniverseID
(
int32 ExternUniverseID |
Converts an extern Universe ID to a local Universe ID | IO/DMXPort.h | |
int32 ConvertLocalToExternUniverseID
(
int32 LocalUniverseID |
Converts a local Universe ID to an extern Universe ID | IO/DMXPort.h | |
const FString & GetAutoCompleteDeviceAddress() |
IO/DMXPort.h | ||
EDMXCommunicationType GetCommunicationType() |
IO/DMXPort.h | ||
const FString & GetDeviceAddress() |
IO/DMXPort.h | ||
int32 GetExternUniverseEnd() |
IO/DMXPort.h | ||
int32 GetExternUniverseOffset() |
Returns the offset of the extern universe. LocalUniverse == ExternUniverse - ExternUniverseOffset | IO/DMXPort.h | |
int32 GetExternUniverseStart() |
IO/DMXPort.h | ||
int32 GetLocalUniverseEnd() |
IO/DMXPort.h | ||
int32 GetLocalUniverseStart() |
IO/DMXPort.h | ||
const FGuid & GetPortGuid() |
Returns the Guid of the Port | IO/DMXPort.h | |
const FString & GetPortName() |
IO/DMXPort.h | ||
const IDMXProtocolPtr & GetProtocol() |
IO/DMXPort.h | ||
bool IsAutoCompleteDeviceAddressEnabled() |
IO/DMXPort.h | ||
bool IsExternUniverseInPortRange
(
int32 Universe |
Returns true if the Extern Universe is in this Port's Universe range | IO/DMXPort.h | |
bool IsLocalUniverseInPortRange
(
int32 Universe |
Returns true if the Intern Universe is in this Port's Universe range | IO/DMXPort.h | |
bool IsRegistered () |
~Begin DMXPort Interface declaration | IO/DMXPort.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddRawListener
(
TSharedRef< FDMXRawListener > InRawListener |
Adds a Raw Listener that receives all raw signals received on this port. | IO/DMXPort.h | |
bool IsValidPortSlow() |
Tests whether the port is valid | IO/DMXPort.h | |
bool Register() |
Registers the port with its protocol. Returns true if successfully registered | IO/DMXPort.h | |
void RemoveRawListener
(
TSharedRef< FDMXRawListener > InRawListener |
Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener. | IO/DMXPort.h | |
void Unregister() |
Unregisteres the port if it was registered with its protocol | IO/DMXPort.h |