com.inrix.sdk

Class TileManager.TileOptions

java.lang.Object

com.inrix.sdk.TileManager.TileOptions

Enclosing class:

TileManager

public static final class TileManager.TileOptions
extends Object

Contains options that are used in generating the returned tile image.

See Also:

TileManager.getTileUrl(int, int, int)

Constructor Summary

Constructors

Constructor and Description
TileOptions() Initializes a new instance of the TileManager.TileOptions class.
TileOptions(int zoom) Initializes a new instance of the TileManager.TileOptions class.
TileOptions(TileManager.TileOptions in) Initializes a new instance of TileOptions using another instance.

Method Summary

Methods

Modifier and Type	Method and Description
TileManager.TileOptions	setCoverage(int coverage) Sets the coverage for a tile.
TileManager.TileOptions	setFormat(int format) Sets the format of the tile.
TileManager.TileOptions	setFrcLevel(int frcLevel) Sets the Federal Road Classification code level(s) for a tile.
TileManager.TileOptions	setHeight(int height) Sets the height of the tile.
TileManager.TileOptions	setLayers(int value) Sets the layers for the map tile.
TileManager.TileOptions	setOpacity(int opacity) Sets the opacity for the tile.
TileManager.TileOptions	setPenWidth(int penWidth) Sets a pen width for the tile.
TileManager.TileOptions	setSpeedBucketId(int speedBucketId) Sets a speed bucket ID for a tile.
TileManager.TileOptions	setStartTime(long startTimeMs) Sets a start time for a tile.
TileManager.TileOptions	setWidth(int width) Sets the width of the tile.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TileOptions

public TileOptions()

Initializes a new instance of the TileManager.TileOptions class.

TileOptions

public TileOptions(int zoom)

Initializes a new instance of the TileManager.TileOptions class.

Parameters:

zoom - Target zoom level. Some options (pen width, FRC level) will be set automatically based on the specified zoom level. If specified zoom not within allowed zoom level range, options will be set to default value (same as calling TileOptions .ctor without parameters).

TileOptions

public TileOptions(TileManager.TileOptions in)

Initializes a new instance of TileOptions using another instance.

Parameters:

in - An instance to initialize TileManager.TileOptions from.

Method Detail

setLayers

public TileManager.TileOptions setLayers(int value)

Sets the layers for the map tile. Can be a combination of the following values:

• TileManager.TILE_LAYER_TRAFFIC
• TileManager.TILE_LAYER_MAP
• TileManager.TILE_LAYER_WEATHER

Parameters:

value - Layers to include. Default is TileManager.TILE_LAYER_TRAFFIC.

Returns:

Current instance.

setWidth

public TileManager.TileOptions setWidth(int width)

Sets the width of the tile. The value is TileManager.TILE_DEFAULT_WIDTH.

Parameters:

width - The traffic tile width in pixels.

Returns:

This instance of the TileManager.TileOptions class.

setHeight

public TileManager.TileOptions setHeight(int height)

Sets the height of the tile. The default value is TileManager.TILE_DEFAULT_HEIGHT.

Parameters:

height - The traffic tile height in pixels.

Returns:

This instance of the TileManager.TileOptions class.

setOpacity

public TileManager.TileOptions setOpacity(int opacity)

Sets the opacity for the tile. The default value is TileManager.TILE_DEFAULT_OPACITY.

Parameters:

opacity - The traffic tile opacity. Valid values are between 0 and 100.

Returns:

This instance of the TileManager.TileOptions class.

setPenWidth

public TileManager.TileOptions setPenWidth(int penWidth)

Sets a pen width for the tile. The default value is TileManager.TILE_DEFAULT_PEN_WIDTH.

Parameters:

penWidth - The pen width of the traffic overlay, in pixels.

Returns:

This instance of the TileManager.TileOptions class.

setFormat

public TileManager.TileOptions setFormat(int format)

Sets the format of the tile. The default value is TileManager.TILE_FORMAT_GIF.

Parameters:

format - The format of the traffic tile to be returned. Supported values are TileManager.TILE_FORMAT_PNG and TileManager.TILE_FORMAT_GIF.

Returns:

This instance of the TileManager.TileOptions class.

setFrcLevel

public TileManager.TileOptions setFrcLevel(int frcLevel)

Sets the Federal Road Classification code level(s) for a tile. The default value is TileManager.TILE_FRC_LEVEL_ALL.

Parameters:

frcLevel - The Federal Road Classification code of the TMCs to return. Can be one or a combination of the following values:

• TileManager.TILE_FRC_LEVEL_ALL
• TileManager.TILE_FRC_LEVEL_1
• TileManager.TILE_FRC_LEVEL_2
• TileManager.TILE_FRC_LEVEL_3
• TileManager.TILE_FRC_LEVEL_4
• TileManager.TILE_FRC_LEVEL_5
• TileManager.TILE_FRC_LEVEL_6
• TileManager.TILE_FRC_LEVEL_7

Returns:

This instance of the TileManager.TileOptions class.

setCoverage

public TileManager.TileOptions setCoverage(int coverage)

Sets the coverage for a tile.

Parameters:

coverage - The type of coverage to return: core or extended. The default is specified per vendor.

• TileManager.TILE_COVERAGE_ALL
• TileManager.TILE_COVERAGE_HISTORICAL
• TileManager.TILE_COVERAGE_REALTIME_CORE
• TileManager.TILE_COVERAGE_REALTIME_CORE_EXTENDED
• TileManager.TILE_COVERAGE_REALTIME_EXTENDED
• TileManager.TILE_COVERAGE_REFERENCE

Returns:

This instance of the TileManager.TileOptions class.

setSpeedBucketId

public TileManager.TileOptions setSpeedBucketId(int speedBucketId)

Sets a speed bucket ID for a tile. A speed bucket is a range of speeds or percentages that is used to categorize TMC data.

Parameters:

speedBucketId - The ID of the speed bucket.

Returns:

This instance of the TileManager.TileOptions class.

setStartTime

public TileManager.TileOptions setStartTime(long startTimeMs)

Sets a start time for a tile. This parameter is an optional date/time field in UTC, used to show predicted traffic, i.e. X number of minutes into the future from now. 2013-08-06T16:04:00Z

Parameters:

startTimeMs - The start time of the tile in milliseconds.

Returns:

This instance of the TileManager.TileOptions class.

toString

public String toString()

Overrides:

toString in class Object