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

    Show / Hide Table of Contents
    • Mars.Core
      • DependencyRegistrationCore
    • Mars.Core.Data
      • AbstractConfigLoader
      • AbstractEntityManager
      • AgentManagerImpl
      • DomainDataMediatorImpl
      • EntityManagerImpl
      • IAgentManager
      • IEntityManager
      • IEntityMapping
      • IGeneratedEntityLogger
      • IGeneratedLayerLogger
      • IGeneratedLogger<TModel>
      • IGeneratedTypeLogger
      • IModelCompiler
      • IOutputLogger
      • IPlatformSelector
      • ISchemaMigrationProvider
      • ISerializerManager
      • PlatformSelectorImpl
    • Mars.Core.Data.Compiler
      • AbstractEntityMapper
      • AbstractJitMapper
      • AbstractLayerMapper
      • AbstractMapper<TModel>
      • AbstractTypeMapper
      • RoslynCompilerUtils
    • Mars.Core.Data.Entities
      • CircleFilter
      • Condition
      • ConjunctiveWhere
      • DataFrame
      • DisjunctiveWhere
      • EqualityCondition
      • IntersectionFilter
      • ISelection
      • NearestFilter
      • Query
      • WindowFilter
      • WithinFilter
    • Mars.Core.Data.Exceptions
      • AgentInitializationException
    • Mars.Core.Data.Mapping
      • DefaultSourceProvider
      • ReflectiveMapping
    • Mars.Core.Data.Wrapper
      • AbstractOperationWrapper
      • AbstractWrapper
      • AbstractWrapper<TOptions>
      • GlobalRestrictions
      • ICircleQueryOperation
      • IIntersectionOperation
      • ILookupOperation
      • INearestOperation
      • IOperation
      • IPlatform
      • IQueryOperation
      • ISnapshot
      • IWindowQueryOperation
      • IWithinOperation
      • IWrapper
      • KnnGraphWrapper
      • PostGisWrapper
    • Mars.Core.Data.Wrapper.Document
      • IMongoConnection
      • IMongoWrapper
      • MongoDbIteratorHelper
      • MongoDbWrapper
    • Mars.Core.Data.Wrapper.File
      • AbstractFileWrapper<TOptions>
      • AscWrapper
      • GeoJsonWrapper
    • Mars.Core.Data.Wrapper.Memory
      • DataTableWrapper
      • GeoHashTrieWrapper
      • KdTreeWrapper
      • TripPosition
      • TripPositionCoordinateConverter
      • TripsCollection
      • TripsLineConverter
      • TripsTrajectoryWrapper
    • Mars.Core.Data.Wrapper.Relational
      • AbstractRelationalConnection
      • PostgresSqlDbConnection
      • PostgresSqlWrapper
      • RelationalMapperException
      • RelationalSqlWrapper<TOptions>
      • SqliteDbConnection
      • SqliteWrapper
    • Mars.Core.Data.Wrapper.Stream
      • MqttWrapper
      • SimulationTypeInfo
    • Mars.Core.Executor
      • IRuntimeModel
      • ISimulationProgress
      • IStepExecutor
    • Mars.Core.Executor.Entities
      • Parametrization
      • StepParam
    • Mars.Core.Executor.Implementation
      • RuntimeModelImpl
      • SimulationProgressImpl
      • StepExecutionUseCase
    • Mars.Core.Model
      • IConfigLoader
      • IModelContainer
      • IModelResolver
    • Mars.Core.Model.Entities
      • LayerInstanceContainer
    • Mars.Core.Model.Exceptions
      • InvalidMappingException
      • MissingConstructorException
      • ModelResolutionException
      • ValidationException
    • Mars.Core.Model.Implementation
      • DependencyBuilder
      • MappingHelper
      • ModelContainer
      • ValidationIssueLevel
      • ValidationResult
      • Validator
    • Mars.Core.Simulation
      • ISimulation
      • ISimulationControl
    • Mars.Core.Simulation.Entities
      • SimulationRestartArgs
      • SimulationWorkflowState

    Interface IGeneratedTypeLogger

    Result output interface describing result methods for a specific agent type.
    Inherited Members
    IOutputLogger.ProxyKey
    IOutputLogger.Type
    IOutputLogger.TypeLogger
    IOutputLogger.Mapping
    IOutputLogger.OutputFrequency
    IOutputLogger.OutputTicks
    IOutputLogger.HasOutputProperties
    IOutputLogger.Context
    IOutputLogger.ConfigLoader
    IOutputLogger.Culture
    IOutputLogger.Initialize()
    Namespace: Mars.Core.Data
    Assembly: Mars.Core.dll
    Syntax
    public interface IGeneratedTypeLogger : IOutputLogger

    Properties

    Entities

    Gets all registered entities of this type manager.
    Declaration
    IEnumerable<IEntity> Entities { get; }
    Property Value
    Type Description
    IEnumerable<IEntity>

    EntityProxies

    Gets all registered entity proxies which are responsible for each de/serialization process
    Declaration
    IEnumerable<IGeneratedEntityLogger> EntityProxies { get; }
    Property Value
    Type Description
    IEnumerable<IGeneratedEntityLogger>

    KeyContainer

    Gets or sets the index container used to assign unique keys to all new proxies, constructed by CreateIndividualLogger(IEntity).
    Declaration
    KeyContainer KeyContainer { get; set; }
    Property Value
    Type Description
    KeyContainer

    Methods

    CreateIndividualLogger(IEntity)

    Creates an individual proxy for the specified entity with the associated type of this mapper..
    Declaration
    IGeneratedEntityLogger CreateIndividualLogger(IEntity entity)
    Parameters
    Type Name Description
    IEntity entity The entity to register
    Returns
    Type Description
    IGeneratedEntityLogger Returns a new instanceof of the IGeneratedEntityLogger serializer with type-specific serialization functions.
    Remarks
    This method is similar to the usage of CreateIndividualLogger(IEntity) which corresponds to the constructor call.

    CreateInstance()

    Creates a concrete instance from the managed type in this proxy without using any reflection call.
    Declaration
    IEntity CreateInstance()
    Returns
    Type Description
    IEntity Returns an instance of the entity when created, or null if creation was not possible, since missing dependencies

    DeregisterIndividual(IEntity)

    DeRegisters the specified entity from this type manager proxy so that no in/output is created more.
    Declaration
    void DeregisterIndividual(IEntity entity)
    Parameters
    Type Name Description
    IEntity entity The to deregister from the in/output pipeline.

    IsTypeOf(IEntity)

    Provides an instance of mechanism which can be used without any reflection.
    Declaration
    bool IsTypeOf(IEntity entity)
    Parameters
    Type Name Description
    IEntity entity The entity to check whether the associated type is the class for this instance.
    Returns
    Type Description
    System.Boolean Returns true when the specified entity is an instance of this associated type.
    Remarks
    This method is similar to the usage of CreateIndividualLogger(IEntity) which corresponds to the constructor call.

    RegisterIndividual(IGeneratedEntityLogger, TypeMapping)

    Registers the specified individual at this type manager proxy with the passed outputGroup with the associated type of this mapper.
    Declaration
    void RegisterIndividual(IGeneratedEntityLogger individual, TypeMapping mapping = null)
    Parameters
    Type Name Description
    IGeneratedEntityLogger individual The IGeneratedEntityLogger proxy wrapping an entity.
    TypeMapping mapping The type-specific mapping configuration for this instance.

    SerializeToFrames()

    Serialize all registered entities lazy and converts them into a managed DataFrame. Optional selection or transformations can be appended and will evaluated lazy.
    Declaration
    IEnumerable<DataFrame> SerializeToFrames()
    Returns
    Type Description
    IEnumerable<DataFrame> Returns an collection of managed agent frame.
    Back to top Copyright © MARS GROUP.
    HAW Hamburg