RouteIterator
in package
Cyclically iterate over actions on a trade route
Table of Contents
Properties
- $route : MultiplePortRoute
- $routeIterator : InfiniteIterator
- $transaction : TransactionType
Methods
- __construct() : mixed
- getCurrentRoute() : OneWayRoute
- getCurrentSectorID() : int
- getCurrentTransaction() : TransactionType
- getEntireRoute() : MultiplePortRoute
- next() : void
- Advance to the next action on the route
Properties
$route
private
MultiplePortRoute
$route
$routeIterator
private
InfiniteIterator
$routeIterator
$transaction
private
TransactionType
$transaction
= \Smr\TransactionType::Buy
Methods
__construct()
public
__construct(MultiplePortRoute $route) : mixed
Parameters
- $route : MultiplePortRoute
getCurrentRoute()
public
getCurrentRoute() : OneWayRoute
Return values
OneWayRoutegetCurrentSectorID()
public
getCurrentSectorID() : int
Return values
intgetCurrentTransaction()
public
getCurrentTransaction() : TransactionType
Return values
TransactionTypegetEntireRoute()
public
getEntireRoute() : MultiplePortRoute
Return values
MultiplePortRoutenext()
Advance to the next action on the route
public
next() : void