Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Model] >  [calculatedMember]
Private  Storage   

class %DeepSee.Model.calculatedMember extends %DeepSee.Model.node

Meta-data object that represents a calculated member within a DeepSee cube.
At query processing time, references to a calculated member are replaced with the valueExpression that defines the member.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 2


Summary

Properties
additionalDescription cube description dimension
disabled displayName formatString hidden
isModified listingFilter name units
valueExpression

Methods
%AddToSaveSet %AtScaleConvertAggregate %AtScaleConvertTimeFunction %AtScaleConvertType
%AtScaleCreateMessageObj %AtScaleExport %AtScaleInitIndex %AtScaleProcessSourceRef
%AtScaleProduceAttribute %AtScaleProduceDataSet %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%IsModified %New %NormalizeObject %ObjectModified
%OriginalNamespace %PackageName %QuoteList %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %SerializeObject %SetModified
%Validate %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Properties

• relationship cube as %DeepSee.Model.cube(XMLPROJECTION="none") [ Inverse = calculatedMembers,Cardinality = one ];
Cube that this calculated member belongs to.
• property dimension as %DeepSee.Datatype.entityName(XMLPROJECTION="attribute");
Name of the dimension this calculated member belongs to. This does not have to be an existing dimension.
• property formatString as %DeepSee.Datatype.string(MAXLEN=100,XMLPROJECTION="attribute");
Optional format string to apply to this member.
• property hidden as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, this calculatedMember is hidden. That is, it will not be listed among the cube's members within the various DeepSee utilities.
It can still be used within MDX queries and expressions.
• property listingFilter as %DeepSee.Datatype.string(XMLPROJECTION="attribute");
• property units as %DeepSee.Datatype.string(XMLPROJECTION="attribute");
Optional. Units applied to this member (if it is a measure).
This is not currently used.
• property valueExpression as %DeepSee.Datatype.string(MAXLEN=32000,XMLPROJECTION="attribute");
MDX expression that defines the value of this calculated member.

Methods

• method %AtScaleExport(pStatus As %Status = $$$OK, ByRef pAuxiliaryIndex As %DynamicAbstractObject = $$$NULLOREF) as %DynamicAbstractObject
Produce the structures needed to emit the appropriate JSON and export this item to AtScale
• method %Validate() as %Status
Test if this member's definition is valid.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.