GetCountsAndDuration Method (UtilLog)

• Visual Basic
• C#

'Declaration
 
Public Shared Function GetCountsAndDuration( _
   ByVal sessionId As Integer, _
   ByVal entId As Integer, _
   ByVal graphType As CountsAndDurationGraphType, _
   ByVal filterType As FilterType, _
   ByVal filterDuration As Nullable(Of Integer), _
   ByVal filterTimeUnit As FilterTimeUnit, _
   ByVal filterStartOffset As Nullable(Of Integer), _
   ByVal filterEndOffset As Nullable(Of Integer), _
   ByVal oeeStatusFilter As OeeStatusFilter, _
   ByVal utilStateCode As Nullable(Of Integer), _
   ByVal reasGrpId As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim sessionId As Integer
Dim entId As Integer
Dim graphType As CountsAndDurationGraphType
Dim filterType As FilterType
Dim filterDuration As Nullable(Of Integer)
Dim filterTimeUnit As FilterTimeUnit
Dim filterStartOffset As Nullable(Of Integer)
Dim filterEndOffset As Nullable(Of Integer)
Dim oeeStatusFilter As OeeStatusFilter
Dim utilStateCode As Nullable(Of Integer)
Dim reasGrpId As Nullable(Of Integer)
Dim value As DataSet
 
value = UtilLog.GetCountsAndDuration(sessionId, entId, graphType, filterType, filterDuration, filterTimeUnit, filterStartOffset, filterEndOffset, oeeStatusFilter, utilStateCode, reasGrpId)

public static DataSet GetCountsAndDuration( 
   int sessionId,
   int entId,
   CountsAndDurationGraphType graphType,
   FilterType filterType,
   Nullable<int> filterDuration,
   FilterTimeUnit filterTimeUnit,
   Nullable<int> filterStartOffset,
   Nullable<int> filterEndOffset,
   OeeStatusFilter oeeStatusFilter,
   Nullable<int> utilStateCode,
   Nullable<int> reasGrpId
)

Parameters

sessionId

Required. Holds the session ID and thus the user who is making this method call. Although required, the session ID is not used by the call.

entId

Required. Holds the ID of the entity whose counts and duration data is being retrieved.

graphType

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

filterType

Required. Holds a FilterType enumeration value that specifies the type of data to filter. For more information, see the FilterType enumeration help topic for the FactMES.API.Util namespace.

filterDuration

Required if filterType is set to LastNHours. Holds an integer value that specifies the value of N if filterType is LastNHours.

filterTimeUnit

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

filterStartOffset

Required when filterType is set to Custom. The filter_start_offset and the filter_end_offset together define an interval that filters the data to be returned (i.e., only data which falls within the interval will be returned). These offsets both go backwards from the current time: a value of 1 indicates the current time, a value of 2 indicates one time unit ago, etc.

The filter_start_offset must be greater (i.e., further back in time) than the filter_end_offset. If the filter_end_offset is zero, it is ignored (i.e., the end of the interval will be the current time). For example, if filter_time_unit is set to 2 (Day), filter_start_offset is set to 2 and filter_end_offset is set to 1, then only data with an event time that occurred yesterday will be returned. If filter_time_unit is set to 1 (Shift), filter_start_offset is set to 1, and filter_end_offset is set to 0, then only events that occurred during the current shift will be returned.

filterEndOffset

Required when filter_time_unit is specified. Specifies the end point of the time interval for which the events are to be filtered. See filter_start_offset for more information.

oeeStatusFilter

Required. Holds an OEEStatusFilter enumeration value that specifies whether the data should be filtered by an OEE status of runtime, downtime, neither, or all. For more information, see the OeeStatusFilter enumeration help topic for the FactMES.API.Util namespace.

utilStateCode

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

reasGrpId

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

Return Value