RouteGetIds (Eclipse MOSAIC Parent 24.1 API)

java.lang.Object
- org.eclipse.mosaic.fed.sumo.bridge.traci.AbstractTraciCommand<List<String>>
- - org.eclipse.mosaic.fed.sumo.bridge.traci.RouteGetIds

All Implemented Interfaces:: RouteGetIds

public class RouteGetIds
extends AbstractTraciCommand<List<String>>
implements RouteGetIds

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.mosaic.fed.sumo.bridge.traci.AbstractTraciCommand
  AbstractTraciCommand.TraciCommandResultReaderBuilder, AbstractTraciCommand.TraciCommandWriterBuilder

Constructor Summary

Constructors
Constructor Description

RouteGetIds()
Constructs a RouteGetIds traci command, which will return a list of ids of all loaded routes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected List<String>`	`constructResult(Status status, Object... objects)`	This method is called during reading the command response when all readers have been executed.
`List<String>`	`execute(Bridge bridge)`

Methods inherited from class org.eclipse.mosaic.fed.sumo.bridge.traci.AbstractTraciCommand
execute, executeAndReturn, executeAndReturnList, read, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RouteGetIds
```
public RouteGetIds()
```
    Constructs a RouteGetIds traci command, which will return a list of ids of all loaded routes. Access needs to be public, because command is called using Reflection.
    
    See Also:
    
    Route Value Retrieval
- Method Detail
  - execute
```
public List<String> execute(Bridge bridge)
                     throws CommandException,
                            InternalFederateException
```
    Specified by:
    
    execute in interface RouteGetIds
    
    Throws:
    
    CommandException
    
    InternalFederateException
  - constructResult
```
protected List<String> constructResult(Status status,
                                       Object... objects)
```
    Description copied from class: AbstractTraciCommand
    
    This method is called during reading the command response when all readers have been executed. The results of the readers are passed to this method.
    
    Specified by:
    
    constructResult in class AbstractTraciCommand<List<String>>
    
    Parameters:
    
    status - the status of the response
    
    objects - the objects created by the configured readers
    
    Returns:
    
    the final result constructed from the passed objects