io.capsisBridgeClient

Class CapsisBridgeClientGrpc

java.lang.Object

io.capsisBridgeClient.AbstractCapsisBridgeClient

io.capsisBridgeClient.CapsisBridgeClientGrpc

public class CapsisBridgeClientGrpc
extends AbstractCapsisBridgeClient

This class implements the gRPC mode CapsisBridgeClient.

Since:

2020-12-22

Nested Class Summary

Nested classes/interfaces inherited from class io.capsisBridgeClient.AbstractCapsisBridgeClient

AbstractCapsisBridgeClient.TestHelper

Field Summary

Fields inherited from class io.capsisBridgeClient.AbstractCapsisBridgeClient

testHelper

Constructor Summary

Constructors

Constructor and Description
CapsisBridgeClientGrpc(io.grpc.ManagedChannel _channel) Construct client for accessing CapsisBridge server using the existing channel.
CapsisBridgeClientGrpc(java.lang.String _target) Construct client for accessing CapsisBridge server using the existing channel.

Method Summary

Modifier and Type	Method and Description
void	addSimulationResult(java.lang.String stratumGroup, int initialAgeYr, CBSimulationResult result) Adds a simulation result to the MetaModelManager
void	closeProject() Closes the project
SimulationResult.Matrix	convertMatrixToGrpc(CBSimulationResult.Matrix m)
void	fitMetaModels() Fits the metamodels on the previously given simulation results for all StratumGroupIDs.
void	freeAndReportMemory() Debug only method : calls GC and reports used memory.
CBDataSet	getMetaModelResult(java.lang.String stratumGroup) Gets the fitted metamodel simulation results
java.util.List<CBModelDataField>	getModelDataFields() Gets the model data fields
java.util.List<java.lang.String>	getPossibleOutputTypes(java.lang.String stratumGroup) Gets the metamodel possible output types.
double	getPrediction(java.lang.String stratumGroup, int ageYr, int timeSinceInitialDateYr, java.lang.String outputType) Gets a metamodel prediction for a particular stratumGroup
java.util.Map<java.lang.String,java.lang.String>	getVersion() Gets the CAPSIS and bridge versions
void	load(java.lang.String fileName) Loads a metamodel to a file
CBSimulationResult	runSimulation() Runs the simulation using the given initialParameters, evolutionParameters and data.
void	save(java.lang.String fileName) Saves a metamodel to a file
void	sendData(java.util.ArrayList<java.util.List<java.lang.String>> data) Sends the model data
void	setEvolutionParameters(CBEvolutionParameters evolutionParameters) Sets the evolution parameters
void	setFieldMatches(java.lang.Integer[] matches) Sets the field matches
void	setInitialModelParameters(CBModelParameters modelParameters) Sets the initial model parameters
void	shutDownNow() Destroys the communication channel and exits the current process

Methods inherited from class io.capsisBridgeClient.AbstractCapsisBridgeClient

info, setTestHelper, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CapsisBridgeClientGrpc

public CapsisBridgeClientGrpc(java.lang.String _target)

Construct client for accessing CapsisBridge server using the existing channel.

CapsisBridgeClientGrpc

public CapsisBridgeClientGrpc(io.grpc.ManagedChannel _channel)

Construct client for accessing CapsisBridge server using the existing channel.

Method Detail

shutDownNow

public void shutDownNow()

Destroys the communication channel and exits the current process

Specified by:

shutDownNow in class AbstractCapsisBridgeClient

getModelDataFields

public java.util.List<CBModelDataField> getModelDataFields()

Description copied from class: AbstractCapsisBridgeClient

Gets the model data fields

Specified by:

getModelDataFields in class AbstractCapsisBridgeClient

Returns:

ModelDataFields as ordered list of (type, name) pairs in the specific order expected by the Capsis model.

setInitialModelParameters

public void setInitialModelParameters(CBModelParameters modelParameters)

Description copied from class: AbstractCapsisBridgeClient

Sets the initial model parameters

Specified by:

setInitialModelParameters in class AbstractCapsisBridgeClient

Parameters:

modelParameters - the initial model parameters to set.

setEvolutionParameters

public void setEvolutionParameters(CBEvolutionParameters evolutionParameters)

Description copied from class: AbstractCapsisBridgeClient

Sets the evolution parameters

Specified by:

setEvolutionParameters in class AbstractCapsisBridgeClient

Parameters:

evolutionParameters - the evolution parameters to set.

setFieldMatches

public void setFieldMatches(java.lang.Integer[] matches)

Description copied from class: AbstractCapsisBridgeClient

Sets the field matches

Specified by:

setFieldMatches in class AbstractCapsisBridgeClient

