ControlBus

final case class ControlBus(server: Server, index: Int, numChannels: Int) extends Bus
trait Serializable
trait Product
trait Equals
trait Bus
class Object
trait Matchable
class Any

Value members

Concrete methods

def fillMsg(value: Float): ControlBusFill

A convenience method that fills all channels of the control bus with one value.

A convenience method that fills all channels of the control bus with one value.

Creates a ControlBusFill message using relative offsets.

Creates a ControlBusFill message using relative offsets.

Value Params
data

tuples of offsets, number of consecutive channels and fill values. The offsets are relative to the index of this bus. All offsets must be >= 0 and less than the number of channels, otherwise an exception is thrown

Returns

the ControlBusFill message with absolute indices

def free(): Unit

A convenience method that gets the control bus value. It requires that the bus has exactly one channel, otherwise an exception is thrown.

A convenience method that gets the control bus value. It requires that the bus has exactly one channel, otherwise an exception is thrown.

def getMsg(offsets: Int*): ControlBusGet

Creates a ControlBusGet message using relative offsets.

Creates a ControlBusGet message using relative offsets.

Value Params
offsets

the offsets are relative to the index of this bus. All offsets must be >= 0 and less than the number of channels, otherwise an exception is thrown

Returns

the ControlBusGet message with absolute indices

A convenience method that queries all channels of the control bus.

A convenience method that queries all channels of the control bus.

def getnMsg(ranges: Range*): ControlBusGetn

Creates a ControlBusGetn message using relative offsets.

Creates a ControlBusGetn message using relative offsets.

Value Params
ranges

ranges of offsets and number of consecutive channels to read. The offsets are relative to the index of this bus. All offsets must be >= 0 and less than the number of channels, otherwise an exception is thrown

Returns

the ControlBusGetn message with absolute indices

def rate: Rate

Control buses always run at control rate.

Control buses always run at control rate.

def setMsg(value: Float): ControlBusSet

A convenience method that sets the control bus to one value. It requires that the bus has exactly one channel, otherwise an exception is thrown.

A convenience method that sets the control bus to one value. It requires that the bus has exactly one channel, otherwise an exception is thrown.

Value Params
value

the value to set the bus to

Creates a ControlBusSet message using relative offsets.

Creates a ControlBusSet message using relative offsets.

Value Params
pairs

pairs of offsets and values. the offsets are relative to the index of this bus. All offsets must be >= 0 and less than the number of channels, otherwise an exception is thrown

Returns

the ControlBusSet message with absolute indices

def setnMsg(values: IndexedSeq[Float]): ControlBusSetn

A convenience method that creates a ControlBusSetn message for setting the control bus to a sequence of values. It requires that the bus's number of channels is equal to the argument's size, otherwise an exception is thrown.

A convenience method that creates a ControlBusSetn message for setting the control bus to a sequence of values. It requires that the bus's number of channels is equal to the argument's size, otherwise an exception is thrown.

Value Params
values

the vector of values to set the bus to

def setnMsg(pairs: (Int, IndexedSeq[Float])*): ControlBusSetn

Creates a ControlBusSetn message using relative offsets.

Creates a ControlBusSetn message using relative offsets.

Value Params
pairs

pairs of offsets and values. the offsets are relative to the index of this bus. All offsets must be >= 0 and less than the number of channels, otherwise an exception is thrown

Returns

the ControlBusSetn message with absolute indices

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product