SolutionCollector (com.google.ortools:ortools-java 9.12.9999 API)

java.lang.Object
- com.google.ortools.constraintsolver.BaseObject
- - com.google.ortools.constraintsolver.SearchMonitor
  - - com.google.ortools.constraintsolver.SolutionCollector

```
public class SolutionCollector
extends SearchMonitor
```
This class is the root class of all solution collectors.
It implements a basic query API to be used independently
of the collector used.

Field Summary
- Fields inherited from class com.google.ortools.constraintsolver.SearchMonitor
  kNoProgress
- Fields inherited from class com.google.ortools.constraintsolver.BaseObject
  swigCMemOwn

Constructor Summary

Constructors
Constructor and Description
`SolutionCollector(long cPtr, boolean cMemoryOwn)`
`SolutionCollector(Solver solver)`
`SolutionCollector(Solver solver, Assignment assignment)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(IntervalVar var)`
`void`	`add(IntervalVar[] vars)`
`void`	`add(IntVar var)` Add API.
`void`	`add(IntVar[] vars)`
`void`	`add(SequenceVar var)`
`void`	`add(SequenceVar[] vars)`
`void`	`addObjective(IntVar objective)`
`void`	`AddObjectives(IntVar[] objectives)`
`int[]`	`backwardSequence(int n, SequenceVar var)` This is a shortcut to get the BackwardSequence of 'var' in the nth solution.
`long`	`branches(int n)` Returns the number of branches when the nth solution was found.
`void`	`delete()`
`long`	`durationValue(int n, IntervalVar var)` This is a shortcut to get the DurationValue of 'var' in the nth solution.
`long`	`endValue(int n, IntervalVar var)` This is a shortcut to get the EndValue of 'var' in the nth solution.
`void`	`enterSearch()` Beginning of the search.
`long`	`failures(int n)` Returns the number of failures encountered at the time of the nth solution.
`protected void`	`finalize()`
`int[]`	`forwardSequence(int n, SequenceVar var)` This is a shortcut to get the ForwardSequence of 'var' in the nth solution.
`static long`	`getCPtr(SolutionCollector obj)`
`boolean`	`has_solution()` Returns whether any solutions were stored during the search.
`void`	`install()` Registers itself on the solver such that it gets notified of the search and propagation events.
`Assignment`	`last_solution_or_null()` Returns the last solution if there are any, nullptr otherwise.
`long`	`objectiveValue(int n)` Returns the objective value of the nth solution.
`long`	`ObjectiveValueFromIndex(int n, int index)` Returns the value of the index-th objective of the nth solution.
`long`	`performedValue(int n, IntervalVar var)` This is a shortcut to get the PerformedValue of 'var' in the nth solution.
`Assignment`	`solution(int n)` Returns the nth solution.
`int`	`solutionCount()` Returns how many solutions were stored during the search.
`long`	`startValue(int n, IntervalVar var)` This is a shortcut to get the StartValue of 'var' in the nth solution.
`static long`	`swigRelease(SolutionCollector obj)`
`java.lang.String`	`toString()`
`int[]`	`unperformed(int n, SequenceVar var)` This is a shortcut to get the list of unperformed of 'var' in the nth solution.
`long`	`value(int n, IntVar var)` This is a shortcut to get the Value of 'var' in the nth solution.
`long`	`wallTime(int n)` Returns the wall time in ms for the nth solution.

Methods inherited from class com.google.ortools.constraintsolver.SearchMonitor
accept, acceptDelta, acceptNeighbor, acceptSolution, AcceptUncheckedNeighbor, afterDecision, applyDecision, atSolution, beginFail, beginInitialPropagation, beginNextDecision, endFail, endInitialPropagation, endNextDecision, exitSearch, getCPtr, IsUncheckedSolutionLimitReached, keepAliveDecisionBuilder, localOptimum, noMoreSolutions, periodicCheck, progressPercent, refuteDecision, restartSearch, solver, swigDirectorDisconnect, swigRelease, swigReleaseOwnership, swigTakeOwnership

Methods inherited from class com.google.ortools.constraintsolver.BaseObject
getCPtr, swigRelease

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

- Constructor Detail
  - SolutionCollector
```
public SolutionCollector(long cPtr,
                         boolean cMemoryOwn)
```
  - SolutionCollector
```
public SolutionCollector(Solver solver,
                         Assignment assignment)
```
  - SolutionCollector
```
public SolutionCollector(Solver solver)
```
- Method Detail
  - getCPtr