Parameters:

matches - the field matches array specifying the field index order.

runSimulation

public CBSimulationResult runSimulation()

Description copied from class: AbstractCapsisBridgeClient

Runs the simulation using the given initialParameters, evolutionParameters and data.

Specified by:

runSimulation in class AbstractCapsisBridgeClient

Returns:

sendData

public void sendData(java.util.ArrayList<java.util.List<java.lang.String>> data)

Description copied from class: AbstractCapsisBridgeClient

Sends the model data

Specified by:

sendData in class AbstractCapsisBridgeClient

Parameters:

data - the model data to send to Capsis (represented in an arrayList of Lists of string values).

closeProject

public void closeProject()

Description copied from class: AbstractCapsisBridgeClient

Closes the project

Specified by:

closeProject in class AbstractCapsisBridgeClient

freeAndReportMemory

public void freeAndReportMemory()

Description copied from class: AbstractCapsisBridgeClient

Debug only method : calls GC and reports used memory. Mainly used for memory monitoring if needed.

Specified by:

freeAndReportMemory in class AbstractCapsisBridgeClient

getVersion

public java.util.Map<java.lang.String,java.lang.String> getVersion()

Description copied from class: AbstractCapsisBridgeClient

Gets the CAPSIS and bridge versions

Specified by:

getVersion in class AbstractCapsisBridgeClient

Returns:

The CAPSIS engine and bridge versions as separate strings into a map with keys ["Capsis", "Bridge]

addSimulationResult

public void addSimulationResult(java.lang.String stratumGroup,
                                int initialAgeYr,
                                CBSimulationResult result)
                         throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Adds a simulation result to the MetaModelManager

Specified by:

addSimulationResult in class AbstractCapsisBridgeClient

Parameters:

stratumGroup - The stratum group id to add the simulation results to

initialAgeYr - The initial age year of this stratum group

result - The simulations results (given by getSimulationResult)

Throws:

java.lang.RuntimeException

convertMatrixToGrpc

public SimulationResult.Matrix convertMatrixToGrpc(CBSimulationResult.Matrix m)

fitMetaModels

public void fitMetaModels()
                   throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Fits the metamodels on the previously given simulation results for all StratumGroupIDs.

Specified by:

fitMetaModels in class AbstractCapsisBridgeClient

Throws:

java.lang.RuntimeException

getPossibleOutputTypes

public java.util.List<java.lang.String> getPossibleOutputTypes(java.lang.String stratumGroup)
                                                        throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Gets the metamodel possible output types. fitMetaModels() must have been called before calling this method and it should be used to query the possible outputTypes needed in getPrediction() calls.

Specified by:

getPossibleOutputTypes in class AbstractCapsisBridgeClient

Parameters:

stratumGroup - The stratumGroup for which we want the possible output types.

Returns:

The possible output types.

Throws:

java.lang.RuntimeException

See Also:

AbstractCapsisBridgeClient.fitMetaModels(), AbstractCapsisBridgeClient.getPrediction(String, int, int, String)

getPrediction

public double getPrediction(java.lang.String stratumGroup,
                            int ageYr,
                            int timeSinceInitialDateYr,
                            java.lang.String outputType)
                     throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Gets a metamodel prediction for a particular stratumGroup

Specified by:

getPrediction in class AbstractCapsisBridgeClient

Parameters:

stratumGroup - The stratum group ID

ageYr - the age of the desired prediction

timeSinceInitialDateYr - The number of years elapsed since initialDateYear for ageYr

outputType - A string specifying the desired output. This value must be taken from the SimulationResult.DataSet.Observation values.

Returns:

Volume prediction computed from the metamodel

Throws:

java.lang.RuntimeException

getMetaModelResult

public CBDataSet getMetaModelResult(java.lang.String stratumGroup)
                             throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Gets the fitted metamodel simulation results

Specified by:

getMetaModelResult in class AbstractCapsisBridgeClient

Parameters:

stratumGroup - The stratum group ID

Returns:

Fitted dataset results

Throws:

java.lang.RuntimeException

save

public void save(java.lang.String fileName)
          throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Saves a metamodel to a file

Specified by:

save in class AbstractCapsisBridgeClient

Parameters:

fileName - The filename to save the metamodel to

Throws:

java.lang.RuntimeException

load

public void load(java.lang.String fileName)
          throws java.lang.RuntimeException

Description copied from class: AbstractCapsisBridgeClient

Loads a metamodel to a file

Specified by:

load in class AbstractCapsisBridgeClient

Parameters:

fileName - The filename to load the metamodel from

Throws:

java.lang.RuntimeException