Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbsoluteTime - Class in com.agi.mbse.sysml2.api.time
-
Time class used to represent a specific absolute time.
- ActionContext - Interface in com.agi.mbse.sysml2.api.delegation.services
-
Context for an Action, allowing access to the Action's parameters.
- addTotalSeconds(double) - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
-
Adds a floating point number of seconds to this time to a maximum precision of nanoseconds.
- addTotalSeconds(Number) - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
-
Adds a floating point number of seconds to this time to a maximum precision of nanoseconds.
C
- CalcContext - Interface in com.agi.mbse.sysml2.api.delegation.services
-
Context for a Calculation, allowing access to the Calculation's parameter.
- canCreateEvaluator(TimeInterval) - Method in interface com.agi.mbse.sysml2.api.delegation.ScalarValueFeatureAccessor
-
Check to see if an evaluator can be created over the
analysisInterval
. - ClosedApi - Annotation Interface in com.agi.mbse.sysml2.api.annotations
-
An element of the API that is to be implemented by the engine.
- com.agi.mbse.sysml2.api.annotations - package com.agi.mbse.sysml2.api.annotations
- com.agi.mbse.sysml2.api.delegation - package com.agi.mbse.sysml2.api.delegation
- com.agi.mbse.sysml2.api.delegation.model - package com.agi.mbse.sysml2.api.delegation.model
- com.agi.mbse.sysml2.api.delegation.services - package com.agi.mbse.sysml2.api.delegation.services
- com.agi.mbse.sysml2.api.elements - package com.agi.mbse.sysml2.api.elements
- com.agi.mbse.sysml2.api.exceptions - package com.agi.mbse.sysml2.api.exceptions
- com.agi.mbse.sysml2.api.time - package com.agi.mbse.sysml2.api.time
- com.agi.mbse.sysml2.api.units - package com.agi.mbse.sysml2.api.units
- com.agi.mbse.sysml2.spi - package com.agi.mbse.sysml2.spi
- compareTo(AbsoluteTime) - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
-
Compares this AbsoluteTime with another.
- ComparisonOperator - Enum Class in com.agi.mbse.sysml2.api.delegation
-
Representation of comparison operators from KerML.
- computeSatisfactionIntervals(InstanceContext, Object, ComparisonOperator) - Method in interface com.agi.mbse.sysml2.api.delegation.ScalarValueFeatureEvaluator
-
A method of determining the satisfaction intervals of this scalar value for a given threshold as function of time.
- constructData(InstanceContext) - Method in interface com.agi.mbse.sysml2.api.delegation.InstanceDataConstructor
-
Constructor for the custom data to be called as the engine needs to construct data of type
InstanceDataConstructor
. - contains(AbsoluteTime) - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Whether this TimeInterval includes the specified TimeInterval.
- ContextLogger - Interface in com.agi.mbse.sysml2.api.delegation.services
-
A utility to log messages that should be seen by the user running the simulation.
- createEvaluator(TimeInterval) - Method in interface com.agi.mbse.sysml2.api.delegation.ScalarValueFeatureAccessor
-
Create a future looking evaluator for this feature.
- CustomCodeRegistry - Interface in com.agi.mbse.sysml2.api.delegation
-
User endpoint for writing custom code and delegating implementations for expanding the function of execution.
D
- debug(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs a message to the simulation log and console with a severity of DEBUG.
- deinitialize(SimulationContext) - Method in interface com.agi.mbse.sysml2.api.delegation.DelegateModule
-
The method that will be called to perform cleanup calls after the simulation exits.
- DelegateDependency - Class in com.agi.mbse.sysml2.api.delegation
-
Dependency definition for a
DelegateModule
. - DelegateDependency(UUID) - Constructor for class com.agi.mbse.sysml2.api.delegation.DelegateDependency
-
Constructor for a dependency that on a module that matches the identifier.
- delegateExecutionOfAction(String, ExecutableActionCode) - Method in interface com.agi.mbse.sysml2.api.delegation.CustomCodeRegistry
-
Delegate the execution of a SysML Action.
- DelegateIdentity - Class in com.agi.mbse.sysml2.api.delegation
-
The identifying information for the constructed
DelegateModule
. - DelegateIdentity(UUID, String) - Constructor for class com.agi.mbse.sysml2.api.delegation.DelegateIdentity
-
Constructor overload for the identity of a delegate without providing a description.
- DelegateIdentity(UUID, String, String) - Constructor for class com.agi.mbse.sysml2.api.delegation.DelegateIdentity
-
Constructor for the identity of a delegate module.
- DelegateImplementationException - Exception in com.agi.mbse.sysml2.api.exceptions
-
Exception that will be thrown during the execution of a delegate's implementation.
- DelegateImplementationException(Throwable) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.DelegateImplementationException
-
Constructs a DelegateImplementationException with a cause.
- delegateInvocationOfCalculation(String, InvocableCalculationCode) - Method in interface com.agi.mbse.sysml2.api.delegation.CustomCodeRegistry
-
Delegate the invocation of a SysML Calculation.
- DelegateModule - Interface in com.agi.mbse.sysml2.api.delegation
-
A plugin point for registering delegates in the system for a Simulation.
The simulation will call theDelegateModule.registerDelegate(com.agi.mbse.sysml2.api.delegation.CustomCodeRegistry)
method on the startup of each Simulation. - DelegateModuleProvider - Interface in com.agi.mbse.sysml2.spi
-
A plugin point which can provide a
DelegateModule
. - delegateScalarValueForFeature(String, ScalarValueFeatureAccessor<T>) - Method in interface com.agi.mbse.sysml2.api.delegation.CustomCodeRegistry
-
Delegate the implementation of a SysML Attribute typed by a ScalarValue.
- DelegateViolation - Exception in com.agi.mbse.sysml2.api.exceptions
-
Exception that will be thrown during the registration of a delegate implementation.
- DelegateViolation(String) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.DelegateViolation
-
Constructs a DelegateViolation with a message.
- DelegationResult - Interface in com.agi.mbse.sysml2.api.delegation
-
The result of a delegated execution.
- DelegationResult.FutureActionEventResponse - Class in com.agi.mbse.sysml2.api.delegation
-
Response to let the simulation know that there is more work to do.
- DelegationResult.NoAdditionalEvents - Class in com.agi.mbse.sysml2.api.delegation
-
Response to let the simulation know the delegation has completed.
E
- EQUAL - Enum constant in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Indicates that the operation should produce true if the value to the left of the operator exactly equals the value to the right of the operator.
- equals(Object) - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
- equals(Object) - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
- error(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs a message to the simulation log and console with a severity of ERROR.
- error(String, Throwable) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs a message to the simulation log and console with a severity of ERROR.
- error(Throwable) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs an exception message to the simulation log and console with a severity of ERROR.
- ExecutableActionCode - Interface in com.agi.mbse.sysml2.api.delegation
-
Template for the implementation for a single Action delegate.
- executeAction(ActionContext) - Method in interface com.agi.mbse.sysml2.api.delegation.ExecutableActionCode
-
Arbitrary code to execute when delegating the implementation of an Action.
- ExperimentalApi - Annotation Interface in com.agi.mbse.sysml2.api.annotations
-
An element of the API that may be subject to change from release to release.
F
- FeatureAccessorService - Interface in com.agi.mbse.sysml2.api.delegation.services
-
Service that provides access to features in the simulation based on their qualified name.
- FeatureAccessViolation - Exception in com.agi.mbse.sysml2.api.exceptions
-
Exception that will be thrown when a feature is accessed outside of constraints.
- FeatureAccessViolation(String) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.FeatureAccessViolation
-
Constructs a FeatureAccessViolation with a message.
- FeatureReadAccessor - Interface in com.agi.mbse.sysml2.api.delegation.model
-
Accessor for a feature that only allows for reading.
- FeatureReadWriteAccessor - Interface in com.agi.mbse.sysml2.api.delegation.model
-
Accessor for a feature that allows for reading and writing.
- FutureActionEventResponse(AbsoluteTime, ExecutableActionCode) - Constructor for class com.agi.mbse.sysml2.api.delegation.DelegationResult.FutureActionEventResponse
G
- getAccessorService() - Method in interface com.agi.mbse.sysml2.api.delegation.services.InstanceContext
- getContext() - Method in interface com.agi.mbse.sysml2.api.elements.InstanceValue
-
Returns services to retrieve information within the scope of the context for this instance.
- getContextLogger() - Method in interface com.agi.mbse.sysml2.api.delegation.services.SimulationContext
- getCurrentSimulationTime() - Method in interface com.agi.mbse.sysml2.api.delegation.services.TimeService
- getCurrentValue(InstanceContext) - Method in interface com.agi.mbse.sysml2.api.delegation.ScalarValueFeatureAccessor
-
Override for when the instance attempts to retrieve the value of this delegated attribute.
- getDataService() - Method in interface com.agi.mbse.sysml2.api.delegation.services.InstanceContext
- getDelegationData(Class<T>) - Method in interface com.agi.mbse.sysml2.api.delegation.services.InstanceDataService
-
Retrieve data by searching up the owning instances starting with 'self'.
- getDependencies() - Method in interface com.agi.mbse.sysml2.api.delegation.DelegateModule
-
The system will attempt to call
DelegateModule.initialize(SimulationContext)
on each of these dependencies before initializing this module. - getDependencyIdentifier() - Method in class com.agi.mbse.sysml2.api.delegation.DelegateDependency
- getDescription() - Method in class com.agi.mbse.sysml2.api.delegation.DelegateIdentity
- getIdentifier() - Method in class com.agi.mbse.sysml2.api.delegation.DelegateIdentity
-
The identifier should be unique to this delegate module jar but remain the same across versions of the module.
- getIdentifier() - Method in interface com.agi.mbse.sysml2.api.elements.InstanceValue
- getIdentity() - Method in interface com.agi.mbse.sysml2.api.delegation.DelegateModule
- getInputParameter(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ActionContext
- getMessage() - Method in exception com.agi.mbse.sysml2.api.exceptions.UnlicensedException
- getName() - Method in class com.agi.mbse.sysml2.api.delegation.DelegateIdentity
- getNextEventTime() - Method in class com.agi.mbse.sysml2.api.delegation.DelegationResult.FutureActionEventResponse
- getOutputParameter(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ActionContext
- getQualifiedName() - Method in interface com.agi.mbse.sysml2.api.elements.InstanceValue
- getRefUnit() - Method in class com.agi.mbse.sysml2.api.units.ScalarQuantityValue
-
Returns a unit that represents the type of this ScalarQuantityValue.
- getResultParameter() - Method in interface com.agi.mbse.sysml2.api.delegation.services.CalcContext
- getSimulationStartTime() - Method in interface com.agi.mbse.sysml2.api.delegation.services.TimeService
-
The time at which the simulation begins.
- getSimulationStopTime() - Method in interface com.agi.mbse.sysml2.api.delegation.services.TimeService
-
The time at which the simulation ends.
- getStart() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
- getStop() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
- getSymbol() - Method in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
- getTimeService() - Method in interface com.agi.mbse.sysml2.api.delegation.services.SimulationContext
- getTriggeredCallback() - Method in class com.agi.mbse.sysml2.api.delegation.DelegationResult.FutureActionEventResponse
- getValue() - Method in interface com.agi.mbse.sysml2.api.delegation.model.FeatureReadAccessor
- getValue() - Method in class com.agi.mbse.sysml2.api.units.ScalarQuantityValue
-
Returns a number that reflects the value when typed by the ScalarQuantityValue's unit.
- getValue(InstanceContext) - Method in interface com.agi.mbse.sysml2.api.delegation.ScalarValueFeatureEvaluator
-
The value of the feature as a function of time and other "current state" of the system that may evolve between SysML events.
- GREATER_THAN - Enum constant in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Indicates that the operation should produce true if the value to the left of the operator strictly exceeds the value to the right of the operator.
- GREATER_THAN_OR_EQUAL - Enum constant in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Indicates that the operation should produce true if the value to the left of the operator exceeds or equals the value to the right of the operator.
H
- hashCode() - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
- hashCode() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
I
- info(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs a message to the simulation log and console with a severity of INFO.
- initialize(SimulationContext) - Method in interface com.agi.mbse.sysml2.api.delegation.DelegateModule
-
The method that will be called to perform setup calls before the simulation.
- INSTANCE - Static variable in class com.agi.mbse.sysml2.api.delegation.DelegationResult.NoAdditionalEvents
-
Instance that represents NoAdditionalEvents
- InstanceContext - Interface in com.agi.mbse.sysml2.api.delegation.services
-
General context for the current instance of the SysML Element.
- InstanceDataConstructor<T> - Interface in com.agi.mbse.sysml2.api.delegation
-
Constructor for a custom data type that will be injected alongside the construction of SysML Element instances.
- InstanceDataService - Interface in com.agi.mbse.sysml2.api.delegation.services
-
Service that provides access to registered in scope data.
- InstanceValue - Interface in com.agi.mbse.sysml2.api.elements
-
Representation for the value of a SysML instance during execution.
- intersect(TimeInterval) - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Produces the interval of time that is common between this interval and the other interval.
- intersect(List<TimeInterval>, List<TimeInterval>) - Static method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Get the intersecting intervals between two lists of intervals.
- InvalidModelException - Exception in com.agi.mbse.sysml2.api.exceptions
-
Thrown if there is an error encountered in the SysML v2 model.
- InvalidModelException(String) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.InvalidModelException
-
Constructs a InvalidModelException with a message.
- InvalidModelException(String, Throwable) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.InvalidModelException
-
Constructs a InvalidModelException with a message and a cause.
- invert(TimeInterval, Collection<TimeInterval>) - Static method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Inverts the intervals along an interval of time.
- InvocableCalculationCode - Interface in com.agi.mbse.sysml2.api.delegation
-
Template for the implementation for a single Calculation delegate.
- invokeCalculation(CalcContext) - Method in interface com.agi.mbse.sysml2.api.delegation.InvocableCalculationCode
-
Defines code that the engine will execute when invoking a SysML Calculation.
- isClosed() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Whether this TimeInterval is closed.
- isEmpty() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Whether this TimeInterval is empty.
- isStartIncluded() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Gets a
boolean
value indicating whetherTimeInterval.getStart()
is included in this TimeInterval. - isStopIncluded() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Gets a
boolean
value indicating whetherTimeInterval.getStop()
is included in this TimeInterval.
L
- LESS_THAN - Enum constant in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Indicates that the operation should produce true if the value to the right of the operator strictly exceeds the value to the left of the operator.
- LESS_THAN_OR_EQUAL - Enum constant in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Indicates that the operation should produce true if the value to the right of the operator exceeds or equals the value to the left of the operator.
N
- NOT_EQUAL - Enum constant in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Indicates that the operation should produce true if the value to the left of the operator does not exactly equal the value to the right of the operator.
O
- onSimulationTimeAdvanced(InstanceContext) - Method in interface com.agi.mbse.sysml2.api.delegation.SimulationTimeAdvancedListener
-
Defines code that the engine will execute after advancing the simulated universal clock but before it processes the next discrete events at that new time.
- OpenApi - Annotation Interface in com.agi.mbse.sysml2.api.annotations
-
An element of the API that is to be implemented by users.
P
- parseIso8601(CharSequence) - Static method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
-
Parses the given iso8601-formatted time string to create an AbsoluteTime.
- provideDelegateModule() - Method in interface com.agi.mbse.sysml2.spi.DelegateModuleProvider
-
Called in order to provide a delegate module.
R
- registerDelegate(CustomCodeRegistry) - Method in interface com.agi.mbse.sysml2.api.delegation.DelegateModule
-
Method that will be called on Simulation startup to configure the delegate module.
- registerInstanceDataFor(String, Class<T>, InstanceDataConstructor<T>) - Method in interface com.agi.mbse.sysml2.api.delegation.CustomCodeRegistry
-
Register a
InstanceDataConstructor
for custom data that will be constructed alongside a specific SysML Element. - registerSimulationTimeAdvancedListener(SimulationTimeAdvancedListener) - Method in interface com.agi.mbse.sysml2.api.delegation.CustomCodeRegistry
-
Register a
SimulationTimeAdvancedListener
to be executed every time the simulation time advances between discrete events during execution. - requestFeature(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.FeatureAccessorService
-
Request an accessor for a feature if is in scope of the current element.
- requestMutableFeature(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.FeatureAccessorService
-
Request a mutable accessor for a feature if is in scope of the current element.
S
- ScalarQuantityValue - Class in com.agi.mbse.sysml2.api.units
-
Class representing a SysML v2 Value that can be expressed with a number and a unit.
- ScalarQuantityValue(Number, Unit<?>) - Constructor for class com.agi.mbse.sysml2.api.units.ScalarQuantityValue
-
Class representing a SysML v2 Value that can be expressed with a number and a unit.
- ScalarValueFeatureAccessor<T> - Interface in com.agi.mbse.sysml2.api.delegation
-
Template for the implementation for a single scalar value.
- ScalarValueFeatureEvaluator<T> - Interface in com.agi.mbse.sysml2.api.delegation
-
Represents a plugin point where custom module authors can provide implementation to provide the current and future values for a specific SysML feature.
- setCurrentValue(List<Object>, InstanceContext) - Method in interface com.agi.mbse.sysml2.api.delegation.ScalarValueFeatureAccessor
-
Override for when the instance attempts to mutate the value of this delegated attribute.
- setValue(List<Object>) - Method in interface com.agi.mbse.sysml2.api.delegation.model.FeatureReadWriteAccessor
-
Overwrites the current value for the feature.
- SimulationContext - Interface in com.agi.mbse.sysml2.api.delegation.services
-
General context for the current running simulation.
- SimulationTimeAdvancedListener - Interface in com.agi.mbse.sysml2.api.delegation
-
A template for listening for a time update for the simulated universal clock.
T
- TimeInterval - Class in com.agi.mbse.sysml2.api.time
-
Interval of two absolute times.
- TimeInterval(AbsoluteTime, AbsoluteTime) - Constructor for class com.agi.mbse.sysml2.api.time.TimeInterval
- TimeInterval(AbsoluteTime, AbsoluteTime, boolean, boolean) - Constructor for class com.agi.mbse.sysml2.api.time.TimeInterval
- TimeService - Interface in com.agi.mbse.sysml2.api.delegation.services
-
Service for dealing with Time in the system.
- toIso8601String() - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
- toJavaInstant() - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
- toString() - Method in class com.agi.mbse.sysml2.api.time.AbsoluteTime
- toString() - Method in class com.agi.mbse.sysml2.api.time.TimeInterval
- tryGetDelegationData(Class<T>) - Method in interface com.agi.mbse.sysml2.api.delegation.services.InstanceDataService
-
Retrieve data by searching up the owning instances starting with 'self'.
U
- union(Collection<TimeInterval>, Iterable<TimeInterval>) - Static method in class com.agi.mbse.sysml2.api.time.TimeInterval
-
Flattens two collections of intervals into one list of all time they covered.
- UnlicensedException - Exception in com.agi.mbse.sysml2.api.exceptions
-
Thrown if there is an error encountered checking out the license.
- UnlicensedException(String) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.UnlicensedException
-
Constructs a UnlicensedException with a message.
- UnsupportedDelegateTypeException - Exception in com.agi.mbse.sysml2.api.exceptions
-
Exception that is thrown when an unsupported Type has been delegated for.
- UnsupportedDelegateTypeException(String) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.UnsupportedDelegateTypeException
-
Constructs a UnsupportedDelegateTypeException with a message.
- UnsupportedLanguageFeatureException - Exception in com.agi.mbse.sysml2.api.exceptions
-
Exception thrown by the ExpressionParser when an unsupported operation is encountered.
- UnsupportedLanguageFeatureException(String) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.UnsupportedLanguageFeatureException
-
Constructs a UnsupportedMetamodelException with a message.
- UnsupportedLanguageFeatureException(String, Throwable) - Constructor for exception com.agi.mbse.sysml2.api.exceptions.UnsupportedLanguageFeatureException
-
Constructs a UnsupportedMetamodelException with a message and a cause.
V
- valueOf(String) - Static method in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.agi.mbse.sysml2.api.delegation.ComparisonOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warn(String) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs a message to the simulation log and console with a severity of WARN.
- warn(Throwable) - Method in interface com.agi.mbse.sysml2.api.delegation.services.ContextLogger
-
Logs an exception message to the simulation log and console with a severity of WARN.
All Classes and Interfaces|All Packages|Serialized Form