package
0.0.0-20240807014722-b30759bf7f90
Repository: https://github.com/fullstack-lang/gongsim.git
Documentation: pkg.go.dev
# Functions
AfterCreateFromFront is called after a create from front.
AfterDeleteFromFront is called after a delete from front.
AfterReadFromFront is called after a Read from front.
AfterUpdateFromFront is called after a update from front.
Implements the interface function.
No description provided by the author
CopyBranch stages instance and apply CopyBranch on all gongstruct instances that are referenced by pointers or slices of pointers of the instance
the algorithm stops along the course of graph if a vertex is already staged.
insertion point for stage branch per struct.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EvictInOtherSlices allows for adherance between the gong association model and go.
GetAssociationName is a generic function that returns an instance of Type where each association is filled with an instance whose name is the name of the association
This function can be handy for generating navigation function that are refactorable.
GetFields return the array of the fields.
GetFieldsFromPointer return the array of the fields.
No description provided by the author
No description provided by the author
No description provided by the author
GetGongstructInstancesMap returns the map of staged GongstructType instances it is usefull because it allows refactoring of gong struct identifier.
GetGongstructInstancesSet returns the set staged GongstructType instances it is usefull because it allows refactoring of gongstruct identifier.
GetGongstructInstancesSetFromPointerType returns the set staged GongstructType instances it is usefull because it allows refactoring of gongstruct identifier.
GetGongstructName returns the name of the Gongstruct this can be usefull if one want program robust to refactoring.
GetPointerReverseMap allows backtrack navigation of any Start.Fieldname associations (0..1) that is a pointer from one staged Gongstruct (type Start) instances to another (type End)
The function provides a map with keys as instances of End and values to arrays of *Start the map is construed by iterating over all Start instances and populationg keys with End instances and values with slice of Start instances.
GetPointerToGongstructName returns the name of the Gongstruct this can be usefull if one want program robust to refactoring.
No description provided by the author
GetSliceOfPointersReverseMap allows backtrack navigation of any Start.Fieldname associations (0..N) between one staged Gongstruct instances and many others
The function provides a map with keys as instances of End and values to *Start instances the map is construed by iterating over all Start instances and populating keys with End instances and values with the Start instances.
GongGetMap returns the map of staged GongstructType instances it is usefull because it allows refactoring of gong struct identifier.
GongGetSet returns the set staged GongstructType instances it is usefull because it allows refactoring of gong struct identifier.
No description provided by the author
No description provided by the author
Min returns the larger of x or y.
No description provided by the author
No description provided by the author
ParseAstFile Parse pathToFile and stages all instances declared in the file.
ParseAstFile Parse pathToFile and stages all instances declared in the file.
ReplaceOldDeclarationsInFile replaces specific text in a file at the given path.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SetCallbackAfterUpdateFromFront is a function to set up callback that is robust to refactoring.
No description provided by the author
No description provided by the author
StageBranch stages instance and apply StageBranch on all gongstruct instances that are referenced by pointers or slices of pointers of the instance
the algorithm stops along the course of graph if a vertex is already staged.
UnmarshallGoStaging unmarshall a go assign statement.
UnstageBranch stages instance and apply UnstageBranch on all gongstruct instances that are referenced by pointers or slices of pointers of the insance
the algorithm stops along the course of graph if a vertex is already staged.
# Constants
iota.
No description provided by the author
values for ControlMode.
values for EnumType.
No description provided by the author
values for EnumType.
values for EnumType.
No description provided by the author
values for EnumType.
values for EnumType.
values for EnumType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
values for EngineState.
values for EngineState.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
iota.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Agent is the empty struct to perform generic agents chores.
No description provided by the author
insertion point.
Engine describes a tiny discrete event simulation engine it is responsible for advancing the time An engine manages a set of agents swagger:model Engine.
No description provided by the author
Event is the elementary element of a discrete event simulation swagger:model Event.
No description provided by the author
No description provided by the author
No description provided by the author
GongsimCommand is the struct of the instance that is updated by the front for issuing commands swagger:model GongsimCommand.
No description provided by the author
GongsimStatus is the struct of the instance that is updated by the front for issuing Statuss swagger:model GongsimStatus.
No description provided by the author
No description provided by the author
the simplest possible simulation.
StageStruct enables storage of staged instances swagger:ignore.
UpdateState is an event whose role is to ask the agant to compute its new vector state swagger:model UpdateState.
# Interfaces
AgentInterface is the interface that must be followed by part of the simulation swagger:model AgentInterface.
swagger:ignore.
No description provided by the author
No description provided by the author
EventInterface ..
Gongstruct is the type parameter for generated generic function that allows - access to staged instances - navigation between staged instances by going backward association links between gongstruct - full refactoring of Gongstruct identifiers / fields.
No description provided by the author
No description provided by the author
GongStructInterface is the interface met by GongStructs It allows runtime reflexion of instances (without the hassle of the "reflect" package).
No description provided by the author
No description provided by the author
No description provided by the author
OnAfterCreateInterface callback when an instance is updated from the front.
OnAfterDeleteInterface callback when an instance is updated from the front.
OnAfterReadInterface callback when an instance is updated from the front.
OnAfterUpdateInterface callback when an instance is updated from the front.
No description provided by the author
Gongstruct is the type parameter for generated generic function that allows - access to staged instances - navigation between staged instances by going backward association links between gongstruct - full refactoring of Gongstruct identifiers / fields.
No description provided by the author
No description provided by the author
SimulationInterface is the callback support for events that happens on the generic engine.
Tabulator is an interface for writing to a table strings.
# Type aliases
swagger:enum ControlMode.
the states of the engine drivers.
the simulation can run with a relative speed to realtime or full speed.
swagger:enum EngineState.
No description provided by the author
swagger:ignore.
swagger:enum GongsimCommandType.
swagger:enum GongsimCommandType.