class %DeepSee.Time.HourNumber
extends %DeepSee.Time.AbstractLevel
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.
|
Parameters
|
Properties
|
Methods
|
Queries
|
Indices
|
ForeignKeys
|
Triggers
|
|
|
|
11
|
|
|
|
|
• classmethod %Convert(pTime As %DeepSee.Datatype.dateTime, pTimeOffset As %String = "")
as %Integer
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.
• 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.
• 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.
• classmethod %GetName()
as %String
Return the user-visible name of this level.
• classmethod %GetPeriodLength()
as %Integer
Return the number of seconds in one unit of this time level.
• 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.
• classmethod %IsIndependent()
as %Boolean
Return true if this time level is independent of the actual date.
• 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.
• 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"
• classmethod %SupportsNOW()
as %Boolean
Return true if this level supports a NOW member.
• 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.
