Mobile API Reference  MicroStrategy 2019
DSSTabularMetrics Class Reference

#include <DSSTabularMetrics.h>

Inheritance diagram for DSSTabularMetrics:
DSSTabularUnit DSSTabularUnit IStatisticsInfo IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo

Public Member Functions

 DSSTabularMetrics ()
 
 ~DSSTabularMetrics ()
 
int Init (int index, int nMetrics)
 
int AddMetric (int index, MBase::CString &irGUID, int iDataType, int iSubtotalType, bool isDisplayed=true)
 
int AddMetricToAnotherMetrics (DSSTabularMetrics *ipMetrics)
 
int Count ()
 
int CountDisplayedMetrics ()
 
int CountRows ()
 
int CountSlices ()
 
int getMetricID (int iMetric, GUID &orMetricID)
 
EnumDSSDataType getMetricDataType (int iMetric)
 
int FindElement (DSSBaseElementProxy *ipElement, int &orKey)
 
int createElement (int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement, int iGlobalKey=-1, int iGlobalKeyVer=-1)
 
int FindMetric (GUID &irMetricID)
 
int FindMetricI (GUID irMetricID, int *opMetricIndex)
 
virtual int size ()
 
EnumDSSMetricType getTotalImplementation (int iMetric)
 
bool compareElement (DSSBaseElementProxy *ipElement, int iKey)
 
int addSlice (DSSCubeDataSlice *ipSlice)
 
vector< DSSCubeDataSlice * > & getSliceList ()
 
const GUIDgetMetricID (int iMetric)
 
int FindDisplayedMetric (GUID &irMetricID)
 
vector< GUIDgetDisplayedMetricIDs ()
 
int setDisplayedMetricIDs (vector< GUID > iGUIDs)
 
int setAggInfo (vector< GUID > &ivAggAttr, vector< EnumDSSAggregation > &ivAggFunc)
 
int getAggregationInfo (GUID iMetricID, vector< GUID > &ovNonAggAttr, vector< EnumDSSAggregation > &ovAggInfo)
 
int setDynamicAggFunc (EnumDSSMetricType iFunc)
 
EnumDSSMetricType getDynamicAggFunc (int iIndex)
 
int setTotalImplID (GUID iTotalImplID)
 
int setDynamicAggID (GUID iDAImplID)
 
GUID getTotalImplID (int index)
 
GUID getDynamicAggID (int index)
 
int clear ()
 
int setAvailableSubtotals (int iSystemSubtotal, vector< GUID > iUserDefinedSubtotals)
 
int getAvailableSubtotals (GUID iMetricID, int &oSystemSubtotal, vector< GUID > &oUserDefinedSubtotals)
 
int ItemC (int index, DSSCubeDataSlice **oppCubeSlice)
 
 DSSTabularMetrics ()
 
 ~DSSTabularMetrics ()
 
int Init (int index, int nMetrics)
 
int AddMetric (int index, MBase::CString &irGUID, int iDataType, int iSubtotalType, bool isDisplayed=true)
 
int AddMetricToAnotherMetrics (DSSTabularMetrics *ipMetrics)
 
int Count ()
 
int CountDisplayedMetrics ()
 
int CountRows ()
 
int CountSlices ()
 
int getMetricID (int iMetric, GUID &orMetricID)
 
EnumDSSDataType getMetricDataType (int iMetric)
 
int FindElement (DSSBaseElementProxy *ipElement, int &orKey)
 
int createElement (int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement, int iGlobalKey=-1, int iGlobalKeyVer=-1)
 
int FindMetric (GUID &irMetricID)
 
int FindMetricI (GUID irMetricID, int *opMetricIndex)
 
virtual int size ()
 
EnumDSSMetricType getTotalImplementation (int iMetric)
 
bool compareElement (DSSBaseElementProxy *ipElement, int iKey)
 
int addSlice (DSSCubeDataSlice *ipSlice)
 
vector< DSSCubeDataSlice * > & getSliceList ()
 
const GUIDgetMetricID (int iMetric)
 
