public interface Signal extends OsidRule
A Signal
represents a traffic signal in a Map.
The genus type indicates the type of signal. A signal has one or
more States
that are used to instruct traffic.
Modifier and Type | Method and Description |
---|---|
Coordinate |
getCoordinate()
Gets the coordinate of the signal on the path.
|
Path |
getPath()
Gets the path.
|
Id |
getPathId()
Gets the path
Id. |
SignalRecord |
getSignalRecord(Type signalRecordType)
Gets the signal record corresponding to the given
Signal
record Type. |
IdList |
getStateIds()
Gets the valid state
Ids of this signal. |
StateList |
getStates()
Gets the states of this signal.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getPathId()
Id.
Id
of the pathmandatory
- This method must be implemented. Path getPath() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Coordinate getCoordinate()
mandatory
- This method must be implemented. IdList getStateIds()
Ids
of this signal. Ids
of the statesmandatory
- This method must be implemented. StateList getStates() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. SignalRecord getSignalRecord(Type signalRecordType) throws OperationFailedException
Signal
record Type.
This method is used to retrieve an
object implementing the requested record. The signalRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(signalRecordType)
is true
.signalRecordType
- the type of signal record to retrieveNullArgumentException
- signalRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalRecordType)
is false
mandatory
- This method must be implemented.