Mobile API Reference  MicroStrategy 2019
DSSTemplateMetrics Class Reference

#include <DSSTemplateMetrics.h>

Inheritance diagram for DSSTemplateMetrics:
DSSTemplateUnit DSSTemplateUnit DSSSecondClassObject DSSSecondClassObject DSSSecondClassObject DSSSecondClassObject

Public Member Functions

 DSSTemplateMetrics ()
 
virtual ~DSSTemplateMetrics ()
 
 DSSTemplateMetrics (DSSObjectContext *ipObjectContext)
 
int Count ()
 
DSSTemplateMetricItem (int iIndex)
 
DSSTemplateMetricItemByGUID (GUID iGuid)
 
void Add (DSSTemplateMetric *iTemplateMetric, int iIndex)
 
void Remove (int iIndex)
 
void Move (DSSTemplateMetric *iTemplateMetric, int iPos)
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex, DSSAxis *ipAxis)
 
EnumUnitTransactionFlags IsEditable ()
 
EnumUnitTransactionFlags IsRequired ()
 
 DSSTemplateMetrics ()
 
virtual ~DSSTemplateMetrics ()
 
 DSSTemplateMetrics (DSSObjectContext *ipObjectContext)
 
int Count ()
 
DSSTemplateMetricItem (int iIndex)
 
DSSTemplateMetricItemByGUID (GUID iGuid)
 
void Add (DSSTemplateMetric *iTemplateMetric, int iIndex)
 
void Remove (int iIndex)
 
void Move (DSSTemplateMetric *iTemplateMetric, int iPos)
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex, DSSAxis *ipAxis)
 
EnumUnitTransactionFlags IsEditable ()
 
EnumUnitTransactionFlags IsRequired ()
 
- Public Member Functions inherited from DSSTemplateUnit
 DSSTemplateUnit ()
 
virtual ~DSSTemplateUnit ()
 
 DSSTemplateUnit (DSSObjectContext *ipObjectContext)
 
EnumDSSTemplateUnitType getType ()
 
void setType (EnumDSSTemplateUnitType iType)
 
DSSAxisgetAxis ()
 
int getIndex ()
 
std::string & getAliasRef ()
 
std::string getAlias ()
 
GUID getID ()
 
void setID (GUID &iGUID)
 
std::string getUnitData ()
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex, DSSAxis *ipAxis)
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader)
 
DSSObjectInfogetObject ()
 
int getColumnWidth (int iDepth)
 
DSSFormatgetHeaderFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetGridFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetSubtotalHeaderFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetSubtotalGridFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
bool getHasDataHeaderFormat ()
 
bool getHasDataGridFormat ()
 
int getResolvedFormatRefID (int iIndex)
 
void setResolvedFormatRefID (int iIndex, int iFormatRefID)
 
void setHasDataHeaderFormat (bool ibHasDataHeaderFormat)
 
void setHasDataGridFormat (bool ibHasDataGridFormat)
 
void setAlias (std::string iAlias)
 
DSSDrillPathRefsgetDrillPaths ()
 
void setAxis (DSSAxis *ipAxis)
 
int getColumnWidths (int iDepth)
 
void setColumnWidths (int iDepth, int iWidth)
 
virtual int getColumnIndex ()
 
virtual int getOfflineColumnIndex ()
 
virtual bool IsMappedForTransaction ()
 
virtual bool IsMappedForOfflineTransaction ()
 
void setIndex (int iIndex)
 
void IncreaseIndex ()
 
void DecreaseIndex ()
 
virtual bool IsInvalidateResolvedFormat ()
 
virtual void SetInvalidateResolvedFormat (bool iInvalidate)
 
DSSFormatgetFormat (int iFormatType, bool iIsReadOnly=true)
 
std::map< int, int > getColumnWidths ()
 
void Duplicate (DSSTemplateUnit *ipUnit, DSSAxis *ipAxis=NULL)
 
void clone (DSSTemplateUnit *ipUnit, DSSAxis *ipAxis)
 
void duplicateFormat (DSSTemplateUnit *ipUnit)
 
void clearFormat ()
 
bool isPushedDown ()
 
GUID getReplaceByUnitID ()
 
void pushDown ()
 
void setReplaceByUnitID (GUID iID)
 
void setRecursive ()
 
bool isRecursive ()
 
std::vector< int > & getSubtotalTypes ()
 
void setSubtotalTypes (std::vector< int > iSubtotalTypes)
 
 DSSTemplateUnit ()
 
virtual ~DSSTemplateUnit ()
 
 DSSTemplateUnit (DSSObjectContext *ipObjectContext)
 
EnumDSSTemplateUnitType getType ()
 
void setType (EnumDSSTemplateUnitType iType)
 
DSSAxisgetAxis ()
 
int getIndex ()
 
std::string & getAliasRef ()
 
std::string getAlias ()
 
GUID getID ()
 
void setID (GUID &iGUID)
 
std::string getUnitData ()
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex, DSSAxis *ipAxis)
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader)
 
DSSObjectInfogetObject ()
 
int getColumnWidth (int iDepth)
 
DSSFormatgetHeaderFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetGridFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetSubtotalHeaderFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetSubtotalGridFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
bool getHasDataHeaderFormat ()
 
bool getHasDataGridFormat ()
 
int getResolvedFormatRefID (int iIndex)
 
void setResolvedFormatRefID (int iIndex, int iFormatRefID)
 
void setHasDataHeaderFormat (bool ibHasDataHeaderFormat)
 
void setHasDataGridFormat (bool ibHasDataGridFormat)
 