int FindDisplayedMetric (GUID &irMetricID)
 
vector< GUIDgetDisplayedMetricIDs ()
 
int setDisplayedMetricIDs (vector< GUID > iGUIDs)
 
int setAggInfo (vector< GUID > &ivAggAttr, vector< EnumDSSAggregation > &ivAggFunc)
 
int getAggregationInfo (GUID iMetricID, vector< GUID > &ovNonAggAttr, vector< EnumDSSAggregation > &ovAggInfo)
 
int setDynamicAggFunc (EnumDSSMetricType iFunc)
 
EnumDSSMetricType getDynamicAggFunc (int iIndex)
 
int setTotalImplID (GUID iTotalImplID)
 
int setDynamicAggID (GUID iDAImplID)
 
GUID getTotalImplID (int index)
 
GUID getDynamicAggID (int index)
 
int clear ()
 
int setAvailableSubtotals (int iSystemSubtotal, vector< GUID > iUserDefinedSubtotals)
 
int getAvailableSubtotals (GUID iMetricID, int &oSystemSubtotal, vector< GUID > &oUserDefinedSubtotals)
 
int ItemC (int index, DSSCubeDataSlice **oppCubeSlice)
 
- Public Member Functions inherited from DSSTabularUnit
 DSSTabularUnit ()
 
virtual ~DSSTabularUnit ()
 
int getUnitIndex ()
 
void setUnitIndex (int iIndex)
 
int setGUID (MBase::CString &irVal)
 
int setGUID (GUID &irVal)
 
virtual int getGUID (GUID &irVal)
 
virtual const GUIDgetGUID ()
 
int get_IDI (GUID *opID)
 
EnumDSSTemplateUnitType getUnitType ()
 
int get_UnitType (EnumDSSTemplateUnitType *opType)
 
void setIsRuntimeUnit (bool val)
 
virtual bool IsRuntimeUnit ()
 
virtual bool IsRecursiveUnit ()
 
int createSpecialElement (EnumDSSElementType iElementType, int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement)
 
void setParentInfo (DSSDataModelBase *ipModel)
 
void setNullElement (int index, MBase::CString &irElementID)
 
void setObjectContextRef (DSSObjectContext *ipObjContext)
 
virtual int getTabularUnit (DSSTabularUnit **oppUnit)
 
virtual MBase::CString getGUIDStr ()
 
 DSSTabularUnit ()
 
virtual ~DSSTabularUnit ()
 
int getUnitIndex ()
 
void setUnitIndex (int iIndex)
 
int setGUID (MBase::CString &irVal)
 
int setGUID (GUID &irVal)
 
virtual int getGUID (GUID &irVal)
 
virtual const GUIDgetGUID ()
 
int get_IDI (GUID *opID)
 
EnumDSSTemplateUnitType getUnitType ()
 
int get_UnitType (EnumDSSTemplateUnitType *opType)
 
void setIsRuntimeUnit (bool val)
 
virtual bool IsRuntimeUnit ()
 
virtual bool IsRecursiveUnit ()
 
int createSpecialElement (EnumDSSElementType iElementType, int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement)
 
void setParentInfo (DSSDataModelBase *ipModel)
 
void setNullElement (int index, MBase::CString &irElementID)
 
void setObjectContextRef (DSSObjectContext *ipObjContext)
 
virtual int getTabularUnit (DSSTabularUnit **oppUnit)
 
virtual MBase::CString getGUIDStr ()
 
- Public Member Functions inherited from IXTABAttributeInfo
virtual int getArity ()
 
virtual int Item (int iForm, DSSDataColumn **oppColumn)
 
virtual int getWHNullPosition ()
 
virtual void setWHNullPosition (int iPosition)
 
virtual int getBaseFormID (int iForm)
 
virtual int setData (int iBaseFormID, int iRow, char *ipData, int iSizeInByte)
 
virtual int setData (int iBaseFormID, int iOffset, MBase::CString &irText)
 
virtual int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int *opColumn)
 
virtual int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int &orColumn)
 
virtual int getArity ()
 
