GetBottleneckEntsForPeriod Method

• Visual Basic
• C#

'Declaration
 
Public Shared Function GetBottleneckEntsForPeriod( _
   ByVal lineId As Integer, _
   ByVal filterType As LineFilterType, _
   ByVal filterDuration As Nullable(Of Integer), _
   ByVal filterTimeUnit As LineFilterTimeUnit, _
   ByVal filterStartOffset As Nullable(Of Integer), _
   ByVal filterEndOffset As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim lineId As Integer
Dim filterType As LineFilterType
Dim filterDuration As Nullable(Of Integer)
Dim filterTimeUnit As LineFilterTimeUnit
Dim filterStartOffset As Nullable(Of Integer)
Dim filterEndOffset As Nullable(Of Integer)
Dim value As DataSet
 
value = Line.GetBottleneckEntsForPeriod(lineId, filterType, filterDuration, filterTimeUnit, filterStartOffset, filterEndOffset)

public static DataSet GetBottleneckEntsForPeriod( 
   int lineId,
   LineFilterType filterType,
   Nullable<int> filterDuration,
   LineFilterTimeUnit filterTimeUnit,
   Nullable<int> filterStartOffset,
   Nullable<int> filterEndOffset
)

Parameters

lineId

Required. Holds the ID of the line whose bottleneck entity data is being retrieved.

filterType

Required. Holds a LineFilterType enumeration value that specifies the type of time period by which to filter the data. For more information, see the LineFilterType enumeration help topic for the FactMES.API.Core namespace.

filterDuration

Optional. Holds an integer value that specifies the value of N if filterType is LastNHours.

filterTimeUnit

Required. Holds a LineFilterTimeUnit enumeration value that specifies the time unit for a custom filter if filterType is Custom. For more information, see the LineFilterTimeUnit enumeration help topic for the FactMES.API.Core namespace.

If filterType is not Custom, this parameter is ignored.

filterStartOffset

Optional. Holds an integer that specifies the start point of the time interval for which the events are to be filtered. See the Remarks section below for more information about how this parameter is used.

filterEndOffset

Optional. Specifies the end point of the time interval for which the events are to be filtered. See the Remarks section below for more information about how this parameter is used.

Return Value