RoutesCollection

class RoutesCollection(address: Long, isRef: Boolean) : GemNativeObj

Represents a collection of routes.

Constructors

Link copied to clipboard
constructor(address: Long, isRef: Boolean)

Properties

Link copied to clipboard

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard

Main route in the collection

Link copied to clipboard
val size: Int

Number of routes in this collection.

Functions

Link copied to clipboard
external fun add(route: Route, mainRoute: Boolean)

Adds a route in the collection.

Link copied to clipboard
external fun clear()

Removes all routes

Link copied to clipboard
external fun contains(route: Route): Boolean

Check if a route object is in collection

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getRoute(index: Int): Route?

Get route specified by index.

Link copied to clipboard
external fun indexOf(route: Route): Int

Get index of the specified route - return < 0 for error

Link copied to clipboard
external fun isMainRoute(route: Route): Boolean

Returns if the route is the main route in the collection

Link copied to clipboard

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
external fun remove(route: Route)

Removes the route specified by index.