AnyLogic
Expand
Font size

Package com.anylogic.engine

Interface Summary 
AbstractLinkToAgent<T extends Agent,​A extends Agent>  
AgentConstants  
AgentDestroyListener  
AgentExtension
Base interface for extensions of Agents.
Area2D
This interface represents some rectangular area.
Area3D
This interface represents some rectangular area.
ArrivalCallback  
EnvironmentConstants  
ExperimentExecutionListener
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
ExtAgentContinuous
An extension of agent designed to support agent based modeling in continuous (3D) space, in particular:
- time (continuous or discrete)
- 3D continuous space
- connections between agents, networks (e.g.
ExtAgentDiscrete
An extension of Agent designed to support agent based modeling in discrete 2D space, in particular:
- time (continuous or discrete)
- 2D discrete space
- connections between agents, networks (e.g.
ExtAgentGIS
An extension of Agent designed to support agent based modeling in continuous GIS space, in particular:
- time (continuous or discrete)
- continuous 2D space based on GIS map
- connections between agents, networks (e.g.
ExtAgentInteractive
An extension of Agent designed to support agent communication, in particular:
- time (continuous or discrete)
- connections between agents, networks (e.g.
ExtAgentWithSpatialMetrics  
ExtAnimationParams  
ExtDefaultAnimationProvider  
ExtEntity  
ExtEnvironmentContinuous
Agent environment extension for continuous (3D) space
ExtEnvironmentDiscrete
Agent environment extension for discrete 2D space
ExtEnvironmentGIS
Agent environment extension for continuous 2D space based on GIS map
ExtEnvironmentInteractive
Extension interface for agent environment with communication enabled.
ExtEnvironmentWithLayout  
ExtEnvironmentWithMetrics  
ExtRootModelAgent
This extension may be defined only in the top-level agent of the model.
ExtSpace
This extension: Tracks moving agents (either straight movement or through network or on the GIS map) Owns animator for agents created dynamically in flowcharts and for agents which jumped from their original space (implemented using replicated embedded object presentation shape)
ExtWithSpaceType
This interface is internal and shouldn't be called by user.
it may be removed/renamed in future.
IPathData  
IRouteProvider<T extends IPathData>
This is a base interface to create a route for an agent.
IRunConfiguration<T extends Agent>  
IRunConfigurationProvider
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
IRunOutputsConsumer  
IRunValueAccessor  
IRunValueDescriptor<T>  
IStatechartState<A extends Agent,​T extends java.lang.Enum<T> & IStatechartState<A,​T>>
Base interface for all statechart state enumerations
IUnits<T extends IUnits<T>>
Base interface for all units enumerations
LearningAgentInterface<O,​A,​C>
Data communication interface designed for use with ExperimentReinforcementLearning: describes the interaction between the model and Learning Platform / pre-trained Learning Agent
LearningAgentModelInterface<ROOT extends Agent>
Internal interface designed for different usage patterns with Reinforcement Learning
LinkToAgent<T extends Agent,​A extends Agent>  
LinkToAgentAnimationSettings  
LinkToAgentCollection<T extends Agent,​A extends Agent>  
Locatable2D
This interface represents some point location.
Locatable3D
This interface represents some location.
Path2D
This interface represents a sequence of (x, y) points
Coordinates of all the points (Path2D.getPointDx(int), Path2D.getPointDy(int)) are relative to the base coordinates (Path2D.getX(), Path2D.getY())
Path3D
This interface represents a sequence of (x, y, z) points
Coordinates of all the points (Path2D.getPointDx(int), Path2D.getPointDy(int), Path3D.getPointDz(int)) are relative to the base coordinates (Path2D.getX(), Path2D.getY(), Path3D.getZ())
ReinforcementLearningModel<ROOT extends Agent,​O,​A,​C>  
ReinforcementLearningPlatform<ROOT extends Agent,​O,​A,​C>  
Segment2D
This interface represents a segment: (x, y) - (x+dx, y+dy)
Segment3D
This interface represents a segment: (x, y, z) - (x+dx, y+dy, z+dz)
Interface Description
Class Summary 
AbstractAgentPlainMovementData  
AbstractShapeGISMap
GIS map projection manager and map renderer class
GIS map is a Shape and it can be placed on the model animation: it renders the associated map projection on the screen
This class provides several projection methods
Agent
This is a base class for all agent classes created by the user.
AgentArrayList<E extends Agent>
Agent population list based on array implementation
Supports fast element retrieval by its index (the AgentArrayList.get(int) operation runs in constant time).
The add operation runs in amortized constant time, that is, adding n elements requires O(n) time.
AgentExtensionFactory<T extends AgentExtension>  
AgentExtensionImpl
Base class for extensions of Agents.
Please note that agent, during its lifetime, may change instances of some extensions (e.g.
AgentLinkedHashSet<E extends Agent>
Agent population collection based on LinkedHashSet implementation
This collection offers constant time performance for the basic operations (add, remove, contains and size) and guarantees insertion-order during iteration

Note, that due to set-based implementation, element retrieval by its index (AgentLinkedHashSet.get(int)) is extremely slow when rapidly invoked it with random index for large collections.
AgentList<E extends Agent>
Agent population list interface
AgentSpacePosition  
AnyLogicRuntimePreferences
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
CellPosition
A simple pair of integers: r (row) and c (column)
CustomDistribution
This class is used to generate random numbers from a probability density function (PDF) defined as a number of pairs (value,rate) with possible interpolation.
CustomDistributionOfOptions<E extends java.lang.Enum<E>>
This class is used to randomly pick constant from list of options, based on the supplied empirical rate array directly.
Dimension
A dimension of a HyperArray - a set of non-negative integers (or identifiers mapped to non-negative integers) that are used as indexes in hyper arrays.
DynamicEvent
This class is a base class for dynamic events created by the user.
Engine
The simulation engine that drives the model execution.
Environment Deprecated.
this class only stores constants, for compatibility and may be removed in future
Event
Base class for all kinds of (static) events: EventTimeout, EventRate and EventCondition.
Memory: sizeof(EventOriginator) = 22 bytes
EventCondition
Event with trigger of type condition.
EventOriginator
Base class for all constructs in AnyLogic modeling language that are able to schedule discrete events, like Event, DynamicEvent and Transition.
Memory: sizeof(Object) + 8 bytes = 22 bytes
EventProfiler  
EventRate
Event with trigger of type rate.
EventTimeout
Event with trigger of type timeout.
Experiment<ROOT extends Agent>
A base class for all AnyLogic experiments.
ExperimentCompareRuns<ROOT extends Agent>
Experiment used to run simulation several times with different parameter values set by user before each run.
To use this experiment you need to subclass from it and override method Experiment.onEngineFinished().
ExperimentCustom
Base class for all custom experiments
The experiment scenario should be defined in the overridden ExperimentCustom.run() method

Custom experiment may be executed from another experiment - in this case the latter should be passed as an argument to the constructor of the custom experiment.
ExperimentMultipleRuns<ROOT extends Agent>
Base class for all experiments that support multiple simulation runs (e.g.
ExperimentOptimization<ROOT extends Agent>
Experiment used to search for optimal solutions.
ExperimentParamVariation<ROOT extends Agent>
Experiment used to run simulation several times with different parameter values.
ExperimentReinforcementLearning<ROOT extends Agent,​O,​A,​C>
Base class for Reinforcement Learning experiments.

This class serves as an interface between the model and the platform (Learning Platform) using Reinforcement Learning to train some Learning Agent which is based on that platform (e.g.
ExperimentRunFast<ROOT extends Agent>
Base class for all experiments that support fast simulation run (e.g.
ExperimentSimulation<ROOT extends Agent>
The simplest possible experiment consisting of a single simulation run.
ExtAgentContinuousDelegate<E extends ExtAgentContinuous> Deprecated.
ExtAgentWithSpatialMetricsDelegate<E extends ExtAgentWithSpatialMetrics>
Base class for extensions delegating their 'Continuous / GIS space agent' activity to an existing extension of agent
ExtEntityContinuousDelegate<E extends ExtEntity> Deprecated.
ExtEntityDelegate<E extends ExtEntity>
Base class for extensions delegating their 'Entity' activity to an existing extension of agent
FlowchartBlock
Base class for all process flowchart blocks in new libraries since AnyLogic 7.
Provides standard functions like FlowchartBlock.remove(Agent).
FlowchartMappedPort<InMessageType,​OutMessageType>
An implementation of FlowchartPort which delegates its FlowchartMappedPort.count() and FlowchartMappedPort.isError() methods to another port, this one is mapped with.
Usage: create a custom port of this type and add connector from this port to the port of embedded object (or call FlowchartMappedPort.map(Port) on this port).
There should be one and only one mapped port, otherwise an error will be thrown.
FlowchartPort<InMessageType,​OutMessageType>
Special Port class for flowchart blocks.
HyperArray
A storage for multi-dimensional data used primarily in system dynamics models.
IRunValueDescriptorImpl<T>  
LibraryEventHandler
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
LibraryEventHandler.Event  
LinkToAgentAnimationSettingsImpl  
LinkToAgentCollectionImpl<T extends Agent,​A extends Agent>  
LinkToAgentImpl<T extends Agent,​A extends Agent>  
LinkToAgentStandardImpl<T extends Agent,​A extends Agent>  
LRUCache<K,​V>  
ModelProperties
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
OptimizationCallback
This class is designed for usage in optimizations performed within custom experiments, see ExperimentOptimization.createOptimization(Engine, OptimizationCallback).

Usage example (the code of custom experiment, requires import com.opttek.optquest.*;):
Pair<FIRST,​SECOND>
A pair of two (possibly null) elements, may be used as key in maps.
Overrides Pair.equals(Object) and Pair.hashCode().
Objects of this class are immutable: they have no setter methods.
Point
Class representing Point structure: three coordinates (x, y, z).
Port<InMessageType,​OutMessageType>
Port is a universal interface of an agent via which it can send and receive messages - arbitrary objects.
Position
Class representing Point structure three coordinates (x, y, z) with two angles for orientation.
Presentable
A base for any object that can be displayed by presentation panel.
Scale  
Schedule<V extends java.io.Serializable>
Schedule class.
ScheduleWithUnits<U extends IUnits<U>>
Schedule with units (Time, Rate etc.).
SDIntegrationManager
This class solves a system of algebraic differential equations.
SDUtilities
This class contains functions commonly used in System Dynamic modeling.
Statechart<T extends java.lang.Enum<T> & IStatechartState<?,​T>>
Statechart - the most advanced construct to describe event- and time-driven behavior.
TableFunction
Table function enables the user to define functions by giving a number of (argument, value) pairs, i.e.
TableTransferable
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
Transition
Base class for all kinds of statechart transitions: TransitionTimeout, TransitionRate, TransitionCondition and TransitionMessage
Memory: sizeof(EventOriginator) = 22 bytes
TransitionCondition
Statechart transition with trigger of type condition.
TransitionMessage
Statechart transition with trigger of type message.
TransitionRate
Statechart transition with trigger of type rate.
TransitionTimeout
Statechart transition with trigger of type timeout.
Utilities
This class provides a lot of commonly used functions and constants, including the probability distributions and mathematical functions.
UtilitiesArray
This class provides a lot of commonly used functions for operations with arrays
UtilitiesCollection
This class provides a lot of commonly used functions for operations with collections / agent populations
VariableDelay
This class is designed for internal use inside AnyLogic code generation, it shouldn't be explicitly accessed by users.
VariableDelay object accumulates a history of an expression (of type double or HyperArray and generates delayed values of the expression using the accumulated information.
Class Description
Enum Summary 
AccelerationUnits
Standard AnyLogic acceleration units, should be used in specific functions and parameters which work with units.
AgentOrientation  
AmountType  
AmountUnits
Standard AnyLogic amount units, should be used in specific functions and parameters which work with units.
AngleUnits  
AnyLogicCustomProposalPriority.Type  
AnyLogicCustomProposalType.Label  
AnyLogicCustomSerializationMode
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
The mode constants for AnyLogicCustomSerialization annotation<
AreaUnits
Standard AnyLogic area units, should be used in specific functions and parameters which work with units.
CellDirection
Constants for directions in discrete space
CustomDistribution.InterpolationType  
Engine.EventSelectionMode
Simultaneous event selection mode constants
Engine.ModelType
The type of the model, returned by Engine.
Engine.SolverDAEType
The solver type for mixed differential-algebraic equations
Engine.SolverNAEType
The solver type for algebraic equations
Engine.SolverODEType
The solver type for ordinary differential equations
Engine.State
The state of the Engine
EventProfiler.EventType  
EventTimeout.Mode  
Experiment.Command  
Experiment.State
The state of the Engine
ExperimentMultipleRuns.ConfidenceLevel
Confidence level constants
FlowchartActivityType
Type of state the agent may be in when inside some flowchart block.
FlowRateUnits
Standard AnyLogic flow rate units, should be used in specific functions and parameters which work with units.
LayoutType
Layout type constants for agent environments supporting layout
LengthUnits
Standard AnyLogic length units, should be used in specific functions and parameters which work with units.
MessageDeliveryType
Message destination types for inter-agent communication
ModelPropertyName
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
NeighborhoodType
Types of neighborhood for discrete space environment
NetworkType
Agent network type constants
RateUnits
Standard AnyLogic rate units, should be used in specific functions and parameters which work with units.
RotationSpeedUnits  
SpaceType  
SpeedUnits
Standard AnyLogic speed units, should be used in specific functions and parameters which work with units.
TableFunction.InterpolationType  
TableFunction.OutOfRangeAction  
TimeUnits
Standard AnyLogic time units, should be used in specific functions and parameters which work with units.
VariableDelay.Type
Type of delay object, see description on items
Enum Description
Exception Summary 
ModelException  
ProbabilityDistributionIllegalArgumentException  
ProbabilityDistributionInfiniteLoopException  
Exception Description
Annotation Types Summary 
AnyLogicCustomAliasProposal
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
AnyLogicCustomProposalPriority
Users should ignore this annotation.
This annotation is used only inside the AnyLogic, for code completion purposes
AnyLogicCustomProposalType
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
AnyLogicCustomSerialization
This class is internal and shouldn't be called by user.
it may be removed/renamed in future.
Annotation for custom serialization processing during save to snapshot operations.
AnyLogicInternalAPI
Classes, methods and fields marked with this annotation should not be called by user
These members are invoked by engine internals and are public only due to restrictions of java language (inter-package visibility, interface members etc.)
This annotation is used only inside the Engine for development purposes

Methods and fiend annotated using this annotation may have names ending with "_xjal" suffix as well
AnyLogicInternalCodegenAPI
Classes, methods and fields marked with this annotation should not be called by user
These members are usually invoked by automatically generated code
This annotation is used only inside the Engine for development purposes

Methods and fiend annotated using this annotation may have names ending with "_xjal" suffix as well
AnyLogicInternalLibraryAPI
Classes, methods and fields marked with this annotation should not be called by user
These members are invoked by engine internals and are public only due to restrictions of java language (inter-package visibility, interface members etc.)
This annotation is used only inside the Engine for development purposes

Methods and fiend annotated using this annotation may have names ending with "_xjal" suffix as well
AnyLogicLegacyAPI
Classes, methods and fields marked with this annotation are from old versions of AnyLogic, they are supported and may be called by user.
Annotation Type Description
How can we improve this article?