void setAlias (std::string iAlias)
 
DSSDrillPathRefsgetDrillPaths ()
 
void setAxis (DSSAxis *ipAxis)
 
int getColumnWidths (int iDepth)
 
void setColumnWidths (int iDepth, int iWidth)
 
virtual int getColumnIndex ()
 
virtual int getOfflineColumnIndex ()
 
virtual bool IsMappedForTransaction ()
 
virtual bool IsMappedForOfflineTransaction ()
 
void setIndex (int iIndex)
 
void IncreaseIndex ()
 
void DecreaseIndex ()
 
virtual bool IsInvalidateResolvedFormat ()
 
virtual void SetInvalidateResolvedFormat (bool iInvalidate)
 
DSSFormatgetFormat (int iFormatType, bool iIsReadOnly=true)
 
std::map< int, int > getColumnWidths ()
 
void Duplicate (DSSTemplateUnit *ipUnit, DSSAxis *ipAxis=NULL)
 
void clone (DSSTemplateUnit *ipUnit, DSSAxis *ipAxis)
 
void duplicateFormat (DSSTemplateUnit *ipUnit)
 
void clearFormat ()
 
bool isPushedDown ()
 
GUID getReplaceByUnitID ()
 
void pushDown ()
 
void setReplaceByUnitID (GUID iID)
 
void setRecursive ()
 
bool isRecursive ()
 
std::vector< int > & getSubtotalTypes ()
 
void setSubtotalTypes (std::vector< int > iSubtotalTypes)
 
- Public Member Functions inherited from DSSSecondClassObject
 DSSSecondClassObject ()
 
virtual ~DSSSecondClassObject ()
 
 DSSSecondClassObject (DSSObjectContext *ipObjectContext)
 
DSSObjectContextgetObjectContext ()
 
 DSSSecondClassObject ()
 
virtual ~DSSSecondClassObject ()
 
 DSSSecondClassObject (DSSObjectContext *ipObjectContext)
 
DSSObjectContextgetObjectContext ()
 

Additional Inherited Members

- Protected Attributes inherited from DSSTemplateUnit
EnumDSSTemplateUnitType mType
 
GUID mID
 
std::string mAlias
 
std::string mUnitData
 
int mIndex
 
bool mbHasAlias
 
bool mIsPushedDown
 
GUID mReplacedByUnitID
 
bool mIsRecursive
 
- Protected Attributes inherited from DSSSecondClassObject
DSSObjectContextmpObjectContext
 

Constructor & Destructor Documentation

◆ DSSTemplateMetrics() [1/4]

DSSTemplateMetrics::DSSTemplateMetrics ( )

◆ ~DSSTemplateMetrics() [1/2]

virtual DSSTemplateMetrics::~DSSTemplateMetrics ( )
virtual

◆ DSSTemplateMetrics() [2/4]

DSSTemplateMetrics::DSSTemplateMetrics ( DSSObjectContext ipObjectContext)

◆ DSSTemplateMetrics() [3/4]

DSSTemplateMetrics::DSSTemplateMetrics ( )

◆ ~DSSTemplateMetrics() [2/2]

virtual DSSTemplateMetrics::~DSSTemplateMetrics ( )
virtual

◆ DSSTemplateMetrics() [4/4]

DSSTemplateMetrics::DSSTemplateMetrics ( DSSObjectContext ipObjectContext)

Member Function Documentation

◆ Add() [1/2]

void DSSTemplateMetrics::Add ( DSSTemplateMetric iTemplateMetric,
int  iIndex 
)

◆ Add() [2/2]

void DSSTemplateMetrics::Add ( DSSTemplateMetric iTemplateMetric,
int  iIndex 
)

◆ Count() [1/2]

int DSSTemplateMetrics::Count ( )

◆ Count() [2/2]

int DSSTemplateMetrics::Count ( )

◆ IsEditable() [1/2]

EnumUnitTransactionFlags DSSTemplateMetrics::IsEditable ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsEditable() [2/2]

EnumUnitTransactionFlags DSSTemplateMetrics::IsEditable ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequired() [1/2]

EnumUnitTransactionFlags DSSTemplateMetrics::IsRequired ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequired() [2/2]

EnumUnitTransactionFlags DSSTemplateMetrics::IsRequired ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ Item() [1/2]

DSSTemplateMetric* DSSTemplateMetrics::Item ( int  iIndex)

◆ Item() [2/2]

DSSTemplateMetric* DSSTemplateMetrics::Item ( int  iIndex)

◆ ItemByGUID() [1/2]

DSSTemplateMetric* DSSTemplateMetrics::ItemByGUID ( GUID  iGuid)

◆ ItemByGUID() [2/2]

DSSTemplateMetric* DSSTemplateMetrics::ItemByGUID ( GUID  iGuid)

◆ LoadDefnFromBinary() [1/2]

int DSSTemplateMetrics::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
int  iIndex,
DSSAxis ipAxis 
)

◆ LoadDefnFromBinary() [2/2]

int DSSTemplateMetrics::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
int  iIndex,
DSSAxis ipAxis 
)

◆ Move() [1/2]

void DSSTemplateMetrics::Move ( DSSTemplateMetric iTemplateMetric,
int  iPos 
)

◆ Move() [2/2]

void DSSTemplateMetrics::Move ( DSSTemplateMetric iTemplateMetric,
int  iPos 
)

◆ Remove() [1/2]

void DSSTemplateMetrics::Remove ( int  iIndex)

◆ Remove() [2/2]

void DSSTemplateMetrics::Remove ( int  iIndex)