Interface IGeneratedEntityLogger

Result output interface describing the methods to be fulfilled by the generated loggers.
Inherited Members
Namespace: Mars.Core.Data
Assembly: Mars.Core.dll
Syntax
public interface IGeneratedEntityLogger : IGeneratedLogger<IEntity>, IOutputLogger

Properties

Position

Gets the position of this entity when it has implemented the contract
Declaration
Position Position { get; }
Property Value
Type Description
Position

Methods

IsPositionSerializable(BoundingBox)

Checks for the current instance, based on their position whether this instance is within the bounding box or not.
Declaration
bool IsPositionSerializable(BoundingBox box)
Parameters
Type Name Description
BoundingBox box The bounding box with lower left and upper right corner specification to check whether the position is in that box.
Returns
Type Description
System.Boolean Returns true when the instance can be serialized otherwise false

SerializeToFrame()

Generates a full-state message of this simulation object in form of new created DataFrame object. This contains the spatial and temporal reference as well as all active output properties of this agent type.
Declaration
DataFrame SerializeToFrame()
Returns
Type Description
DataFrame A JSON-compliant output for all agent states.

SerializeValueFor(String)

Serializes the value for the given propertyName or returns null otherwise.
Declaration
object SerializeValueFor(string propertyName)
Parameters
Type Name Description
System.String propertyName The property to access.
Returns
Type Description
System.Object Returns the value or null when the property is not available.