GetCountsAndDuration Method (Line)

• Visual Basic
• C#

'Declaration
 
Public Shared Function GetCountsAndDuration( _
   ByVal lineId As Integer, _
   ByVal graphType As LineCountsAndDurationGraphType, _
   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), _
   ByVal oeeStatusFilter As LineOeeStatusFilter, _
   ByVal utilStateCode As Nullable(Of Integer), _
   ByVal reasGrpId As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim lineId As Integer
Dim graphType As LineCountsAndDurationGraphType
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 oeeStatusFilter As LineOeeStatusFilter
Dim utilStateCode As Nullable(Of Integer)
Dim reasGrpId As Nullable(Of Integer)
Dim value As DataSet
 
value = Line.GetCountsAndDuration(lineId, graphType, filterType, filterDuration, filterTimeUnit, filterStartOffset, filterEndOffset, oeeStatusFilter, utilStateCode, reasGrpId)

public static DataSet GetCountsAndDuration( 
   int lineId,
   LineCountsAndDurationGraphType graphType,
   LineFilterType filterType,
   Nullable<int> filterDuration,
   LineFilterTimeUnit filterTimeUnit,
   Nullable<int> filterStartOffset,
   Nullable<int> filterEndOffset,
   LineOeeStatusFilter oeeStatusFilter,
   Nullable<int> utilStateCode,
   Nullable<int> reasGrpId
)

Parameters

lineId

Required. Holds the ID of the line whose counts and duration data are being retrieved.

graphType

Required. Holds a LineCountsAndDurationGraphType enumeration value that specifies the type of data that is shown in the Pareto graph of the KPI control. For more information, see the LineCountsAndDurationGraphType enumeration help topic for the FactMES.API.Core namespace.

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.

oeeStatusFilter

Required. Holds a LineOEEStatusFilter enumeration value that specifies whether the data should be filtered by an OEE status of Runtime, Downtime, Neither, or all three statuses. For more information, see the LineOeeStatusFilter enumeration help topic for the FactMES.API.Core namespace.

utilStateCode

Optional. Holds the code of the utilization state by which to filter the retrieved data.

reasGrpId

Optional. Holds the ID of the utilization reason group by which to filter the retrieved data.

Return Value