skf.config

Interface ConfigurationInterface

All Known Implementing Classes:

Configuration

public interface ConfigurationInterface

The root interface in the Configuration hierarchy. A configuration is a set of parameters related to the SEE event, which are used by the SKF framework to set up a SEE Federate on the specific RTI infrastructure.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCrcHost()
int	getCrcPort()
java.lang.String	getFederateName()
java.lang.String	getFederateRole()
java.lang.String	getFederateType()
java.lang.String	getFederationName()
java.io.File	getFomDirectory()
long	getLookahead()
double	getSimulationScenarioTimeEphoc()
boolean	isAsynchronousDelivery()
boolean	isRealtime()
boolean	isTimeConstrained()
boolean	isTimeRegulating()
void	setAsynchronousDelivery(boolean bool) Sets the Asynchronous delivery to the specified value passed as parameter
void	setCrcHost(java.lang.String crcHost) Sets the CRC host to the specified value passed as parameter
void	setCrcPort(int crcHost) Sets the CRC port to the specified value passed as parameter
void	setFederateName(java.lang.String federateName) Sets the name of the federate to the specified value passed as parameter
void	setFederateRole(java.lang.String federateRole) Sets the role of the federate (EARLY or LATE)
void	setFederateType(java.lang.String federateType) Sets the type of the federate to the specified value passed as parameter
void	setFederationName(java.lang.String federationName) Sets the federation name to the specified value passed as parameter
void	setFomDirectory(java.io.File dir) Sets the FOMs directory to the specified value passed as parameter
void	setLookahead(long lookahead) Sets the lookahead time for the simulation execution
void	setRealtime(boolean bool) Sets the realtime clock to the specified value passed as parameter
void	setSimulationScenarioTimeEphoc(double simulationScenarioTimeEphoc) Sets the Simulation Scenario Time Ephoc
void	setTimeConstrained(boolean bool) Sets the time constrained to the specified value passed as parameter
void	setTimeRegulating(boolean bool) Sets the time regulating to the specified value passed as parameter

Method Detail

getCrcHost

java.lang.String getCrcHost()

Returns:

The IP address of the host

getCrcPort

int getCrcPort()

Returns:

The CRC port

getFederationName

java.lang.String getFederationName()

Returns:

The name of the SEE Federation

getFederateName

java.lang.String getFederateName()

Returns:

The name of the SEE Federate

getFederateType

java.lang.String getFederateType()

Returns:

The type of the SEE Federate

getFederateRole

java.lang.String getFederateRole()

Returns:

the federateRole (EARLY or LATE)

getFomDirectory

java.io.File getFomDirectory()

Returns:

The directory that contains the FOMs module

isAsynchronousDelivery

boolean isAsynchronousDelivery()

Returns:

true: if the Asynchronous Delivery is enabled

isRealtime

boolean isRealtime()

Returns:

true: if the Realtime Clock is enabled

isTimeConstrained

boolean isTimeConstrained()

Returns:

true: if the Time Constrained is enabled

isTimeRegulating

boolean isTimeRegulating()

Returns:

true: if the Time Regulating is enabled

setCrcHost

void setCrcHost(java.lang.String crcHost)

Sets the CRC host to the specified value passed as parameter

Parameters:

crcHost - the new value for the CRC host

setCrcPort

void setCrcPort(int crcHost)

Sets the CRC port to the specified value passed as parameter

Parameters:

crcHost - the new value for the CRC port

setAsynchronousDelivery

void setAsynchronousDelivery(boolean bool)

Sets the Asynchronous delivery to the specified value passed as parameter

Parameters:

bool - the new value for the Asynchronous delivery

setFederationName

void setFederationName(java.lang.String federationName)

Sets the federation name to the specified value passed as parameter

Parameters:

federationName - the new value for the federation name

setFederateName

void setFederateName(java.lang.String federateName)

Sets the name of the federate to the specified value passed as parameter

Parameters:

federateName - the new name

setFederateType

void setFederateType(java.lang.String federateType)

Sets the type of the federate to the specified value passed as parameter

Parameters:

federateType - the new type

setFederateRole

void setFederateRole(java.lang.String federateRole)

Sets the role of the federate (EARLY or LATE)

Parameters:

federateRole - the new role (EARLY or LATE)

setFomDirectory

void setFomDirectory(java.io.File dir)

Sets the FOMs directory to the specified value passed as parameter

Parameters:

dir - the FOMs directory

setRealtime

void setRealtime(boolean bool)

Sets the realtime clock to the specified value passed as parameter

Parameters:

bool - the new value for the realtime clock

setTimeRegulating

void setTimeRegulating(boolean bool)

Sets the time regulating to the specified value passed as parameter

Parameters:

bool - the new value for the time regulating

setTimeConstrained

void setTimeConstrained(boolean bool)

Sets the time constrained to the specified value passed as parameter

Parameters:

bool - the new value for the time constrained

getSimulationScenarioTimeEphoc

double getSimulationScenarioTimeEphoc()

Returns:

The Simulation Scenario Time Ephoc

setSimulationScenarioTimeEphoc

void setSimulationScenarioTimeEphoc(double simulationScenarioTimeEphoc)

Sets the Simulation Scenario Time Ephoc

Parameters:

simulationScenarioTimeEphoc - the simulation scenario time expressed as Truncaded Julian Date (TJD)

setLookahead

void setLookahead(long lookahead)

Sets the lookahead time for the simulation execution

Parameters:

lookahead - the simulation execution lookahead interval expressed in milliseconds

getLookahead

long getLookahead()

Returns:

the lookahead time