Class FinTimeConstraints

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

public class FinTimeConstraints

Inheritance: object

FinTimeConstraints

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FinTimeConstraints(int, IList<FinTimeSlot>, IList<FinTimeSlot>)

public FinTimeConstraints(int nMinuteInterval, IList<FinTimeSlot> vProhibited, IList<FinTimeSlot> vPreferred)

Parameters

nMinuteInterval int
vProhibited IList<FinTimeSlot>
vPreferred IList<FinTimeSlot>

FinTimeConstraints(int, string, string)

public FinTimeConstraints(int nMinuteInterval, string sProhibited, string sPreferred)

Parameters

nMinuteInterval int: The spacing of allowed execution minutes within an hour. Only the following values are allowed: 1, 2, 5, 10, 15, 20, 30, 60.
sProhibited string
sPreferred string

Properties

AllowedMinutes

Provides an array of permitted minute values based on MinuteInterval.

public int[] AllowedMinutes { get; }

Property Value

int[]

Remarks

If MinuteInterval is zero or one, then this returns an array with all values from zero to 59. If If MinuteInterval is 60, then this returns an array with only the value zero in it. Your milage may vary.

EXECTIME_DEFAULT

public static SwiftTime EXECTIME_DEFAULT { get; }

Property Value

SwiftTime

MinuteInterval

The spacing of allowed execution minutes within an hour. Only the following values are allowed: 1, 2, 5, 10, 15, 20, 30, 60.

public int MinuteInterval { get; }

Property Value

int

PreferredTimeSlots

Time slots that are perferred ExecTimes.

public FinTimeSlot[] PreferredTimeSlots { get; }

Property Value

FinTimeSlot[]: This may be null or an empty array, in order to indicate that there is no particular time slot preferred.

ProhibitedTimeSlots

Time slots that are prohibited as a ExecTime.

public FinTimeSlot[] ProhibitedTimeSlots { get; }

Property Value

FinTimeSlot[]: This may be null or an empty array, in order to indicate that there are no prohibited time slots.

Methods

GetAllowedExecTime(SwiftDate, SwiftTime)

public SwiftTime GetAllowedExecTime(SwiftDate tDate, SwiftTime tTime)

Parameters

tDate SwiftDate
tTime SwiftTime

Returns

SwiftTime

GetPreferredExecTime(SwiftDate, SwiftTime)

Gets the preferred earliest execution time at a specific date.

public SwiftTime GetPreferredExecTime(SwiftDate tDate, SwiftTime tTime)

Parameters

tDate SwiftDate: The date for which to find a preferred execution time.
tTime SwiftTime: Optional earliest time to consider at the given date. If this is NullTime, then the earliest execution time will be EXECTIME_DEFAULT.

Returns

SwiftTime

Remarks

If there is no preferred execution time with the given parameters, then NullTime will be returned. If this is the case, then try an earlier tTime, or provide no tTime at all.