JUCE: OSCBundle Class Reference

JUCE

Classes | Public Member Functions | List of all members
OSCBundle Class Reference
juce_osc » osc

An OSC bundle. More...

`#include <juce_OSCBundle.h>`

## Classes
class | Element
| An OSC bundle element. More...

## Public Member Functions
| OSCBundle ()
| Constructs an OSCBundle with no content and a default time tag ("immediately"). More...
| OSCBundle (OSCTimeTag timeTag)
| Constructs an OSCBundle with no content and a given time tag. More...
void | setTimeTag (OSCTimeTag newTimeTag) noexcept
| Sets the OSCBundle's OSC time tag. More...
OSCTimeTag | getTimeTag () const noexcept
| Returns the OSCBundle's OSC time tag. More...
int | size () const noexcept
| Returns the number of elements contained in the bundle. More...
bool | isEmpty () const noexcept
| Returns true if the bundle contains no elements; false otherwise. More...
OSCBundle::Element & | operator[] (const int i) noexcept
| Returns a reference to the OSCBundle element at index i in this bundle. More...
const OSCBundle::Element & | operator[] (const int i) const noexcept
void | addElement (const OSCBundle::Element &element)
| Adds an OSCBundleElement to the OSCBundle's content. More...
OSCBundle::Element * | begin () noexcept
| Returns a pointer to the first element of the OSCBundle. More...
const OSCBundle::Element * | begin () const noexcept
| Returns a pointer to the first element of the OSCBundle. More...
OSCBundle::Element * | end () noexcept
| Returns a pointer past the last element of the OSCBundle. More...
const OSCBundle::Element * | end () const noexcept
| Returns a pointer past the last element of the OSCBundle. More...

## Detailed Description

An OSC bundle.

An OSCBundle contains an OSCTimeTag and zero or more OSCBundle Elements. The elements of a bundle can be OSC messages or other OSC bundles (this means that OSC bundles can be nested).

This is an advanced OSC structure useful to bundle OSC messages together whose effects must occur simultaneously at some given time. For most use cases it is probably enough to send and receive plain OSC messages.

## Constructor & Destructor Documentation

## ◆ OSCBundle() [1/2]

OSCBundle::OSCBundle | ( |  | ) |

Constructs an OSCBundle with no content and a default time tag ("immediately").

## ◆ OSCBundle() [2/2]

OSCBundle::OSCBundle | ( | OSCTimeTag | timeTag | ) |

Constructs an OSCBundle with no content and a given time tag.

## Member Function Documentation

## ◆ setTimeTag()

void OSCBundle::setTimeTag | ( | OSCTimeTag | newTimeTag | ) |
| noexcept

Sets the OSCBundle's OSC time tag.

## ◆ getTimeTag()

OSCTimeTag OSCBundle::getTimeTag | ( |  | ) | const
| noexcept

Returns the OSCBundle's OSC time tag.

## ◆ size()

int OSCBundle::size | ( |  | ) | const
| noexcept

Returns the number of elements contained in the bundle.

## ◆ isEmpty()

bool OSCBundle::isEmpty | ( |  | ) | const
| noexcept

Returns true if the bundle contains no elements; false otherwise.

## ◆ operator[]() [1/2]

OSCBundle::Element & OSCBundle::operator[] | ( | const int | i | ) |
| noexcept

Returns a reference to the OSCBundle element at index i in this bundle.

This method does not check the range and results in undefined behaviour in case i < 0 or i >= size().

## ◆ operator[]() [2/2]

const OSCBundle::Element & OSCBundle::operator[] | ( | const int | i | ) | const
| noexcept

## ◆ addElement()

void OSCBundle::addElement | ( | const OSCBundle::Element & | element | ) |

Adds an OSCBundleElement to the OSCBundle's content.

s

## ◆ begin() [1/2]

OSCBundle::Element * OSCBundle::begin | ( |  | ) |
| noexcept

Returns a pointer to the first element of the OSCBundle.

## ◆ begin() [2/2]

const OSCBundle::Element * OSCBundle::begin | ( |  | ) | const
| noexcept

Returns a pointer to the first element of the OSCBundle.

## ◆ end() [1/2]

OSCBundle::Element * OSCBundle::end | ( |  | ) |
| noexcept

Returns a pointer past the last element of the OSCBundle.

## ◆ end() [2/2]

const OSCBundle::Element * OSCBundle::end | ( |  | ) | const
| noexcept

Returns a pointer past the last element of the OSCBundle.

The documentation for this class was generated from the following file:

- juce_OSCBundle.h