uk.ac.soton.simulation.jsit.anylogic

Class MainModel_AnyLogic

java.lang.Object

com.anylogic.engine.Presentable

com.anylogic.engine.Utilities

com.anylogic.engine.Agent

uk.ac.soton.simulation.jsit.anylogic.MainModel_AnyLogic

All Implemented Interfaces:

com.anylogic.engine.AgentConstants, com.anylogic.engine.EnvironmentConstants, com.anylogic.engine.internal.k, java.io.Serializable, MainModel

public abstract class MainModel_AnyLogic
extends com.anylogic.engine.Agent
implements MainModel

Abstract superclass for all Agents representing the 'root' Agent for a runnable JSIT AnyLogic model.

Since:

0.1

Author:

Stuart Rossiter

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MainModel_AnyLogic.TimeOfDayPrecision Enumeration of precision alternatives for sim time-of-day values.

Nested classes/interfaces inherited from class com.anylogic.engine.Agent

com.anylogic.engine.Agent.TransitionIcon

Field Summary

Fields inherited from class com.anylogic.engine.Agent

_ARRIVAL_message_xjal

Fields inherited from class com.anylogic.engine.Utilities

AM, APRIL, AUGUST, CUSTOM_DISTRIBUTION_INTERPOLATION_LINEAR, CUSTOM_DISTRIBUTION_INTERPOLATION_NONE, CUSTOM_DISTRIBUTION_INTERPOLATION_STEP, DECEMBER, FEBRUARY, FRIDAY, infinity, JANUARY, JULY, JUNE, LENGTH_UNIT_CENTIMETER, LENGTH_UNIT_FOOT, LENGTH_UNIT_INCH, LENGTH_UNIT_KILOMETER, LENGTH_UNIT_METER, LENGTH_UNIT_MILE, MARCH, MAY, MONDAY, NOVEMBER, OCTOBER, PM, SATURDAY, SEPTEMBER, SUNDAY, THURSDAY, TIME_UNIT_DAY, TIME_UNIT_HOUR, TIME_UNIT_MILLISECOND, TIME_UNIT_MINUTE, TIME_UNIT_MONTH, TIME_UNIT_SECOND, TIME_UNIT_WEEK, TIME_UNIT_YEAR, TUESDAY, UNDECIMBER, WEDNESDAY

Fields inherited from class com.anylogic.engine.Presentable

ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, ARROW_FILLED, ARROW_NONE, ARROW_THIN, CAD_ANTIALIASING, CAD_INVERTED, DRAW_CONSTANT, DRAW_PARAMETER_DYNAMIC, DRAW_SD_ARRAY, DRAW_SD_CONSTANT, DRAW_SD_EXTERNAL, DRAW_SD_LINK_DELAY, DRAW_SD_LINK_INITIAL, DRAW_SD_NEGATIVE, DRAW_SD_NO_SOURCE, DRAW_SD_NO_TARGET, DRAW_SD_PUBLIC_ONLY, DRAW_SD_SHADOW, DRAW_SD_ZERO, DRAW_VARIABLE_CONNECTOR, LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_SOLID, SHAPE_ARC, SHAPE_BUTTON, SHAPE_CAD, SHAPE_CHART_BAR, SHAPE_CHART_HISTOGRAM, SHAPE_CHART_HISTOGRAM2D, SHAPE_CHART_PIE, SHAPE_CHART_PLOT, SHAPE_CHART_STACK, SHAPE_CHART_TIME_COLOR, SHAPE_CHART_TIME_PLOT, SHAPE_CHART_TIME_STACK, SHAPE_CHECKBOX, SHAPE_COMBOBOX, SHAPE_CURVE, SHAPE_DRAW_2D, SHAPE_DRAW_2D3D, SHAPE_DRAW_3D, SHAPE_EMBEDDED_OBJECT, SHAPE_FILECHOOSER, SHAPE_GROUP, SHAPE_IMAGE, SHAPE_LINE, SHAPE_LISTBOX, SHAPE_OVAL, SHAPE_PIXEL, SHAPE_POLYLINE, SHAPE_PROGRESSBAR, SHAPE_RADIOBUTTONS, SHAPE_RECTANGLE, SHAPE_ROUNDED_RECTANGLE, SHAPE_SLIDER, SHAPE_TEXT, SHAPE_TEXTFIELD

Fields inherited from interface com.anylogic.engine.AgentConstants

