Class FinTimeConstraints

Inheritance
object
FinTimeConstraints
Inherited Members
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public class FinTimeConstraints

Constructors

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

Declaration
public FinTimeConstraints(int nMinuteInterval, IList<FinTimeSlot> vProhibited, IList<FinTimeSlot> vPreferred)
Parameters
Type Name Description
int nMinuteInterval
IList<FinTimeSlot> vProhibited
IList<FinTimeSlot> vPreferred

FinTimeConstraints(int, string, string)

Declaration
public FinTimeConstraints(int nMinuteInterval, string sProhibited, string sPreferred)
Parameters
Type Name Description
int nMinuteInterval

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

Properties

AllowedMinutes

Provides an array of permitted minute values based on MinuteInterval.

Declaration
public int[] AllowedMinutes { get; }
Property Value
Type Description
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

Declaration
public static SwiftTime EXECTIME_DEFAULT { get; }
Property Value
Type Description
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.

Declaration
public int MinuteInterval { get; }
Property Value
Type Description
int

PreferredTimeSlots

Time slots that are perferred ExecTimes.

Declaration
public FinTimeSlot[] PreferredTimeSlots { get; }
Property Value
Type Description
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.

Declaration
public FinTimeSlot[] ProhibitedTimeSlots { get; }
Property Value
Type Description
FinTimeSlot[]

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

Methods

GetAllowedExecTime(SwiftDate, SwiftTime)

Declaration
public SwiftTime GetAllowedExecTime(SwiftDate tDate, SwiftTime tTime)
Parameters
Type Name Description
SwiftDate tDate
SwiftTime tTime
Returns
Type Description
SwiftTime

GetPreferredExecTime(SwiftDate, SwiftTime)

Gets the preferred earliest execution time at a specific date.

Declaration
public SwiftTime GetPreferredExecTime(SwiftDate tDate, SwiftTime tTime)
Parameters
Type Name Description
SwiftDate tDate

The date for which to find a preferred execution time.
SwiftTime tTime

Optional earliest time to consider at the given date. If this is NullTime, then the earliest execution time will be EXECTIME_DEFAULT.
Returns
Type Description
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.