virtual int Item (int iForm, DSSDataColumn **oppColumn)
 
virtual int getWHNullPosition ()
 
virtual void setWHNullPosition (int iPosition)
 
virtual int getBaseFormID (int iForm)
 
virtual int setData (int iBaseFormID, int iRow, char *ipData, int iSizeInByte)
 
virtual int setData (int iBaseFormID, int iOffset, MBase::CString &irText)
 
virtual int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int *opColumn)
 
virtual int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int &orColumn)
 

Additional Inherited Members

- Protected Member Functions inherited from DSSTabularUnit
DSSObjectContexthGetContext ()
 
DSSBaseElementProxyhGetNullElement ()
 
DSSObjectContexthGetContext ()
 
DSSBaseElementProxyhGetNullElement ()
 
- Protected Attributes inherited from DSSTabularUnit
int mUnitID
 
MBase::CString mGUIDStr
 
GUID mGUID
 
EnumDSSTemplateUnitType mUnitType
 
bool mbIsRuntimeUnit
 
DSSDataModelBasempModel
 
DSSObjectContextmpObjContext
 
int mNullElementIndex
 
MBase::CString mNullElementIDStr
 
DSSBaseElementProxympNullElement
 

Constructor & Destructor Documentation

◆ DSSTabularMetrics() [1/2]

DSSTabularMetrics::DSSTabularMetrics ( )

◆ ~DSSTabularMetrics() [1/2]

DSSTabularMetrics::~DSSTabularMetrics ( )

◆ DSSTabularMetrics() [2/2]

DSSTabularMetrics::DSSTabularMetrics ( )

◆ ~DSSTabularMetrics() [2/2]

DSSTabularMetrics::~DSSTabularMetrics ( )

Member Function Documentation

◆ AddMetric() [1/2]

int DSSTabularMetrics::AddMetric ( int  index,
MBase::CString irGUID,
int  iDataType,
int  iSubtotalType,
bool  isDisplayed = true 
)

◆ AddMetric() [2/2]

int DSSTabularMetrics::AddMetric ( int  index,
MBase::CString irGUID,
int  iDataType,
int  iSubtotalType,
bool  isDisplayed = true 
)

◆ AddMetricToAnotherMetrics() [1/2]

int DSSTabularMetrics::AddMetricToAnotherMetrics ( DSSTabularMetrics ipMetrics)

◆ AddMetricToAnotherMetrics() [2/2]

int DSSTabularMetrics::AddMetricToAnotherMetrics ( DSSTabularMetrics ipMetrics)

◆ addSlice() [1/2]

int DSSTabularMetrics::addSlice ( DSSCubeDataSlice ipSlice)

◆ addSlice() [2/2]

int DSSTabularMetrics::addSlice ( DSSCubeDataSlice ipSlice)

◆ clear() [1/2]

int DSSTabularMetrics::clear ( )

◆ clear() [2/2]

int DSSTabularMetrics::clear ( )

◆ compareElement() [1/2]

bool DSSTabularMetrics::compareElement ( DSSBaseElementProxy ipElement,
int  iKey 
)
virtual

Implements DSSTabularUnit.

◆ compareElement() [2/2]

bool DSSTabularMetrics::compareElement ( DSSBaseElementProxy ipElement,
int  iKey 
)
virtual

Implements DSSTabularUnit.

◆ Count() [1/2]

int DSSTabularMetrics::Count ( )
inlinevirtual

Reimplemented from IXTABAttributeInfo.

◆ Count() [2/2]

int DSSTabularMetrics::Count ( )
virtual

Reimplemented from IXTABAttributeInfo.

◆ CountDisplayedMetrics() [1/2]

int DSSTabularMetrics::CountDisplayedMetrics ( )

◆ CountDisplayedMetrics() [2/2]

int DSSTabularMetrics::CountDisplayedMetrics ( )
inline

◆ CountRows() [1/2]

int DSSTabularMetrics::CountRows ( )
virtual

Implements DSSTabularUnit.

◆ CountRows() [2/2]

int DSSTabularMetrics::CountRows ( )
inlinevirtual

