FOSCAddress

Windows
MacOS
Linux

References

Module

OSC

Header

/Engine/Plugins/Runtime/OSC/Source/OSC/Public/OSCAddress.h

Include

#include "OSCAddress.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FOSCAddress

Constructors

Name Description

Public function

FOSCAddress()

Public function

FOSCAddress

(
    const FString& InValue
)

Functions

Name Description

Public function

void

 

ClearContainers()

Clears ordered array of containers

Public function Const

FString

 

GetContainer

(
    int32 Index
)

Returns container at provided Index. If Index is out-of-bounds, returns empty string.

Public function Const

FString

 

GetContainerPath()

Returns container path of OSC address in the form '/Container1/Container2'

Public function Const

void

 

GetContainers

(
    TArray< FString >& OutContainers
)

Builds referenced array of address of containers in order

Public function Const

FString

 

GetFullPath()

Returns full path of OSC address in the form '/Container1/Container2/Method'

Public function Const

const FStrin...

 

GetMethod()

Get method name of address

Public function Const

bool

 

IsValidPath()

Returns whether address is valid path

Public function Const

bool

 

IsValidPattern()

Returns whether address is valid pattern

Public function Const

bool

 

Matches

(
    const FOSCAddress& InAddress
)

Returns if this address is a pattern that matches InAddress' path.

Public function

FString

 

PopContainer()

Pops container from ordered array of containers

Public function

TArray< FStr...

 

PopContainers

(
    int32 InNumContainers
)

Pops containers off end of address' ordered array of containers

Public function

void

 

PushContainer

(
    const FString& InContainer
)

Pushes container onto end of address' ordered array of containers

Public function

void

 

PushContainers

(
    const TArray< FString >& InContain...
)

Pushes containers onto end of address' ordered array of containers

Public function

void

 

RemoveContainers

(
    int32 InIndex,
    int32 InCount
)

Removes containers from container array at index until count

Public function

void

 

SetMethod

(
    const FString& InMethod
)

Sets the method name of address

Operators

Name Description

Public function Const

FOSCAddress

 

operator/

(
    const FOSCAddress& InAddress
)

Public function

FOSCAddress ...

 

operator/=

(
    const FOSCAddress& InAddress
)

Public function Const

bool

 

operator==

(
    const FOSCAddress& InAddress
)

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