com.azalient.api.b.display
Interface ITag

All Superinterfaces:

IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ITag
extends StoreRecordRW

Tags are used to identify and follow agents with a chosen set of parameters - behaviour, origin, destination etc. A tag defines one or more fields, and if an agent matches all of those fields, then the tag will be drawn on that agent.

Field Summary

static ITag[]

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	annotation() Returns any text message annotation string that will be displayed adjacent to every tagged agent
NamedColour	colour() Returns the colour of the tag
boolean	enabled() Returns true if this tag is enabled.
IPlaces	from() A set of origin places to match.
IMob	mob() A behaviour to match.
IPlaces	to() A set of destination places to match.
ITypeSet	typeSet() A set of types - either vehicle types or person types.

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 ITag[] ZERO

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

Method Detail

colour

NamedColour colour()

Returns the colour of the tag

from

IPlaces from()

A set of origin places to match. If the origin of an agent is in this set of places then it will match this field. If this field is null then all agents will match.

to

IPlaces to()

A set of destination places to match. If the destination of an agent is in this set of places then it will match this field. If this field is null then all agents will match.

mob

IMob mob()

A behaviour to match. If this is non-null then then the behaviour of the agent must be in this mob for the agent to match.

typeSet

ITypeSet typeSet()

A set of types - either vehicle types or person types. If this is non-null then it must include the type of the agent for a match.

enabled

boolean enabled()

Returns true if this tag is enabled. This allows tags to be created and then temporarily disabled.

annotation

String annotation()

Returns any text message annotation string that will be displayed adjacent to every tagged agent