Navigation
API > API/Plugins > API/Plugins/DMXProtocol > API/Plugins/DMXProtocol/IO
Inheritance Hierarchy
- TSharedFromThis
- FDMXPort
- FDMXInputPort
- FDMXOutputPort
References
| Module | DMXProtocol |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXPort.h |
| Include | #include "IO/DMXPort.h" |
Syntax
class FDMXPort : public TSharedFromThis< FDMXPort, ESPMode::ThreadSafe >
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
| Type | Name | Description | |
|---|---|---|---|
 |
FString | AutoCompleteDeviceAddress | The auto-complete Device Address, supports wildcards |
 |
bool | bAutoCompleteDeviceAddressEnabled | If true, instead of using the Device Address, the port will auto-complete the IP from the available Network Interface Card Addresses |
 |
EDMXCommunicationType | CommunicationType | The communication type of this port |
 |
FString | DeviceAddress | The address of the device that handles communication, e.g. the network interface for art-net |
 |
int32 | ExternUniverseStart | The start address this being transposed to. |
 |
int32 | LocalUniverseStart | The Local Start Universe |
 |
int32 | NumUniverses | Number of Universes |
 |
FSimpleMulticastDelegate | OnPortUpdated | Broadcast when the port is updated |
 |
FString | PortName | Variables that need be initialized from derived classes. |
 |
IDMXProtocolPtr | Protocol | The protocol of this port |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FDMXPort () |
Protected default constructor, child classes need to take care of member initialization |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
~FDMXPort () |
~End DMXPort Interface declaration |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddRawListener
(
TSharedRef< FDMXRawListener > InRawListener |
Adds a Raw Listener that receives all raw signals received on this port. |
  |
int32 | ConvertExternToLocalUniverseID
(
int32 ExternUniverseID |
Converts an extern Universe ID to a local Universe ID |
  |
int32 | ConvertLocalToExternUniverseID
(
int32 LocalUniverseID |
Converts a local Universe ID to an extern Universe ID |
  |
const FString & | ||
  |
EDMXCommunicationType | ||
  |
const FString & | ||
  |
int32 | ||
  |
int32 | Returns the offset of the extern universe. LocalUniverse == ExternUniverse - ExternUniverseOffset | |
  |
int32 | ||
  |
int32 | ||
  |
int32 | ||
  |
const FGuid & | GetPortGuid () |
Returns the Guid of the Port |
  |
const FString & | GetPortName () |
|
  |
const IDMXProtocolPtr & | GetProtocol () |
|
  |
bool | ||
  |
bool | IsExternUniverseInPortRange
(
int32 Universe |
Returns true if the Extern Universe is in this Port's Universe range |
  |
bool | IsLocalUniverseInPortRange
(
int32 Universe |
Returns true if the Intern Universe is in this Port's Universe range |
  |
bool | IsRegistered () |
~Begin DMXPort Interface declaration |
  |
bool | Tests whether the port is valid | |
 |
bool | Register () |
Registers the port with its protocol. Returns true if successfully registered |
 |
void | RemoveRawListener
(
TSharedRef< FDMXRawListener > InRawListener |
Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener. |
 |
void | Unregister () |
Unregisteres the port if it was registered with its protocol |