Class DataFrame

Output frame (either full or delta-state output) for an agent and tick.
Inheritance
System.Object
DataFrame
Implements
System.IEquatable<DataFrame>
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.Entities
Assembly: Mars.Core.dll
Syntax
[MessagePackObject(false)]
public sealed class DataFrame : IEquatable<DataFrame>, IPositionable

Properties

| Improve this Doc View Source

AgentId

Associated agent.
Declaration
[JsonProperty(PropertyName = "agentId", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("agentId")]
[BsonIgnoreIfNull]
[Key(0)]
[Column("ID")]
public string AgentId { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

AgentType

Associated type name
Declaration
[JsonProperty(PropertyName = "agentType", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("type")]
[BsonIgnoreIfNull]
[Key(1)]
[Column("Type")]
public string AgentType { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DateTime

Output frame (either full or delta-state output) for an agent and tick.
Declaration
[JsonProperty(PropertyName = "dateTime", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("dateTime")]
[BsonIgnoreIfNull]
[Key(4)]
[Column("DateTime")]
public DateTime? DateTime { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

Orientation

Agent orientation or compass bearing (yaw).
Declaration
[JsonProperty(PropertyName = "orientation", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("orientation")]
[BsonIgnoreIfNull]
[Key(6)]
[Column("Orientation")]
public double? Orientation { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

Pitch

Agent pitch for z-axis or look to sky
Declaration
[JsonProperty(PropertyName = "pitch", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("pitch")]
[BsonIgnoreIfNull]
[Key(7)]
[Column("Pitch")]
public double? Pitch { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

Position

The common Position object when the agent is IPositionable.
Declaration
[BsonIgnore]
[JsonIgnore]
[IgnoreMember]
[BsonIgnoreIfNull]
public Position Position { get; set; }
Property Value
Type Description
Position
| Improve this Doc View Source

PositionArray

Agent position.
Declaration
[JsonProperty(PropertyName = "position", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("position")]
[BsonIgnoreIfNull]
[Key(5)]
[NotMapped]
public double[] PositionArray { get; }
Property Value
Type Description
System.Double[]
| Improve this Doc View Source

Properties

Gets the agent properties by their individual name and the frame value.
Declaration
[JsonProperty(PropertyName = "properties", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("properties")]
[BsonIgnoreIfNull]
[IgnoreMember]
[NotMapped]
public IDictionary<string, object> Properties { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>
| Improve this Doc View Source

RID

Output frame (either full or delta-state output) for an agent and tick.
Declaration
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
[Key]
[JsonIgnore]
[BsonIgnore]
[IgnoreMember]
public int RID { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Step

Output frame (either full or delta-state output) for an agent and tick.
Declaration
[JsonProperty(PropertyName = "step", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("step")]
[BsonIgnoreIfNull]
[Key(3)]
[Column("Step")]
public long Step { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

Tick

Simulation tick.
Declaration
[JsonProperty(PropertyName = "tick", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("tick")]
[BsonIgnoreIfNull]
[Key(2)]
[Column("Tick")]
public long Tick { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

Values

The concrete values of this frame
Declaration
[JsonProperty(PropertyName = "values", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
[BsonElement("values")]
[BsonIgnoreIfNull]
[Key(8)]
public object[] Values { get; set; }
Property Value
Type Description
System.Object[]

Methods

| Improve this Doc View Source

Equals(DataFrame)

Output frame (either full or delta-state output) for an agent and tick.
Declaration
public bool Equals(DataFrame other)
Parameters
Type Name Description
DataFrame other
Returns
Type Description
System.Boolean

Implements

System.IEquatable<T>

Extension Methods