Implements DSSTabularUnit.

◆ CountSlices() [1/2]

int DSSTabularMetrics::CountSlices ( )

◆ CountSlices() [2/2]

int DSSTabularMetrics::CountSlices ( )
inline

◆ createElement() [1/2]

int DSSTabularMetrics::createElement ( int  key,
DSSObjectContext ipObjectContext,
DSSBaseElementProxy **  oppElement,
int  iGlobalKey = -1,
int  iGlobalKeyVer = -1 
)
virtual

Implements DSSTabularUnit.

◆ createElement() [2/2]

int DSSTabularMetrics::createElement ( int  key,
DSSObjectContext ipObjectContext,
DSSBaseElementProxy **  oppElement,
int  iGlobalKey = -1,
int  iGlobalKeyVer = -1 
)
virtual

Implements DSSTabularUnit.

◆ FindDisplayedMetric() [1/2]

int DSSTabularMetrics::FindDisplayedMetric ( GUID irMetricID)

◆ FindDisplayedMetric() [2/2]

int DSSTabularMetrics::FindDisplayedMetric ( GUID irMetricID)

◆ FindElement() [1/2]

int DSSTabularMetrics::FindElement ( DSSBaseElementProxy ipElement,
int &  orKey 
)
virtual

Implements DSSTabularUnit.

◆ FindElement() [2/2]

int DSSTabularMetrics::FindElement ( DSSBaseElementProxy ipElement,
int &  orKey 
)
virtual

Implements DSSTabularUnit.

◆ FindMetric() [1/2]

int DSSTabularMetrics::FindMetric ( GUID irMetricID)

◆ FindMetric() [2/2]

int DSSTabularMetrics::FindMetric ( GUID irMetricID)

◆ FindMetricI() [1/2]

int DSSTabularMetrics::FindMetricI ( GUID  irMetricID,
int *  opMetricIndex 
)

◆ FindMetricI() [2/2]

int DSSTabularMetrics::FindMetricI ( GUID  irMetricID,
int *  opMetricIndex 
)

◆ getAggregationInfo() [1/2]

int DSSTabularMetrics::getAggregationInfo ( GUID  iMetricID,
vector< GUID > &  ovNonAggAttr,
vector< EnumDSSAggregation > &  ovAggInfo 
)

◆ getAggregationInfo() [2/2]

int DSSTabularMetrics::getAggregationInfo ( GUID  iMetricID,
vector< GUID > &  ovNonAggAttr,
vector< EnumDSSAggregation > &  ovAggInfo 
)

◆ getAvailableSubtotals() [1/2]

int DSSTabularMetrics::getAvailableSubtotals ( GUID  iMetricID,
int &  oSystemSubtotal,
vector< GUID > &  oUserDefinedSubtotals 
)

◆ getAvailableSubtotals() [2/2]

int DSSTabularMetrics::getAvailableSubtotals ( GUID  iMetricID,
int &  oSystemSubtotal,
vector< GUID > &  oUserDefinedSubtotals 
)

◆ getDisplayedMetricIDs() [1/2]

vector<GUID> DSSTabularMetrics::getDisplayedMetricIDs ( )

◆ getDisplayedMetricIDs() [2/2]

vector<GUID> DSSTabularMetrics::getDisplayedMetricIDs ( )

◆ getDynamicAggFunc() [1/2]

EnumDSSMetricType DSSTabularMetrics::getDynamicAggFunc ( int  iIndex)

◆ getDynamicAggFunc() [2/2]

EnumDSSMetricType DSSTabularMetrics::getDynamicAggFunc ( int  iIndex)

◆ getDynamicAggID() [1/2]

GUID DSSTabularMetrics::getDynamicAggID ( int  index)

◆ getDynamicAggID() [2/2]

GUID DSSTabularMetrics::getDynamicAggID ( int  index)

◆ getMetricDataType() [1/2]

EnumDSSDataType DSSTabularMetrics::getMetricDataType ( int  iMetric)

◆ getMetricDataType() [2/2]

EnumDSSDataType DSSTabularMetrics::getMetricDataType ( int  iMetric)

