This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%DeepSee.Time.WeekNumber

class %DeepSee.Time.WeekNumber extends %DeepSee.Time.AbstractLevel

This class implements a ISO 8601 week number level within a time dimension. This represents the Week number (1 through 53) independent of year.

Method Inventory (Including Private)

Methods

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 week number: That is convert to a number 1 through 53.
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.
classmethod %GetName() as %String
Return the user-visible name of this 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 logical month 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., "1"
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 (n) to its corresponding key value. Return "" if there is no corresponding key.

Inherited Members

Inherited Methods (Including Private)

Feedback