ASolutionCandidateFoundEvent (jaicore-basic 0.2.3 API)

java.lang.Object
- ai.libs.jaicore.basic.algorithm.AAlgorithmEvent
- - ai.libs.jaicore.basic.algorithm.ASolutionCandidateFoundEvent<O>

Type Parameters:

O - class from which solution elements stem from

All Implemented Interfaces:

org.api4.java.algorithm.events.IAlgorithmEvent, org.api4.java.algorithm.events.result.ISolutionCandidateFoundEvent<O>, org.api4.java.common.event.IEvent
```
public class ASolutionCandidateFoundEvent<O>
extends AAlgorithmEvent
implements org.api4.java.algorithm.events.result.ISolutionCandidateFoundEvent<O>
```
This is to notify listeners that an algorithm has found a solution candidate. Note that this is generally not the answer returned by the algorithm but only one possible candidate.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  ASolutionCandidateFoundEvent(org.api4.java.algorithm.IAlgorithm<?,?> algorithm, O solutionCandidate)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  int getGID()
  
  O getSolutionCandidate()
  - Methods inherited from class ai.libs.jaicore.basic.algorithm.AAlgorithmEvent
    getAlgorithmId, getTimestamp
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface org.api4.java.algorithm.events.IAlgorithmEvent
    getAlgorithmId
  - Methods inherited from interface org.api4.java.common.event.IEvent
    getTimestamp

Constructor Detail

ASolutionCandidateFoundEvent

public ASolutionCandidateFoundEvent(org.api4.java.algorithm.IAlgorithm<?,?> algorithm,
                                    O solutionCandidate)

Method Detail
- getSolutionCandidate
```
public O getSolutionCandidate()
```
  Specified by:
  
  getSolutionCandidate in interface org.api4.java.algorithm.events.result.ISolutionCandidateFoundEvent<O>
- getGID
```
public int getGID()
```