```
public static long getCPtr(SolutionCollector obj)
```
  - swigRelease
```
public static long swigRelease(SolutionCollector obj)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class SearchMonitor
  - delete
```
public void delete()
```
    Overrides:
    
    delete in class SearchMonitor
  - install
```
public void install()
```
    Description copied from class: SearchMonitor
    
    Registers itself on the solver such that it gets notified of the search
    and propagation events. Override to incrementally install listeners for
    specific events.
    
    Overrides:
    
    install in class SearchMonitor
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class BaseObject
  - add
```
public void add(IntVar var)
```
    Add API.
  - add
```
public void add(IntVar[] vars)
```
  - add
```
public void add(IntervalVar var)
```
  - add
```
public void add(IntervalVar[] vars)
```
  - add
```
public void add(SequenceVar var)
```
  - add
```
public void add(SequenceVar[] vars)
```
  - addObjective
```
public void addObjective(IntVar objective)
```
  - AddObjectives
```
public void AddObjectives(IntVar[] objectives)
```
  - enterSearch
```
public void enterSearch()
```
    Beginning of the search.
    
    Overrides:
    
    enterSearch in class SearchMonitor
  - solutionCount
```
public int solutionCount()
```
    Returns how many solutions were stored during the search.
  - has_solution
```
public boolean has_solution()
```
    Returns whether any solutions were stored during the search.
  - solution
```
public Assignment solution(int n)
```
    Returns the nth solution.
  - last_solution_or_null
```
public Assignment last_solution_or_null()
```
    Returns the last solution if there are any, nullptr otherwise.
  - wallTime
```
public long wallTime(int n)
```
    Returns the wall time in ms for the nth solution.
  - branches
```
public long branches(int n)
```
    Returns the number of branches when the nth solution was found.
  - failures
```
public long failures(int n)
```
    Returns the number of failures encountered at the time of the nth
    solution.
  - objectiveValue
```
public long objectiveValue(int n)
```
    Returns the objective value of the nth solution.
  - ObjectiveValueFromIndex
```
public long ObjectiveValueFromIndex(int n,
                                    int index)
```
    Returns the value of the index-th objective of the nth solution.
  - value
```
public long value(int n,
                  IntVar var)
```
    This is a shortcut to get the Value of 'var' in the nth solution.
  - startValue
```
public long startValue(int n,
                       IntervalVar var)
```
    This is a shortcut to get the StartValue of 'var' in the nth solution.
  - endValue
```
public long endValue(int n,
                     IntervalVar var)
```
    This is a shortcut to get the EndValue of 'var' in the nth solution.
  - durationValue
```
public long durationValue(int n,
                          IntervalVar var)
```
    This is a shortcut to get the DurationValue of 'var' in the nth solution.
  - performedValue
```
public long performedValue(int n,
                           IntervalVar var)
```
    This is a shortcut to get the PerformedValue of 'var' in the nth solution.
  - forwardSequence
```
public int[] forwardSequence(int n,
                             SequenceVar var)
```
    This is a shortcut to get the ForwardSequence of 'var' in the
    nth solution. The forward sequence is the list of ranked interval
    variables starting from the start of the sequence.
  - backwardSequence
```
public int[] backwardSequence(int n,
                              SequenceVar var)
```
    This is a shortcut to get the BackwardSequence of 'var' in the
    nth solution. The backward sequence is the list of ranked interval
    variables starting from the end of the sequence.
  - unperformed
```
public int[] unperformed(int n,
                         SequenceVar var)
```
    This is a shortcut to get the list of unperformed of 'var' in the
    nth solution.

Class SolutionCollector

Field Summary

Fields inherited from class com.google.ortools.constraintsolver.SearchMonitor

Fields inherited from class com.google.ortools.constraintsolver.BaseObject

Constructor Summary

Method Summary

Methods inherited from class com.google.ortools.constraintsolver.SearchMonitor

Methods inherited from class com.google.ortools.constraintsolver.BaseObject

Methods inherited from class java.lang.Object

Constructor Detail

SolutionCollector

SolutionCollector

SolutionCollector

Method Detail

getCPtr

swigRelease

finalize

delete

install

toString

add

add

add

add

add

add

addObjective

AddObjectives

enterSearch

solutionCount

has_solution

solution

last_solution_or_null

wallTime

branches

failures

objectiveValue

ObjectiveValueFromIndex

value

startValue

endValue

durationValue

performedValue

forwardSequence

backwardSequence

unperformed