Class ModelDescription

Inheritance
System.Object
IdentifiableElement
ModelDescription
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Mars.Interfaces.Model
Assembly: Mars.Interfaces.dll
Syntax
public class ModelDescription : IdentifiableElement

Constructors

| Improve this Doc View Source

ModelDescription()

Declaration
public ModelDescription()

Properties

| Improve this Doc View Source

ActiveLayerTypes

All layer types which can be executed stepwise
Declaration
[JsonProperty("activeLayerTypes", NullValueHandling = NullValueHandling.Ignore)]
public IEnumerable<LayerType> ActiveLayerTypes { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<LayerType>
| Improve this Doc View Source

AgentTypeMappings

The concrete 1:1 mapping from an System.Type implementation to its AgentType description
Declaration
[JsonIgnore]
public IDictionary<Type, AgentType> AgentTypeMappings { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Type, AgentType>
| Improve this Doc View Source

AgentTypes

Gets all registered agent type and their type description
Declaration
[JsonProperty("agentTypes", NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AgentType> AgentTypes { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<AgentType>
| Improve this Doc View Source

EntityTypes

Gets all registered entity types and their type description
Declaration
[JsonProperty("entityTypes", NullValueHandling = NullValueHandling.Ignore)]
public ICollection<EntityType> EntityTypes { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<EntityType>
| Improve this Doc View Source

IsValid

Indicates whether this model description is correct and has already been passed the validation phase When a value is present the check was already been performed otherwise not.
Declaration
[JsonIgnore]
public bool IsValid { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LayerTypeMappings

The concrete 1:1 mapping from an System.Type implementation to its LayerType description
Declaration
[JsonIgnore]
public IDictionary<Type, LayerType> LayerTypeMappings { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Type, LayerType>
| Improve this Doc View Source

LayerTypes

All layer types of this model descriptions
Declaration
[JsonProperty("layerTypes", NullValueHandling = NullValueHandling.Ignore)]
public ICollection<LayerType> LayerTypes { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<LayerType>
| Improve this Doc View Source

Name

Gets the full qualified name of this model encompassing all registered types in this description
Declaration
[JsonProperty("name", NullValueHandling = NullValueHandling.Ignore)]
public override string Name { get; set; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

SimulationConfig

The input inputConfiguration to create an instance of this model description
Declaration
[JsonProperty("config", NullValueHandling = NullValueHandling.Ignore)]
public SimulationConfig SimulationConfig { get; set; }
Property Value
Type Description
SimulationConfig
| Improve this Doc View Source

Types

All types of this model description
Declaration
[JsonIgnore]
public IEnumerable<TypeElement> Types { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TypeElement>

Methods

| Improve this Doc View Source

AddAgent<TAgent, TLayer>()

AddAgent<TAgent, TLayer>(String)
Declaration
public AgentType AddAgent<TAgent, TLayer>()
    where TAgent : class, IAgent where TLayer : class, ILayer
Returns
Type Description
AgentType
Type Parameters
Name Description
TAgent The agent type to add
TLayer The layer type where this agent type lies on
| Improve this Doc View Source

AddAgent<TAgent, TLayer>(String)

Adds a new agent type to this description including his reference to the layer type on which these agent lies on
Declaration
public AgentType AddAgent<TAgent, TLayer>(string name)
    where TAgent : class, IAgent where TLayer : class, ILayer
Parameters
Type Name Description
System.String name The name of this agent type description
Returns
Type Description
AgentType A new layer type description LayerType
Type Parameters
Name Description
TAgent The agent type to add
TLayer The layer where the lies on
Exceptions
Type Condition
System.ArgumentNullException name is null or empty string
System.ArgumentException agent type description already exists
InvalidTypeException layer or agent type is abstract
MissingTypeException layer type description is missing
| Improve this Doc View Source

AddEntity<TEntity>()

Declaration
public EntityType AddEntity<TEntity>()
    where TEntity : class, IEntity, new()
Returns
Type Description
EntityType
Type Parameters
Name Description
TEntity
| Improve this Doc View Source

AddEntity<TEntity>(String)

Declaration
public EntityType AddEntity<TEntity>(string name)
    where TEntity : class, IEntity, new()
Parameters
Type Name Description
System.String name
Returns
Type Description
EntityType
Type Parameters
Name Description
TEntity
| Improve this Doc View Source

AddLayer<TLayer>(IEnumerable<Type>, Type)

Adds a new layer type to this description including their dependencies, which implements the ILayer interface
Declaration
public LayerType AddLayer<TLayer>(IEnumerable<Type> modelInterfaces = null, Type managedFeatureType = null)
    where TLayer : class, ILayer
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Type> modelInterfaces All explicit implemented interfaces or null if no interfaces were used
System.Type managedFeatureType The containing feature type, managed by this layer type.
Returns
Type Description
LayerType A new layer type description LayerType
Type Parameters
Name Description
TLayer The layer type to add
| Improve this Doc View Source

AddLayer<TLayer>(String, IEnumerable<Type>, Type)

Declaration
public LayerType AddLayer<TLayer>(string name, IEnumerable<Type> modelInterfaces = null, Type managedFeatureType = null)
    where TLayer : ILayer
Parameters
Type Name Description
System.String name
System.Collections.Generic.IEnumerable<System.Type> modelInterfaces
System.Type managedFeatureType
Returns
Type Description
LayerType
Type Parameters
Name Description
TLayer

Extension Methods