ALL, ALL_CONNECTED, ALL_NEIGHBORS, CENTIMETER, CUBIC_METER, CUBIC_METER_PER_SECOND, CUSTOM_COLOR_SCHEME, DAY, EAST, ESCALATOR_STAY_ALL, ESCALATOR_WALK_ALL, ESCALATOR_WALK_ON_LEFT_SIDE, ESCALATOR_WALK_ON_RIGHT_SIDE, EVENT_TIMEOUT_MODE_CYCLIC, EVENT_TIMEOUT_MODE_ONCE, EVENT_TIMEOUT_MODE_USER, EXCEEDED_QUEUE_CROWD_ROUND_AT_THE_END, EXCEEDED_QUEUE_EXTEND_TO_THE_FREE_SPACE, EXT_AGENT_CONTINUOUS, EXT_AGENT_DISCRETE, EXT_AGENT_GIS, EXT_AGENT_INTERACTIVE, EXT_AGENT_NETWORK, EXT_ENTITY, EXT_ENVIRONMENT_CONTINUOUS, EXT_ENVIRONMENT_DISCRETE, EXT_ENVIRONMENT_GIS, EXT_ENVIRONMENT_INTERACTIVE, EXT_SPACE, FLOW_STATISTICS_BOTH, FLOW_STATISTICS_LEFT, FLOW_STATISTICS_RIGHT, FOOT, FPM, FPS, FPS_SQ, HOUR, INCH, KILOGRAM, KILOGRAM_PER_SECOND, KILOMETER, KN, KPH, LINEAR_COLOR_SCHEME, LITER, LITER_PER_SECOND, LOGARITHMIC_COLOR_SCHEME, METER, MILE, MILLIMETER, MILLISECOND, MINUTE, MONTH, MPH, MPS, MPS_SQ, NAUTICAL_MILE, NORTH, NORTHEAST, NORTHWEST, OBJECT_3D_XYZ_AXIS_ORDER, OBJECT_3D_YZX_AXIS_ORDER, OBJECT_3D_ZXY_AXIS_ORDER, OIL_BARREL, OIL_BARREL_PER_SECOND, PALLET_RACK_LEFT_TO_RIGHT, PALLET_RACK_NO_DIRECTION, PALLET_RACK_RIGHT_TO_LEFT, PALLET_RACK_SINGLE_AISLE_LEFT, PALLET_RACK_SINGLE_AISLE_RIGHT, PALLET_RACK_TWO_AISLES, PALLET_RACK_TWO_PALLET_RACKS, PARKING_LOT_PARALLEL, PARKING_LOT_PERPENDICULAR, PATH_CONVEYOR, PATH_DASHEDLINE, PATH_LINE, PATH_RAILROAD, PATH_ROAD, PER_DAY, PER_HOUR, PER_MILLISECOND, PER_MINUTE, PER_MONTH, PER_SECOND, PER_WEEK, PER_YEAR, POSITION_CHOICE_ARRANGED, POSITION_CHOICE_BY_ATTRACTORS, POSITION_CHOICE_RANDOM, RANDOM, RANDOM_CONNECTED, RANDOM_NEIGHBOR, ROAD_LEFT_HAND, ROAD_LINE_DOUBLE, ROAD_LINE_DOUBLE_DASHED, ROAD_LINE_SINGLE, ROAD_LINE_SINGLE_DASHED, ROAD_RIGHT_HAND, SECOND, SERVICE_GROUP_BEHAVIOR_DEPENDS_ON_INCOMING_GROUP, SERVICE_GROUP_BEHAVIOR_SAME_FOR_ALL_GROUPS, SERVICE_GROUP_INDIVIDUAL_SERVING, SERVICE_GROUP_ONE_MEMBER_IS_SERVED_OTHERS_WAIT_IN_AREA, SERVICE_GROUP_ONE_MEMBER_IS_SERVED_OTHERS_WAIT_IN_QUEUE, SERVICE_QUEUE_CLOSEST_NON_EMPTY, SERVICE_QUEUE_CLOSEST_STRICT, SERVICE_QUEUE_CUSTOM, SERVICE_QUEUE_LONGEST, SERVICE_QUEUE_NEXT_ROUND_ROBIN, SERVICE_QUEUE_PRIORITY, SERVICE_TYPE_LINEAR, SERVICE_TYPE_POINT, SIGNAL_GREEN, SIGNAL_NONE, SIGNAL_RED, SIGNAL_YELLOW, SOUTH, SOUTHEAST, SOUTHWEST, SPACE_CONTINUOUS, SPACE_CONTINUOUS_2D, SPACE_DISCRETE, SPACE_DISCRETE_2D, SPACE_GIS, SPACE_UNDEFINED, SQ_CENTIMETER, SQ_FOOT, SQ_INCH, SQ_KILOMETER, SQ_METER, SQ_MILE, SQ_MILLIMETER, SQ_NAUTICAL_MILE, SQ_YARD, TON, TON_PER_SECOND, WALL_FILL_HATCHING, WALL_FILL_NONE, WALL_FILL_SOLID, WEEK, WEST, WINDOW_3D_NAVIGATION_FULL, WINDOW_3D_NAVIGATION_LIMITED_TO_Z_ABOVE_ZERO, WINDOW_3D_NAVIGATION_NONE, WINDOW_3D_NAVIGATION_ROTATION_ONLY, YARD, YEAR

