Class ReplayDescriptor
Descriptor for pipeline replay.
Namespace: Microsoft.Psi
Assembly: Microsoft.Psi.dll
Syntax
public sealed class ReplayDescriptor : object
Constructors
View SourceReplayDescriptor(DateTime, DateTime, Boolean)
Initializes a new instance of the ReplayDescriptor class.
Declaration
public ReplayDescriptor(DateTime start, DateTime end, bool enforceReplayClock = true)
Parameters
Type | Name | Description |
---|---|---|
DateTime | start | Starting message time. |
DateTime | end | Ending message time. |
System.Boolean | enforceReplayClock | Whether to enforce replay clock. |
ReplayDescriptor(DateTime, Boolean)
Initializes a new instance of the ReplayDescriptor class.
Declaration
public ReplayDescriptor(DateTime start, bool enforceReplayClock = true)
Parameters
Type | Name | Description |
---|---|---|
DateTime | start | Starting message time. |
System.Boolean | enforceReplayClock | Whether to enforce replay clock (optional). |
Remarks
No ending message time (infinite).
ReplayDescriptor(TimeInterval, Boolean)
Initializes a new instance of the ReplayDescriptor class.
Declaration
public ReplayDescriptor(TimeInterval interval, bool enforceReplayClock = true)
Parameters
Type | Name | Description |
---|---|---|
TimeInterval | interval | Time interval to replay. |
System.Boolean | enforceReplayClock | Whether to enforce replay clock. |
Fields
View SourceReplayAll
Replay all messages (not in real time, disregarding originating time and not enforcing replay clock).
Declaration
public static readonly ReplayDescriptor ReplayAll
Field Value
Type | Description |
---|---|
ReplayDescriptor |
ReplayAllRealTime
Replay all messages in real time (preserving originating time and enforcing replay clock).
Declaration
public static readonly ReplayDescriptor ReplayAllRealTime
Field Value
Type | Description |
---|---|
ReplayDescriptor |
Properties
View SourceEnd
Gets ending message time.
Declaration
public DateTime End { get; }
Property Value
Type | Description |
---|---|
DateTime |
EnforceReplayClock
Gets a value indicating whether to enforce replay clock.
Declaration
public bool EnforceReplayClock { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Interval
Gets time interval to replay.
Declaration
public TimeInterval Interval { get; }
Property Value
Type | Description |
---|---|
TimeInterval |
Start
Gets starting message time.
Declaration
public DateTime Start { get; }
Property Value
Type | Description |
---|---|
DateTime |
Methods
View SourceIntersect(TimeInterval)
Reduce this replay descriptor to that which intersects the given time interval.
Declaration
public ReplayDescriptor Intersect(TimeInterval interval)
Parameters
Type | Name | Description |
---|---|---|
TimeInterval | interval | Intersecting time interval. |
Returns
Type | Description |
---|---|
ReplayDescriptor | Reduced replay descriptor. |