• Documentation
  • Core API
  • SmartOpenHamburg API
  • Model Components API
  • Common API

    Show / Hide Table of Contents
    • Mars.Components
      • DependencyRegistrationModelling
    • Mars.Components.Agents
      • AbstractAgent
      • AbstractEntity
      • Agent
    • Mars.Components.Environments
      • AbstractEnvironment
      • AbstractGraphElement
      • AlwaysPassingNodeGuard
      • EntityLane<TEntity>
      • GeoEnvironment
      • GeoHashEnvironment<T>
      • IEnvironmentMediator
      • IModalChoiceResolver
      • PathHeuristics
      • SpatialEdge
      • SpatialGraphEntityExtensions
      • SpatialGraphEnvironment
      • SpatialGraphHelper
      • SpatialHashEnvironment<TEntity>
      • SpatialNode
      • WorldIndexExtensions
    • Mars.Components.Environments.Cartesian
      • CartesianEnvironment<TEntity>
      • CollisionEnvironment<TCharacter, TObstacle>
      • CollisionKind
      • ConeExplorationView
      • ExplorationView
      • GeometryFactory
      • ICartesianEnvironment<TEntity>
      • ICharacter
      • ICollidable
      • ICollisionEnvironment<TCharacter, TObstacle>
      • IObstacle
      • IVisible
      • RayExplorationView
      • TrapezoidExploration
      • VisibilityKind
    • Mars.Components.Environments.Cartesian.Routing
      • CartesianRoutingService<TObstacle>
      • GeometryCoordinatesRoutingPointsGenerator
      • HomogenousRoutingPointsGenerator
      • IRoutingPointsGenerator
      • RandomRoutingPointsGenerator
      • SectionalRandomRoutingPointsGenerator
    • Mars.Components.Layers
      • AbstractActiveLayer
      • AbstractEnvelopedLayer
      • AbstractLayer
      • AbstractVectorFeature
      • AgentSchedulerLayer<TAgent, TLayer>
      • QuerySourceLoader
      • RasterLayer
      • SchedulerEntry
      • SchedulerLayer
      • VectorFeature
      • VectorLayer
      • VectorLayer<T>
      • VectorLayerHelper
    • Mars.Components.Layers.Temporal
      • IQueryFieldProvider
      • ITemporalObjectCatalog
      • ITemporalObjectIterator
      • TemporalCatalogFeature<TKey>
      • TemporalFeatureKind
      • TemporalMetadataLoader
    • Mars.Components.Services
      • AgentManager
    • Mars.Components.Services.Explorations
      • BoltzmannExploration
      • EpsilonGreedyExploration
      • IExplorationPolicy
      • RouletteWheelExploration
      • TabuSearchExploration
    • Mars.Components.Services.Learning
      • InfiniteQLearning
      • QLearning
      • Sarsa
    • Mars.Components.Services.Planning
      • ActionPlanResult
      • GoapAction
      • GoapAgentStates
      • GoapGoal
      • GoapPlanner
      • GoapStateKey<T>
      • GoapStateProperty
      • GoapStateProperty<TElement>
      • IGoapAction
      • IGoapAgentStates
      • IGoapGoal
      • IGoapPlanner
      • IGoapStateKey
      • StatesCommons
    • Mars.Components.Services.Planning.ActionCommons
      • AllGoalsSatisfiedAction
      • NoGoalReachableAction
    • Mars.Components.Starter
      • Command
      • CommandArgumentContainer
      • CommandParser
      • CommandSet
      • HelpCommand
      • Option
      • OptionContext
      • OptionException
      • OptionSet
      • OptionValueCollection
      • OptionValueType
      • SimulationStarter
    • Mars.Components.Starter.Exceptions
      • SimulationStartupException
    • Mars.Interfaces
      • IModelObject
      • ISimulationContainer
      • ISimulationContext
      • ISimulationModule
      • ISimulationState
      • IStepExecutionContext
      • SimulationContext
      • SimulationContext.WorkflowStateType
    • Mars.Interfaces.Agents
      • IAgent
      • IAgent<TLayer>
      • IEntity
      • IMarsDslAgent
      • IModalCapabilitiesAgent
      • ISpatialGraphEntity
      • ITickClient
    • Mars.Interfaces.Annotations
      • ActiveConstructor
      • PropertyDescription
    • Mars.Interfaces.Data
      • AbstractDomainData
      • GeometryData
      • IDomainData
      • IGeometryData
      • IIdentifiableData
      • IMarsFeature
      • IRasterBandData
      • ISource
      • IStringData
      • IStringStructuredData
      • IStructuredData
      • IStructuredDataGeometry
      • IValueData
      • LayerInitData
      • RasterBandData
      • StringDataDto
      • StructuredData
      • VectorStructuredData
    • Mars.Interfaces.Environments
      • BoundingBox
      • DirectionType
      • EdgeExploreResult
      • EdgeStop
      • ExploreDirection
      • GeoPositionExtension
      • HighwayType
      • IEdge<TEdge, TNode>
      • IEntityLane<TEntity>
      • IEnvironment
      • IEnvironment<TEntity>
      • IGeoGridEnvironment<T>
      • IGraphEntity
      • IGraphEnvironment<TEdge, TNode>
      • INode<TEdge, TNode>
      • INodeGuard
      • IPositionable
      • IRoutePlanner
      • ISpatialEdge
      • ISpatialGraphEnvironment
      • ISpatialLane
      • ISpatialNode
      • LaneExploreResult
      • ModalChoice
      • MultimodalRoute
      • NodeIntegrationKind
      • Position
      • Route
      • RouteStop
      • Size
      • SpatialGraphExploreResult
      • SpatialModalityType
      • TrafficLightPhase
    • Mars.Interfaces.Layers
      • FinallySimulationStep
      • IChangingLayer
      • IDataContainer
      • IDataLayer
      • IDataSet
      • IEnvelopDataLayer
      • ILayer
      • IMarsDslLayer
      • IModalChoiceConsumer
      • InitSimulationStep
      • INotifyChangedSource<T>
      • IRaster<TValue>
      • IRasterLayer
      • ISteppedActiveLayer
      • IVectorFeature
      • IVectorLayer
      • IVectorLayer<T>
      • IVectorNode<TEntity>
      • RegisterAgent
      • UnregisterAgent
    • Mars.Interfaces.Model
      • ActiveTypeMapping
      • AgentMapping
      • AgentType
      • ConstructorType
      • ContainsOperator
      • DataContainer
      • DataType
      • EntityMapping
      • EntityType
      • Execution
      • FeatureType
      • Globals
      • IdentifiableElement
      • IndividualMapping
      • Input
      • InputConfiguration
      • LayerMapping
      • LayerType
      • ModelDescription
      • ModelElement
      • ObjectType
      • Output
      • OutputConfiguration
      • OutputFilter
      • OutputKind
      • OutputTargetType
      • ParameterMapping
      • Processing
      • ProcessingConfiguration
      • ProcessingTargetType
      • PropertyType
      • SimulationConfig
      • TimeSpanUnit
      • TimeSpanUnitExtensions
      • TypeElement
      • TypeMapping
    • Mars.Interfaces.Model.Converters
      • CultureConverter
      • SerializationTypeConverter
      • TimeSpanUnitConverter
    • Mars.Interfaces.Model.Exceptions
      • InvalidTypeException
      • MissingTypeException
    • Mars.Interfaces.Model.Options
      • AbstractEndpointOptions
      • AbstractFileOptions
      • AbstractOptions
      • AscOptions
      • CsvOptions
      • GeoJsonOptions
      • MongoOptions
      • MqttOptions
      • PostgresSqlOptions
      • RedisOptions
      • RelationalEndpointOptions
      • SerializationType
      • SocketOutputOptions
      • SpatialGraphOptions
      • SqLiteOptions
      • TripsOptions

    Class TypeMapping

    The mapping for a whole type to initialize an agent or layer via an input file or through a known metadata id. Can be associated with an individual IndividualMapping to fine grained match the parameters to inputs
    Inheritance
    System.Object
    IdentifiableElement
    TypeMapping
    ActiveTypeMapping
    EntityMapping
    Inherited Members
    IdentifiableElement.Id
    IdentifiableElement.Name
    IdentifiableElement.Equals(Object)
    IdentifiableElement.GetHashCode()
    Namespace: Mars.Interfaces.Model
    Assembly: Mars.Interfaces.dll
    Syntax
    public abstract class TypeMapping : IdentifiableElement

    Properties

    DataContainer

    The input data container with all possible input files.
    Declaration
    public IDataContainer DataContainer { get; set; }
    Property Value
    Type Description
    IDataContainer

    File

    The path to the input file for this model type
    Declaration
    public string File { get; set; }
    Property Value
    Type Description
    System.String

    IndividualMapping

    The mapping to match individual parameters to a specific input field or explicit value
    Declaration
    public List<IndividualMapping> IndividualMapping { get; set; }
    Property Value
    Type Description
    List<IndividualMapping>

    InputConfiguration

    Gets or sets the temporal input configurations used to separate input and select temporal reference fields, when input is changing over time.
    Declaration
    public InputConfiguration InputConfiguration { get; set; }
    Property Value
    Type Description
    InputConfiguration

    Inputs

    Gets all associated data sources to process this type
    Declaration
    public List<Input> Inputs { get; set; }
    Property Value
    Type Description
    List<Input>

    IsTemporalChanging

    Declaration
    public bool IsTemporalChanging { get; }
    Property Value
    Type Description
    System.Boolean

    LiveVisualization

    Declaration
    public bool? LiveVisualization { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>

    LiveVisualizationWithProperties

    Declaration
    public bool LiveVisualizationWithProperties { get; set; }
    Property Value
    Type Description
    System.Boolean

    ModelType

    The source model type to map
    Declaration
    public abstract TypeElement ModelType { get; }
    Property Value
    Type Description
    TypeElement

    OutputFilter

    Output filter predicates associated by an logical AND. When the agent matches all filter predicates then it will be persisted.
    Declaration
    public List<OutputFilter> OutputFilter { get; set; }
    Property Value
    Type Description
    List<OutputFilter>

    OutputFrequency

    The output frequency to specify how often the result data of this instances shall be write out. Default is 1.
    Declaration
    public int OutputFrequency { get; set; }
    Property Value
    Type Description
    System.Int32

    OutputKind

    Gets or sets the output kind, whether all full snapshot shall be created (including ignored or not), only deltas (if possible) or only when something has been changed.
    Declaration
    public OutputKind? OutputKind { get; set; }
    Property Value
    Type Description
    System.Nullable<OutputKind>

    Outputs

    Gets all associated data sources to process this type
    Declaration
    public List<Output> Outputs { get; set; }
    Property Value
    Type Description
    List<Output>

    OutputTarget

    Gets or sets the output target used for this type explicitly
    Declaration
    public OutputTargetType? OutputTarget { get; set; }
    Property Value
    Type Description
    System.Nullable<OutputTargetType>
    Remarks
    The output target specifies the concrete format of generated results of the simulation execution (e.g., table as csv or documents in mongo).

    OutputTicks

    The output ticks, when the result data of this instances shall be write out. Default is always (null).
    Declaration
    public HashSet<long> OutputTicks { get; set; }
    Property Value
    Type Description
    HashSet<System.Int64>

    ParameterMapping

    Declaration
    public IDictionary<string, IndividualMapping> ParameterMapping { get; }
    Property Value
    Type Description
    IDictionary<System.String, IndividualMapping>

    Processing

    Gets all processing source for the model runtime.
    Declaration
    public List<Processing> Processing { get; set; }
    Property Value
    Type Description
    List<Processing>

    Value

    Gets or sets a value e.g., geojson content assigned to this vector-layer
    Declaration
    public object Value { get; set; }
    Property Value
    Type Description
    System.Object
    Back to top Copyright © MARS GROUP.
    HAW Hamburg