RouterService (openTCS 5.0.0 Base API documentation)

public interface RouterService

Provides methods concerning the Router.

Method Summary

Modifier and Type	Method	Description
`void`	`updatePathLock(TCSObjectReference<Path> ref, boolean locked)`	Updates a path's lock state.
`void`	`updateRoutingTopology()`	Notifies the router that the topology has changed in a significant way and needs to be re-evaluated.

Method Details
- updatePathLock
  
  void updatePathLock(TCSObjectReference<Path> ref, boolean locked) throws ObjectUnknownException, KernelRuntimeException
  
  Updates a path's lock state.
  
  Parameters:
  
  ref - A reference to the path to be updated.
  
  locked - Indicates whether the path is to be locked (true) or unlocked (false).
  
  Throws:
  
  ObjectUnknownException - If the referenced path does not exist.
  
  KernelRuntimeException - In case there is an exception executing this method.
- updateRoutingTopology
  
  void updateRoutingTopology() throws KernelRuntimeException
  
  Notifies the router that the topology has changed in a significant way and needs to be re-evaluated.
  
  Throws:
  
  KernelRuntimeException - In case there is an exception executing this method.