juce::OSCBundle Class Reference

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

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.

@tags{OSC}

Definition at line 43 of file juce_OSCBundle.h.

Constructor & Destructor Documentation

OSCBundle() [1/2]

juce::OSCBundle::OSCBundle

(

)

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

Definition at line 29 of file juce_OSCBundle.cpp.

OSCBundle() [2/2]

juce::OSCBundle::OSCBundle

(

OSCTimeTag

timeTag

)

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

Definition at line 33 of file juce_OSCBundle.cpp.

Member Function Documentation

addElement()

void juce::OSCBundle::addElement

(

const OSCBundle::Element &

element

)

Adds an OSCBundleElement to the OSCBundle's content.

s

Definition at line 126 of file juce_OSCBundle.h.

begin() [1/2]

const OSCBundle::Element * juce::OSCBundle::begin ( ) const

noexcept

Returns a pointer to the first element of the OSCBundle.

Definition at line 132 of file juce_OSCBundle.h.

begin() [2/2]

OSCBundle::Element * juce::OSCBundle::begin ( )

noexcept

Returns a pointer to the first element of the OSCBundle.

Definition at line 129 of file juce_OSCBundle.h.

end() [1/2]

const OSCBundle::Element * juce::OSCBundle::end ( ) const

noexcept

Returns a pointer past the last element of the OSCBundle.

Definition at line 138 of file juce_OSCBundle.h.

end() [2/2]

OSCBundle::Element * juce::OSCBundle::end ( )

noexcept

Returns a pointer past the last element of the OSCBundle.

Definition at line 135 of file juce_OSCBundle.h.

getTimeTag()

OSCTimeTag juce::OSCBundle::getTimeTag ( ) const

noexcept

Returns the OSCBundle's OSC time tag.

Definition at line 58 of file juce_OSCBundle.h.

isEmpty()

bool juce::OSCBundle::isEmpty ( ) const

noexcept

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

Definition at line 109 of file juce_OSCBundle.h.

operator[]() [1/2]

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

noexcept

Definition at line 120 of file juce_OSCBundle.h.

operator[]() [2/2]

OSCBundle::Element & juce::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().

Definition at line 115 of file juce_OSCBundle.h.

setTimeTag()

void juce::OSCBundle::setTimeTag ( OSCTimeTag  newTimeTag )

noexcept

Sets the OSCBundle's OSC time tag.

Definition at line 55 of file juce_OSCBundle.h.

size()

int juce::OSCBundle::size ( ) const

noexcept

Returns the number of elements contained in the bundle.

Definition at line 106 of file juce_OSCBundle.h.

---

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

• juce_osc/osc/juce_OSCBundle.h
• juce_osc/osc/juce_OSCBundle.cpp