Class AbstractWrapper
An abstract implementation of the IWrapper
keeping references to abstract output parameters valid for each output target.
When a new output target shall be implemented this class have to be inherited.
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Mars.Core.Data.Wrapper
Assembly: Mars.Core.dll
Syntax
public abstract class AbstractWrapper : AbstractConfigLoader, IWrapper, IDisposable
Constructors
| Improve this Doc View SourceAbstractWrapper(IConfigLoader, ISerializerManager)
Creates a new instance of ths AbstractWrapper<TOptions>, implementing
the IWrapper contract.
Declaration
protected AbstractWrapper(IConfigLoader config, ISerializerManager serializer)
Parameters
Type | Name | Description |
---|---|---|
IConfigLoader | config | The result adapter root inputConfiguration object. |
ISerializerManager | serializer | The serializer endpoint to access the model without any reflection. |
Fields
| Improve this Doc View SourceFrameSelector
The static frame selector for all default serialization cases.
Declaration
protected static readonly Func<IGeneratedEntityLogger, DataFrame> FrameSelector
Field Value
Type | Description |
---|---|
System.Func<IGeneratedEntityLogger, DataFrame> |
Properties
| Improve this Doc View SourceIsInitialized
Gets the flag indicating that the Setup() was already been performed.
Declaration
public bool IsInitialized { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Serializer
Gets or sets the serializer endpoint to access the I/O proxies of each entity type.
Declaration
public ISerializerManager Serializer { get; }
Property Value
Type | Description |
---|---|
ISerializerManager |
Methods
| Improve this Doc View SourceMigrateSchema(IGeneratedLayerLogger)
Applies a schema migration when the mapper requires that.
Declaration
public virtual void MigrateSchema(IGeneratedLayerLogger logger)
Parameters
Type | Name | Description |
---|---|---|
IGeneratedLayerLogger | logger | The encapsulated layer. |
MigrateSchema(IGeneratedTypeLogger)
Applies a schema migration when the mapper requires that.
Declaration
public virtual void MigrateSchema(IGeneratedTypeLogger logger)
Parameters
Type | Name | Description |
---|---|---|
IGeneratedTypeLogger | logger | The encapsulated entity manager for each entity. |
SaveSnapshot(Int64, IGeneratedLayerLogger)
This method applies the write operation of the specified
for the
associated to the
.
Declaration
public virtual void SaveSnapshot(long currentTick, IGeneratedLayerLogger layerProxy)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | currentTick | The current simulation tick |
IGeneratedLayerLogger | layerProxy | The considered layer instance to write a snapshot for |
Exceptions
Type | Condition |
---|---|
System.ApplicationException | No implementation |
SaveSnapshot(Int64, IGeneratedTypeLogger)
This method applies the write operation on each entity associated to the
and
or can be override to keep control of the entity serialization.
In contrast to SaveSnapshotByType(Int64, IGeneratedTypeLogger) this method has already been checked, whether the type
shall be serialized.
Declaration
public virtual void SaveSnapshot(long currentTick, IGeneratedTypeLogger typeLogger)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | currentTick | The current simulation tick |
IGeneratedTypeLogger | typeLogger | The considered entity type to write a snapshot for |
SaveSnapshotByType(Int64, IGeneratedTypeLogger)
Persists all entities associated to this
Declaration
public void SaveSnapshotByType(long currentTick, IGeneratedTypeLogger typeProxy)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | currentTick | The current simulation tick. |
IGeneratedTypeLogger | typeProxy | The type proxy for responsible for all agents. |
Setup()
Indicates that the application is now starting and the model was initialized.
Resource and connections can be acquired.
Declaration
public virtual void Setup()
TearDown()
Indicates that the simulation is now finished with computing.
Declaration
public virtual void TearDown()
WriteEntityResult(Int64, IGeneratedEntityLogger)
Writes the value of the entity logger by the sub-mapper implementation
Declaration
protected virtual void WriteEntityResult(long currentTick, IGeneratedEntityLogger proxy)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | currentTick | The current simulation tick |
IGeneratedEntityLogger | proxy | The proxy for a concrete agent entity instance. |
WriteLayerResult(Int64, IGeneratedLayerLogger)
Writes the actual content of the layer instance with provided
layerTypeProxy
and layerProxy
.
Each layer can have individual output, therefore the the proxy is used to encapsulate this transformation.
Declaration
public void WriteLayerResult(long currentTick, IGeneratedLayerLogger layerProxy)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | currentTick | |
IGeneratedLayerLogger | layerProxy |
Implements
System.IDisposable