◆ getMetricID() [1/4]

int DSSTabularMetrics::getMetricID ( int  iMetric,
GUID orMetricID 
)

◆ getMetricID() [2/4]

int DSSTabularMetrics::getMetricID ( int  iMetric,
GUID orMetricID 
)

◆ getMetricID() [3/4]

const GUID& DSSTabularMetrics::getMetricID ( int  iMetric)

◆ getMetricID() [4/4]

const GUID& DSSTabularMetrics::getMetricID ( int  iMetric)

◆ getSliceList() [1/2]

vector< DSSCubeDataSlice * > & DSSTabularMetrics::getSliceList ( )
inline

◆ getSliceList() [2/2]

vector<DSSCubeDataSlice *>& DSSTabularMetrics::getSliceList ( )

◆ getTotalImplementation() [1/2]

EnumDSSMetricType DSSTabularMetrics::getTotalImplementation ( int  iMetric)

◆ getTotalImplementation() [2/2]

EnumDSSMetricType DSSTabularMetrics::getTotalImplementation ( int  iMetric)

◆ getTotalImplID() [1/2]

GUID DSSTabularMetrics::getTotalImplID ( int  index)

◆ getTotalImplID() [2/2]

GUID DSSTabularMetrics::getTotalImplID ( int  index)

◆ Init() [1/2]

int DSSTabularMetrics::Init ( int  index,
int  nMetrics 
)

◆ Init() [2/2]

int DSSTabularMetrics::Init ( int  index,
int  nMetrics 
)

◆ ItemC() [1/2]

int DSSTabularMetrics::ItemC ( int  index,
DSSCubeDataSlice **  oppCubeSlice 
)

◆ ItemC() [2/2]

int DSSTabularMetrics::ItemC ( int  index,
DSSCubeDataSlice **  oppCubeSlice 
)

◆ setAggInfo() [1/2]

int DSSTabularMetrics::setAggInfo ( vector< GUID > &  ivAggAttr,
vector< EnumDSSAggregation > &  ivAggFunc 
)

◆ setAggInfo() [2/2]

int DSSTabularMetrics::setAggInfo ( vector< GUID > &  ivAggAttr,
vector< EnumDSSAggregation > &  ivAggFunc 
)

◆ setAvailableSubtotals() [1/2]

int DSSTabularMetrics::setAvailableSubtotals ( int  iSystemSubtotal,
vector< GUID iUserDefinedSubtotals 
)

◆ setAvailableSubtotals() [2/2]

int DSSTabularMetrics::setAvailableSubtotals ( int  iSystemSubtotal,
vector< GUID iUserDefinedSubtotals 
)

◆ setDisplayedMetricIDs() [1/2]

int DSSTabularMetrics::setDisplayedMetricIDs ( vector< GUID iGUIDs)

◆ setDisplayedMetricIDs() [2/2]

int DSSTabularMetrics::setDisplayedMetricIDs ( vector< GUID iGUIDs)

◆ setDynamicAggFunc() [1/2]

int DSSTabularMetrics::setDynamicAggFunc ( EnumDSSMetricType  iFunc)

◆ setDynamicAggFunc() [2/2]

int DSSTabularMetrics::setDynamicAggFunc ( EnumDSSMetricType  iFunc)

◆ setDynamicAggID() [1/2]

int DSSTabularMetrics::setDynamicAggID ( GUID  iDAImplID)

◆ setDynamicAggID() [2/2]

int DSSTabularMetrics::setDynamicAggID ( GUID  iDAImplID)

◆ setTotalImplID() [1/2]

int DSSTabularMetrics::setTotalImplID ( GUID  iTotalImplID)

◆ setTotalImplID() [2/2]

int DSSTabularMetrics::setTotalImplID ( GUID  iTotalImplID)

◆ size() [1/2]

virtual int DSSTabularMetrics::size ( )
virtual

Reimplemented from DSSTabularUnit.

◆ size() [2/2]

virtual int DSSTabularMetrics::size ( )
virtual

Reimplemented from DSSTabularUnit.