Fields inherited from interface com.anylogic.engine.EnvironmentConstants

LAYOUT_ARRANGED, LAYOUT_RANDOM, LAYOUT_RING, LAYOUT_SPRING_MASS, LAYOUT_USER_DEFINED, NEIGHBORHOOD_EUCLIDEAN, NEIGHBORHOOD_MOORE, NETWORK_ALL_IN_RANGE, NETWORK_RANDOM, NETWORK_RING_LATTICE, NETWORK_SCALE_FREE, NETWORK_SMALL_WORLD, NETWORK_USER_DEFINED

Constructor Summary

Constructors

Constructor and Description
MainModel_AnyLogic() Simple constructor as now included in all AnyLogic 7 generated Agent code.
MainModel_AnyLogic(com.anylogic.engine.Engine engine, com.anylogic.engine.Agent owner, com.anylogic.engine.AgentList<? extends MainModel_AnyLogic> collection) Constructor with required signature for an Agent (undocumented by AnyLogic).

Method Summary

Modifier and Type	Method and Description
abstract void	doAllStaticPerRunLoggerSetup() Any static-level AnyLogic logger setup needs specifying in the user subclass.
abstract void	doAllStaticStochRegistration() Any static-level stochastic item registration needs to be specified by the user subclass.
java.lang.String	getDiagnosticLogFormattedSimTime() Default diagnostic log sim time formatting (as raw time to 0 d.p.
java.lang.String	getEventsLogFormattedSimTime() Default events log sim time formatting (as day + HH:MM).
java.lang.String	getInputsBasePath() Default inputs base path; user should override in their subclass to change this.
static MainModel_AnyLogic	getMainFor(com.anylogic.engine.Agent agent) Get the (closest composing) MainModel_AnyLogic 'main' model instance for the Agent in question.
ModelInitialiser	getModelInitialiser() Method so that model objects can get the singleton model initialiser (especially so as to obtain the run ID).
java.lang.String	getOutputsBasePath() Default outputs base path; user should override in their subclass to change this.
java.lang.String	getSimDay() Default current sim day AnyLogic implementation, calculating using time() and day().
java.lang.String	getSimRawTime(int rawTimeDecimalPlaces) Get the 'raw' AnyLogic simulation time, rounded down to a given number of decimal places (so that it always represents the 'time slot' of the logged event; e.g., something at sim time 100.89 is operating in '0 decimal places time slot' 100.
java.lang.String	getSimTimeOfDay(MainModel_AnyLogic.TimeOfDayPrecision precision) Get the simulation current time of day to a given precision.
boolean	modelIsInitialising() Determine if model is initialising or not.
void	onCreate() AnyLogic hook point (prior to startup logic).
void	onDestroy() AnyLogic hook point at model destruction.
void	runEndProcessing() Any processing required at run-end (cf.
void	runSpecificEnvironmentSetup() Default run-specific environment setup to do nothing.

Methods inherited from class com.anylogic.engine.Agent

_initGetEngine_xjal, addAgentToContents, addEntityToContents, addExt_xjal, agentInfo, agents, agentsInRange, agentsInRange, agentsInRange, agentsInRange, applyLayout, applyNetwork, applyNetwork, areStepsEnabled, assignInitialConditions_xjal, connectTo, contents, create, createAndStart, currentBlock, deleteSelf, deliver, deliver, deliverToAllAgentsInside, deliverToAllConnected, deliverToAllNeighbors, deliverToRandomAgentInside, deliverToRandomConnected, deliverToRandomNeighbor, disableSteps, disconnectFrom, disconnectFromAll, distanceByRoute, distanceTo, distanceTo, distanceTo, distanceTo, distanceTo, distanceTo, distanceTo, distanceTo, doCreate, doFinish, doStart, drawActionChart, drawActionChartLink, drawAuxiliaryVariable, drawBranchExit, drawBranchState, drawBreakBlock, drawCausalLoop, drawCodeBlock, drawConnector, drawDecisionBlock, drawDynamicEvent, drawEmbeddedObjectModel, drawEmbeddedObjectModel, drawEmbeddedObjectModelDefault, drawEmbeddedObjectModelDefault, drawEnvironment, drawEvent, drawFinalState, drawFlow, drawHistoryState, drawInitialStatePointer, drawLink, drawLink, drawLinksToAgents, drawLinkToAgent, drawLinkToAgent, drawLinkToContainer, drawLocalVariable, drawLoopArea, drawLoopBlock, drawOutput, drawParameter, drawPort, drawReturnBlock, drawSchedule, drawState, drawStatechartEntryPoint, drawStock, drawTransition, enableSteps, error, errorInModel, evaluateRateOf, evaluateRateOf, evaluateTimeoutOf, evaluateTimeoutOf, executeActionOf, executeActionOf, executeActionOf, executeActionOf, executeActionOf, executeActionOf, executeActionOf, executeActionOf, executeActionOf, executeOnReceiveActionOf, executeOnSendActionOf, ext, finishSimulation, formulasExecute_xjal, getAgentAtCell, getAgentNextToMe, getAgentSpaceType, getAgentTypeId, getAnimationSettingsOf, getAnimationSettingsOf, getBlockEnterTime, getC, getCameras3D, getColor, getConnectedAgent, getConnections, getConnectionsNumber, getContainerStateOf, getDefaultPopulation, getDifferentialFlatEquationsCount_xjal, getDynamicEvents, getEmbeddedObjects, getEngine, getEnvironment, getEnvironmentSpaceType, getFirstOccurrenceTime, getFlowchartEntryTime, getFullName, getGISHeading, getGISMap, getGrounds, getId, getIndex, getInitialAlgebraicFlatEquationsCount_xjal, getInitialFormulaFlatEquationsCount_xjal, getIntegrationManager_xjal, getLat, getLatitude, getLayoutType, getLength, getLength, getLinkToAgentStandard_xjal, getLon, getLongitude, getModeOf, getName, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOf, getNameOfState, getNearestAgent, getNearestAgentByRoute, getNeighbors, getNetwork, getNetworkConnectionRange, getNetworkConnectionsPerAgent, getNetworkNeighborLinkProbability, getNetworkNode, getNetworks, getNetworkScaleFreeM, getNetworkType, getOwner, getOwnerShape, getParameter, getParameterNames, getPersistentShape, getPhaseVector_xjal, getPhaseVectorForInitialConditions_xjal, getPopulation, getPosition, getPosition, getPresentation, getPresentationScaleOnOwnerSpace, getR, getRailwayNetworks, getRandomConnectedAgent, getReplicatedCollection, getReplicatedList, getRightPart_xjal, getRightPartForInitialConditions_xjal, getRoadNetworks, getRootAgent, getRotation, getRouteProvider, getRuntimeAlgebraicFlatEquationsCount_xjal, getRuntimeFormulaFlatEquationsCount_xjal, getScale, getSpace, getSpeed, getSpeed, getStatechartOf, getStatechartOf, getStatechartOf, getStatechartOf, getTargetLat, getTargetLon, getTargetX, getTargetY, getTargetZ, getVelocity, getVerticalRotation, getX, getXYZ, getXYZ, getY, getZ, goToPopulation, highlight, instantiateBaseStructure_xjal, inState, isAgent, isAutomaticHorizontalRotation, isAutomaticVerticalRotation, isConnectedTo, isEmbeddedAgentPresentationVisible, isEnvironment, isLoggingToDB, isLoggingToDB, isMoving, isNextCellInsideSpace, isPublicPresentationDefined, isReplicated, isSpacePositionSet_xjal, jumpTo, jumpTo, jumpTo, jumpTo, jumpTo, jumpTo, jumpToCell, jumpToRandomEmptyCell, logToDB, logToDBEnterState, logToDBExitState, markParametersAreSet, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToInTime, moveToNearestAgent, moveToNearestAgent, moveToNextCell, moveToStraight, moveToStraight, moveToStraight, moveToStraight, moveToStraightInTime, moveToStraightInTime, moveToStraightInTime, moveToStraightInTime, nothingChanged, onAfterStepEnvironment, onArrival, onBeforeCreate, onBeforeStep, onBeforeStepEnvironment, onChange, onEngineFinished, onEnterFlowchartBlock, onExitFlowchartBlock, onOwnerChanged_xjal, onReceive, onReleaseResource, onSeizeResource, onStartup, onStep, pauseSimulation, putPhaseVector_xjal, putPhaseVectorForInitialConditions_xjal, randomAgentInside, randomAgentInside, randomEmptyCell, randomPointOfSpace, receive, removeAgentFromContents, removeEntityFromContents, removeExt_xjal, removeFromFlowchart, resourceUnitOfPool, resourceUnits, resourceUnitsOfPool, resourceUnitsOfSeize, restoreCollection_xjal, restoreConnections_xjal, restoreOwner, runSimulation, send, send, sendToAll, sendToAllConnected, sendToAllNeighbors, sendToRandom, sendToRandomConnected, sendToRandomNeighbor, setAgentSpaceType, setAutomaticHorizontalRotation, setAutomaticVerticalRotation, setCell, setColor, setDestroyed, setEngine, setEnvironment, setId, setLatLon, setLayoutType, setLength, setLength, setLocation, setLocation, setLocation, setLocation, setNetwork, setNetworkAllInRange, setNetworkNode, setNetworkNode, setNetworkNode, setNetworkRandom, setNetworkRingLattice, setNetworkScaleFree, setNetworkSmallWorld, setNetworkUserDefined, setOwnerShape_xjal, setParameter, setParametersToDefaultValues, setPosition, setRotation, setRouteProvider, setSpace, setSpeed, setSpeed, setupExt_xjal, setupInitialConditions_xjal, setupSpace, setupSpace, setupSpace, setupSpace, setVelocity, setVerticalRotation, setXY, setXYZ, setXYZ, spaceCellHeight, spaceCellWidth, spaceColumns, spaceHeight, spaceRows, spaceWidth, spaceZHeight, start, stateContainsState, stop, stopSimulation, swapWithAgent, swapWithCell, swapWithNextCell, testConditionOf, testConditionOf, testGuardOf, testGuardOf, testGuardOf, testGuardOf, testMessageOf, timeToArrival, timeToArrival, toLengthUnits, toPixels, toString, tryExt

Methods inherited from class com.anylogic.engine.Utilities

addToDate, addToDate, bernoulli, bernoulli, beta, beta, beta, beta, beta, binomial, binomial, binomial, binomial, binomial, briefInfoOn, castNumberTypes, castTypes, castTypesBack, cauchy, cauchy, cauchy, chi2, chi2, chi2, copyToClipboard, copyToClipboard, copyToClipboard, createTableElementDatabaseBuilder, createTrajectoryGIS, createURL_xjal, date, dateToTime, day, deleteFrom, difference, difference, differenceInCalendarUnits, differenceInCalendarUnits, differenceInDateUnits, differenceInDateUnits, differenceInDateUnits, differenceInDateUnits, dirToAngle, dropTime, erlang, erlang, erlang, error, error, error, errorInModel, errorInModel, errorInModel, executeAction, executeExpression, executeExpression, executeStatement, exponential, exponential, exponential, exponential, exponential, exponential, findExistingFile, format, format, format, format, format, format, format, formatAmountUnits, formatDayOfWeek, formatFlowRateUnits, formatGeoHeading, formatLatitude, formatLengthUnits, formatLengthUnits, formatLongitude, formatMonth, formatSpeedUnits, formatTimeInterval, gamma_frac, gamma, gamma, gamma, gamma, gamma, gammaLog, geometric, geometric, getAmPm, getAmPm, getCanonicalPath, getDatabaseConnection, getDateWithTimeNextTo, getDayOfMonth, getDayOfMonth, getDayOfWeek, getDayOfWeek, getDayOfYear, getDefaultRandomGenerator, getDistance, getDistance, getDistanceFromPointToLine, getDistanceFromPointToLineSq, getDistanceFromPointToSegment, getDistanceFromPointToSegment, getDistanceFromPointToSegmentSq, getDistanceFromPointToSegmentSq, getDistanceGIS, getDistanceGIS, getDistanceSq, getDistanceSq, getFullName, getHour, getHour, getHourOfDay, getHourOfDay, getLength, getLength, getLengthSq, getLengthSq, getMillisecond, getMillisecond, getMinute, getMinute, getMonth, getMonth, getName, getNearestPointOnSegment, getNearestPointOnSegment, getPerformanceParallelWorkersCount_xjal, getRandom, getRandom, getResult, getSecond, getSecond, getTime, getTimeoutToNextTime, getYear, getYear, gumbel1, gumbel1, gumbel2, gumbel2, hour, hypergeometric, hypergeometric, initializeRadians, insertInto, inspectOf, inspectOfLink_xjal, isFinite, isLineIntersectingLine, isLineIntersectingRectangle, isLoggingClassToDB, isPointInsideRay, isPointInsideRectangle, isPointInsideSegment, isPointOnTheSameLine, isRayIntersectingSegment, joinArrays_xjal, laplace, laplace, layoutTypeToString, limit, limit, limitMax, limitMax, limitMin, limitMin, logarithmic, logarithmic, logistic, logistic, lognormal, lognormal, logToDB, logToDB, logToDB, logToDB, millisecond, minute, month, negativeBinomial, negativeBinomial, negativeBinomial, negativeBinomial, normal, normal, normal, normal, normal, normal, pareto, pareto, pareto, pert, pert, poisson, poisson, poisson, poisson, prepareBeforeExperimentStart_xjal, prepareStatement, pulse, pulseTrain, quantum, ramp, random, randomColor, randomFalse, randomFalse, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomlyCreate, randomlyCreate, randomlyCreate, randomlyCreate, randomTrue, randomTrue, randomWhere, randomWhere, randomWhere, randomWhere, rayleigh, rayleigh, rayleigh, roundToDecimal, roundToInt, second, selectAndDoForEach, selectArrayOfDouble, selectArrayOfInt, selectExists, selectExists, selectFirstValue, selectFirstValue, selectFirstValue, selectFirstValue, selectFrom, selectResultSet, selectTableFunction, selectUniqueValue, selectUniqueValue, selectUniqueValue, selectUniqueValue, selectValues, selectValues, setDefaultRandomGenerator, shuffle, sqlGetObject, sqlGetObject, sqlGetObject, sqlGetObject, sqlSetObject, sqr, step, time, time, timeToDate, toDate, toDateInMillis, toLatitude, toLongitude, toModelRate, toModelTime, toRateUnits, toStringAlignedNameValues, toTimeout, toTimeout, toTimeoutInCalendar, toTimeUnits, trace, trace, traceln, traceln, traceln, traceToDB, traceToDB, triangular, triangular, triangular, triangular, triangular, triangularAV, triangularAV, uniform_discr, uniform_discr, uniform_discr, uniform_pos, uniform_pos, uniform, uniform, uniform, uniform, uniform, update, week, weibull, weibull, weibull, weibull, weibull, xidz, year, zidz

Methods inherited from class com.anylogic.engine.Presentable

checkNameOfShape_xjal, contains, createElementDescriptors, drawCollection, drawCustomDistribution, drawDatabase, drawDataset, drawExcelFile, drawFunction, drawHistogram2DData, drawHistogramData, drawInsert, drawKeyValueTable, drawModel, drawModelElements, drawModelElements, drawPlainVariable, drawPresentation, drawQuery, drawRouteProvider, drawShape, drawStatistics, drawTableFunction, drawTextFile, drawTrafficLight, drawUpdate, executeShapeControlAction, executeShapeControlAction, executeShapeControlAction, executeShapeControlAction, executeShapeControlAction, executeShapeControlAction, getElementDesciptors, getElementProperty, getExperiment, getModelElementsShape, getNameOfShape_xjal, getNameOfShape, getPresentationShape, getShapeArcAngle, getShapeArcAngle, getShapeArcStartAngle, getShapeArcStartAngle, getShapeCADCustomLayerColors, getShapeCADDrawingAttributes, getShapeCADDrawingAttributes, getShapeCADFileName, getShapeCADFileName, getShapeCADVisibleLayerNames, getShapeChartColorFromDouble, getShapeChartDataColors, getShapeChartDataItems, getShapeChartDataPlotOptions, getShapeChartDataSets, getShapeChartDataTitles, getShapeChartHistogram2DOptions, getShapeChartHistogramOptions, getShapeChartHistograms, getShapeChartHistograms2D, getShapeChartProperties, getShapeControl, getShapeControl, getShapeControlDefaultValueBoolean, getShapeControlDefaultValueBoolean, getShapeControlDefaultValueDouble, getShapeControlDefaultValueDouble, getShapeControlDefaultValueInt, getShapeControlDefaultValueInt, getShapeControlDefaultValueString, getShapeControlDefaultValueString, getShapeControlManager, getShapeControlMaximum, getShapeControlMaximum, getShapeControlMinimum, getShapeControlMinimum, getShapeControlMultipleSelectionMode, getShapeControlMultipleSelectionMode, getShapeControlProgressString, getShapeControlProgressString, getShapeControlTexts, getShapeControlTexts, getShapeControlTexts2D, getShapeControlTexts2D, getShapeControlValueType, getShapeControlValueType, getShapeEmbeddedObject, getShapeEmbeddedObject, getShapeFileChooserType, getShapeFileChooserType, getShapeFillColor, getShapeFillColor, getShapeFont, getShapeFont, getShapeGroupContent, getShapeHeight, getShapeHeight, getShapeImageFileNames, getShapeImageFileNames, getShapeImageNumber, getShapeImageNumber, getShapeLineColor, getShapeLineColor, getShapeLineDx, getShapeLineDx, getShapeLineDy, getShapeLineDy, getShapeLineStyle, getShapeLineStyle, getShapeLineWidth, getShapeLineWidth, getShapeNPoints, getShapeNPoints, getShapePackagePrefix, getShapePointsDx, getShapePointsDx, getShapePointsDy, getShapePointsDy, getShapeRadiusX, getShapeRadiusX, getShapeRadiusY, getShapeRadiusY, getShapeReplication, getShapeRotation, getShapeRotation, getShapeScaleX, getShapeScaleX, getShapeScaleY, getShapeScaleY, getShapeText, getShapeText, getShapeTextAlignment, getShapeTextAlignment, getShapeType, getShapeWidth, getShapeWidth, getShapeX, getShapeX, getShapeY, getShapeY, getViewAreas, iconContains, isShapeAgentDrawnWithOffset, isShapeClosed, isShapeClosed, isShapeControlEditable, isShapeControlEditable, isShapeControlEnabled, isShapeControlEnabled, isShapeControlVertical, isShapeControlVertical, isShapePublic, isShapeVisible, isShapeWithManualControlPoints, isShapeWithManualControlPoints, modelElementContains, modelElementContains, onClickIconAt, onClickModelAt, onClickModelAt, onClickPresentationAt, onItemRemoved_xjal, onSelectionChanged_xjal, onShapeClick, onShapeClickAt, onShapeGroupDraw, presentationContains, readCustomData, setControlValueToDefault, setControlValueToDefault, updateShapeDynamicProperties, updateShapeDynamicProperties, writeCustomData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MainModel_AnyLogic

public MainModel_AnyLogic(com.anylogic.engine.Engine engine,
                          com.anylogic.engine.Agent owner,
                          com.anylogic.engine.AgentList<? extends MainModel_AnyLogic> collection)

Constructor with required signature for an Agent (undocumented by AnyLogic). Not intended for user usage.

Parameters:

engine - As required by AnyLogic.

owner - As required by AnyLogic.

collection - As required by AnyLogic.

Since:

0.1

MainModel_AnyLogic

public MainModel_AnyLogic()

Simple constructor as now included in all AnyLogic 7 generated Agent code. This is never actually invoked.

Since:

0.1

Method Detail

getMainFor

public static MainModel_AnyLogic getMainFor(com.anylogic.engine.Agent agent)

Get the (closest composing) MainModel_AnyLogic 'main' model instance for the Agent in question. Useful for JSIT users to get access to the MainModel_AnyLogic instance (and, from there, the model initialiser).

Parameters:

agent - The Agent in question.

Returns:

The closest composing MainModel_AnyLogic instance (which could be itself).

Since:

0.2

runEndProcessing

public void runEndProcessing()

Any processing required at run-end (cf. model destruction time). This does nothing, but subclasses should override this if required. It ensures that any main Agent always has such a method so that models with multiple layered main Agents can chain run-end processing.

A standard case is where one main represents the core domain model (runnable on its own) but may be composed by another main which includes metadata gathering (and could itself be composed by a third providing visualisation). The domain model main Agent accepts run-end criteria (i.e., stopping when a certain state is reached), which include a reference to the top-level main (as a MainModel_AnyLogic instance), which is null if the domain model main is not composed by anything for this run, and is available to the Experiment via the root reference. When the stop criteria are reached this can call runEndProcessing on this top-level main which will chain down the runEndProcessing for all composed instances (running the composed main run-end processing before performing their own).

A concrete example of where this is useful is where (a) the domain model main ensures some model state is finalised (say doing some final updates to state that is normally varied at regular intervals); (b) a composing meta-data-gathering main ensures that its statistics include the final state values (where they may otherwise have been gathered at regular intervals).

NB: This was made non-abstract (and here rather than in MainModel) so that existing models remain backwards-compatible. This will probably be moved to MainModel in future.

Since:

0.2

onCreate

public void onCreate()

AnyLogic hook point (prior to startup logic). Generic point at which to save model settings and finalise stochasticity controls since this is after parameters have been given their values, but before normal user-facing startup logic.

Overrides:

onCreate in class com.anylogic.engine.Agent

Since:

0.1

onDestroy

public void onDestroy()

AnyLogic hook point at model destruction. Clears up the model initialiser.

Overrides:

onDestroy in class com.anylogic.engine.Agent

Since:

0.1

getInputsBasePath

public java.lang.String getInputsBasePath()

Default inputs base path; user should override in their subclass to change this. AnyLogic sets the working directory as the directory of the .alp file that the Experiment is in.

Specified by:

getInputsBasePath in interface MainModel

Returns:

The relative path to the inputs folder (as a String).

Since:

0.1

getOutputsBasePath

public java.lang.String getOutputsBasePath()

Default outputs base path; user should override in their subclass to change this. AnyLogic sets the working directory as the directory of the .alp file that the Experiment is in.

Specified by:

getOutputsBasePath in interface MainModel

Returns:

The relative path to the outputs folder (as a String).

Since:

0.1

getDiagnosticLogFormattedSimTime

public java.lang.String getDiagnosticLogFormattedSimTime()

Default diagnostic log sim time formatting (as raw time to 0 d.p. + day + HH:MM). The modeller should override this method (using the helper methods to compose constituent parts) for their own formatting. This default implementation is as below:

 if (modelIsInitialising()) {
     return "MODEL INIT";
 }
 else {
     return getSimRawTime(0) + " " + getSimDay() + " "
              + getSimTimeOfDay(TimeOfDayPrecision.MINS);
 }
 

Specified by:

getDiagnosticLogFormattedSimTime in interface MainModel

Returns:

The formatted simulation time (as a String).

Since:

0.1

getEventsLogFormattedSimTime

public java.lang.String getEventsLogFormattedSimTime()

Default events log sim time formatting (as day + HH:MM). The modeller should override this method (using the helper methods to compose constituent parts) for their own formatting. This default implementation is as below:

 if (modelIsInitialising()) {
     return "MODEL INIT";
 }
 else {
     return getSimDay() + " " + getSimTimeOfDay(TimeOfDayPrecision.MINS);
 }
 

Specified by:

getEventsLogFormattedSimTime in interface MainModel

Returns:

The formatted simulation time (as a String).

Since:

0.1

runSpecificEnvironmentSetup

public void runSpecificEnvironmentSetup()

Default run-specific environment setup to do nothing. Override this in your user-written subclass to perform any environment setup that you want to be performed at this very early JSIT-initialisation stage (after all JSIT initialisation is complete).

Specified by:

runSpecificEnvironmentSetup in interface MainModel

Since:

0.1

doAllStaticStochRegistration

public abstract void doAllStaticStochRegistration()

Any static-level stochastic item registration needs to be specified by the user subclass. (We could provide a default 'do nothing' implementation here so that AnyLogic modellers need only code an overriding method (AnyLogic function) if they are using stochastic control and need to do static registration. However, this is a common need and it is easy for modellers to forget to include this function, so we force it to be needed by making it abstract.)

Specified by:

doAllStaticStochRegistration in interface MainModel

Since:

0.1

doAllStaticPerRunLoggerSetup

public abstract void doAllStaticPerRunLoggerSetup()

Any static-level AnyLogic logger setup needs specifying in the user subclass.

Since:

0.2

modelIsInitialising

public boolean modelIsInitialising()

Determine if model is initialising or not.

Returns:

True if model is running.

Since:

0.1

getModelInitialiser

public ModelInitialiser getModelInitialiser()

Method so that model objects can get the singleton model initialiser (especially so as to obtain the run ID).

Returns:

The existing ModelInitialiser.

Since:

0.1

getSimRawTime

public java.lang.String getSimRawTime(int rawTimeDecimalPlaces)

Get the 'raw' AnyLogic simulation time, rounded down to a given number of decimal places (so that it always represents the 'time slot' of the logged event; e.g., something at sim time 100.89 is operating in '0 decimal places time slot' 100.

Parameters:

rawTimeDecimalPlaces - The number of decimal places to round down to

Returns:

A String representation of the rounded raw time

Since:

0.1

getSimDay

public java.lang.String getSimDay()

Default current sim day AnyLogic implementation, calculating using time() and day(). User can override if they have a more efficient implementation (e.g., they were already storing a current day integer via a daily event).

Returns:

The current simulation day (starting at day 1; should never be called when model is initialising)

Since:

0.1

getSimTimeOfDay

public java.lang.String getSimTimeOfDay(MainModel_AnyLogic.TimeOfDayPrecision precision)

Get the simulation current time of day to a given precision. This should not be called during model initialisation (use modelIsInitialising() to check.)

Parameters:

precision - The enumeration value for the required precision

Returns:

A String-formatted time-of-day representation

Since:

0.1