class LaunchOptions

Class for specifying the specifics about how a kernel will be launched. This class can specify a potential range of cells on which to run a kernel. If no set is called for a dimension then this class will have no impact on that dimension when the kernel is executed. The forEach kernel launch will operate over the intersection of the dimensions. Example: LaunchOptions with setX(5, 15) Allocation with dimension X=10, Y=10 The resulting forEach run would execute over: x = 5 to 9 (inclusive) and y = 0 to 9 (inclusive).

Summary

Public constructors
Public methods
Int

getXEnd()

Returns the current X end
Int

getXStart()

Returns the current X start
Int

getYEnd()

Returns the current Y end
Int

getYStart()

Returns the current Y start
Int

getZEnd()

Returns the current Z end
Int

getZStart()

Returns the current Z start
Script.LaunchOptions!

setX(xstartArg: Int, xendArg: Int)

Set the X range.
Script.LaunchOptions!

setY(ystartArg: Int, yendArg: Int)

Set the Y range.
Script.LaunchOptions!

setZ(zstartArg: Int, zendArg: Int)

Set the Z range.

Public constructors

LaunchOptions

LaunchOptions()

Public methods

getXEnd

fun getXEnd(): Int

Deprecated: Deprecated in Java.

Returns the current X end

Return
Int int current value

getXStart

fun getXStart(): Int

Deprecated: Deprecated in Java.

Returns the current X start

Return
Int int current value

getYEnd

fun getYEnd(): Int

Deprecated: Deprecated in Java.

Returns the current Y end

Return
Int int current value

getYStart

fun getYStart(): Int

Deprecated: Deprecated in Java.

Returns the current Y start

Return
Int int current value

getZEnd

fun getZEnd(): Int

Deprecated: Deprecated in Java.

Returns the current Z end

Return
Int int current value

getZStart

fun getZStart(): Int

Deprecated: Deprecated in Java.

Returns the current Z start

Return
Int int current value

setX

fun setX(
    xstartArg: Int, 
    xendArg: Int
): Script.LaunchOptions!

Deprecated: Deprecated in Java.

Set the X range. xstartArg is the lowest coordinate of the range, and xendArg-1 is the highest coordinate of the range.

Parameters
xstartArg Int: Must be >= 0
xendArg Int: Must be > xstartArg
Return
Script.LaunchOptions! LaunchOptions

setY

fun setY(
    ystartArg: Int, 
    yendArg: Int
): Script.LaunchOptions!

Deprecated: Deprecated in Java.

Set the Y range. ystartArg is the lowest coordinate of the range, and yendArg-1 is the highest coordinate of the range.

Parameters
ystartArg Int: Must be >= 0
yendArg Int: Must be > ystartArg
Return
Script.LaunchOptions! LaunchOptions

setZ

fun setZ(
    zstartArg: Int, 
    zendArg: Int
): Script.LaunchOptions!

Deprecated: Deprecated in Java.

Set the Z range. zstartArg is the lowest coordinate of the range, and zendArg-1 is the highest coordinate of the range.

Parameters
zstartArg Int: Must be >= 0
zendArg Int: Must be > zstartArg
Return
Script.LaunchOptions! LaunchOptions

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-02-10 UTC.