Skip to main content

%DeepSee.Time.HourNumber

Class %DeepSee.Time.HourNumber Extends %DeepSee.Time.AbstractLevel [ System = 3 ]

This class implements an Hour number level within a time dimension. This is the hour of the date independent of the actual day. Keys are 0 through 23; displayed values are 12am, 1am, until 11pm.

Methods​

%IsIndependent​

ClassMethod %IsIndependent() As %Boolean

Return true if this time level is independent of the actual date.

%GetPeriodLength​

ClassMethod %GetPeriodLength() As %Integer

Return the number of seconds in one unit of this time level.

%Convert​

ClassMethod %Convert(pTime As %DeepSee.Datatype.dateTime, pTimeOffset As %String = "") As %Integer [ CodeMode = expression ]

Convert a $H value to the logical value used for this level. This is used within the computed field logic for properties within a fact table based on this level.
. In this case, we convert $H to a day-of-month period number: That is convert to a number one through 31.

%Count​

ClassMethod %Count(pCube As %String, pDimNo As %Integer, pHierNo As %Integer, pLevelNo As %Integer) As %Integer

Return the total number of members within this level.

%GetName​

ClassMethod %GetName() As %String

Return the user-visible name of this level.

%KeyToValue​

ClassMethod %KeyToValue(pKey As %Integer, pFormat As %String = "", pOffset As %String = "") As %String

Convert a level key value to a display value. E.g., "1am" or "11pm"

%ValueToKey​

ClassMethod %ValueToKey(pValue As %String, pFormat As %String = "", pOffset As %String = "") As %Integer

Convert a level display value to its corresponding key value. Return "" if there is no corresponding key.

%KeyToBaseRange​

ClassMethod %KeyToBaseRange(pKey As %String, Output pStart As %Date, Output pEnd As %Date, pOffset As %String = "") As %Status

Convert a hour-of-day number into starting and ending base values (in $H format).
As this dimension is independent of year, we use year 2000 as the basis of calculations.

%GetLevelMembers​

ClassMethod %GetLevelMembers(Output pList As %List, pCube As %String, pFact As %String, pStartRange As %Date, pEndRange As %Date, pTimeOffset As %String = "", pFormat As %String = "") As %Status

Return an array of members of this level.
As this dimension is independent of year, we use Jan 2000 as the basis of calculations.

%GetRelatedKey​

ClassMethod %GetRelatedKey(Output pRelatedKey As %String, pCube As %String, pFact As %String, pKey As %String, pRelation As %String, pOffset As %Integer = "", pEndKey As %String = "", pTimeOffset As %String = "") As %Status

Return, via pRelatedKey a key within this level related to pKey.

%SupportsNOW​

ClassMethod %SupportsNOW() As %Boolean

Return true if this level supports a NOW member.