com.azalient.api.b.network
Interface ISign

All Superinterfaces:

IDescribed, IRecord, IUserData, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ISign
extends IDescribed, IUserData, StoreRecordRW

This object represents a variable message sign. It can be used to display messages for drivers, for example, the number of spaces remaining in a parking area.

Field Summary

static String	BLANK The default message on a sign
static ISign[]	ZERO A static zero-length array, created for convenience, and to save memory

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

String	auxiliaryMessage(Alignment2D a) An auxiliary message displayed on the sign, in a position relative to the main message as specified by the alignment.
void	auxiliaryMessage(String format, Alignment2D a) Set the auxiliary message displayed on the sign.
NamedColour	colour() Returns the colour of the outer part of the sign
void	colour(NamedColour colour) Sets the colour of the outer part of the sign
void	draw(IDrawing drw, int rgb) Draw this sign in the given colour
IShape	image() Returns a reference to any image shape attached to this sign.
void	image(String imageName, Alignment2D a) Attach an image to this sign, by passing in the name of an image already loaded into the shapes library.
String	label() Returns a non-unique descriptive name for the sign
void	label(String s) Sets a non-unique descriptive name for the sign
ILane	lane() The lane on which this sign is located
ILaneLocation	location() The lane-distance location of this sign
String	message() A (variable) message displayed on the sign
void	message(String format) Set the (variable) message displayed on the sign

Methods inherited from interface com.azalient.api.a.tables.IDescribed

description

Methods inherited from interface com.azalient.api.a.IUserData

userData, userData, userDataHashCode

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Field Detail

ZERO

static final ISign[] ZERO

A static zero-length array, created for convenience, and to save memory

BLANK

static final String BLANK

The default message on a sign

See Also:

Constant Field Values

Method Detail

lane

ILane lane()

The lane on which this sign is located

location

ILaneLocation location()

The lane-distance location of this sign

label

String label()

Returns a non-unique descriptive name for the sign

label

void label(String s)

Sets a non-unique descriptive name for the sign

message

String message()

A (variable) message displayed on the sign

auxiliaryMessage

String auxiliaryMessage(Alignment2D a)

An auxiliary message displayed on the sign, in a position relative to the main message as specified by the alignment. This can be used to display extra characters without affecting the outcome of functionality that uses the main message. For example, a route choice rule may use the sign message, and may expect it to be a number but you may also want the sign to display some explanatory text, like "Delay:" or "Spaces:"

message

void message(String format)

Set the (variable) message displayed on the sign

auxiliaryMessage

void auxiliaryMessage(String format,
                      Alignment2D a)

Set the auxiliary message displayed on the sign. See auxiliaryMessage(Alignment2D)

colour

NamedColour colour()

Returns the colour of the outer part of the sign

colour

void colour(NamedColour colour)

Sets the colour of the outer part of the sign

image

IShape image()

Returns a reference to any image shape attached to this sign.

image

void image(String imageName,
           Alignment2D a)

Attach an image to this sign, by passing in the name of an image already loaded into the shapes library. This allows you to display an icon on a sign

draw

void draw(IDrawing drw,
          int rgb)

Draw this sign in the given colour

Internal - Not recommended for use. Public as a side-effect of implementation method