Mobile API Reference  MicroStrategy 2019
DSSTemplateMetric Class Reference

#include <DSSTemplateMetric.h>

Inheritance diagram for DSSTemplateMetric:
DSSTemplateUnit DSSTemplateUnit DSSSecondClassObject DSSSecondClassObject DSSSecondClassObject DSSSecondClassObject

Public Member Functions

int getMetricWidth ()
 
 DSSTemplateMetric ()
 
virtual ~DSSTemplateMetric ()
 
 DSSTemplateMetric (DSSObjectContext *ipObjectContext)
 
DSSMetricgetMetric ()
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex)
 
DSSFormatgetHeaderFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetGridFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSThresholdsgetThresholds ()
 
void setThreholds (DSSThresholds *iThresholds)
 
void setResolvedFormatRefID (int iIndex, int iFormatRefID)
 
void setFormatRefID (int iIndex, int iFormatRefID)
 
EnumUnitTransactionFlags IsEditable ()
 
EnumUnitTransactionFlags IsRequired ()
 
int getColumnIndex ()
 
std::string getInputFormat ()
 
std::string getInputControlKey ()
 
DSSRWControlgetInputControl ()
 
DSSFormatgetFormat (int iFormatType, bool isReadOnly=true)
 
int getColumnWidth ()
 
void Duplicate (DSSTemplateMetric *ipMetric)
 
DSSCExpressiongetLimitExpression ()
 
void setLimitExpression (DSSCExpression *ipLimitExpression)
 
int getOfflineColumnIndex ()
 
DSSCExpressiongetRuntimeLimitExpression ()
 
void setRuntimeLimitExpression (DSSCExpression *ipLimitExpression)
 
DSSModelsgetModels ()
 
const DSSModelsgetModels () const
 
const CComVariantgetForecastBackward () const
 
const CComVariantgetForecastForward () const
 
bool getIsDuplicatedRuntimeMetric ()
 
bool getForecastEnable ()
 
bool getDssReportXml2RawDates ()
 
int getPosInCalcPlan ()
 
void setPosInCalcPlan (int iPosInCalcPlan)
 
int getMetricWidth ()
 
 DSSTemplateMetric ()
 
virtual ~DSSTemplateMetric ()
 
 DSSTemplateMetric (DSSObjectContext *ipObjectContext)
 
DSSMetricgetMetric ()
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex)
 
DSSFormatgetHeaderFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSFormatgetGridFormat (bool ibUseResolved=false, bool ibOriginal=false)
 
DSSThresholdsgetThresholds ()
 
void setThreholds (DSSThresholds *iThresholds)
 
void setResolvedFormatRefID (int iIndex, int iFormatRefID)
 
void setFormatRefID (int iIndex, int iFormatRefID)
 
EnumUnitTransactionFlags IsEditable ()
 
EnumUnitTransactionFlags IsRequired ()
 
int getColumnIndex ()
 
std::string getInputFormat ()
 
std::string getInputControlKey ()
 
DSSRWControlgetInputControl ()
 
DSSFormatgetFormat (int iFormatType, bool isReadOnly=true)
 
int getColumnWidth ()
 
void Duplicate (DSSTemplateMetric *ipMetric)
 
DSSCExpressiongetLimitExpression ()
 
void setLimitExpression (DSSCExpression *ipLimitExpression)
 
int getOfflineColumnIndex ()
 
DSSCExpressiongetRuntimeLimitExpression ()
 
void setRuntimeLimitExpression (DSSCExpression *ipLimitExpression)
 
DSSModelsgetModels ()
 
const DSSModelsgetModels () const
 
const CComVariantgetForecastBackward () const
 
const CComVariantgetForecastForward () const
 
bool getIsDuplicatedRuntimeMetric ()
 
bool getForecastEnable ()
 
bool getDssReportXml2RawDates ()
 
int getPosInCalcPlan ()
 
void setPosInCalcPlan (int iPosInCalcPlan)
 
- 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 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 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

◆ DSSTemplateMetric() [1/4]

DSSTemplateMetric::DSSTemplateMetric ( )

◆ ~DSSTemplateMetric() [1/2]

virtual DSSTemplateMetric::~DSSTemplateMetric ( )
virtual

◆ DSSTemplateMetric() [2/4]

DSSTemplateMetric::DSSTemplateMetric ( DSSObjectContext ipObjectContext)

◆ DSSTemplateMetric() [3/4]

DSSTemplateMetric::DSSTemplateMetric ( )

◆ ~DSSTemplateMetric() [2/2]

virtual DSSTemplateMetric::~DSSTemplateMetric ( )
virtual

◆ DSSTemplateMetric() [4/4]

DSSTemplateMetric::DSSTemplateMetric ( DSSObjectContext ipObjectContext)

Member Function Documentation

◆ Duplicate() [1/2]

void DSSTemplateMetric::Duplicate ( DSSTemplateMetric ipMetric)

◆ Duplicate() [2/2]

void DSSTemplateMetric::Duplicate ( DSSTemplateMetric ipMetric)

◆ getColumnIndex() [1/2]

int DSSTemplateMetric::getColumnIndex ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ getColumnIndex() [2/2]

int DSSTemplateMetric::getColumnIndex ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ getColumnWidth() [1/2]

int DSSTemplateMetric::getColumnWidth ( )

◆ getColumnWidth() [2/2]

int DSSTemplateMetric::getColumnWidth ( )

◆ getDssReportXml2RawDates() [1/2]

bool DSSTemplateMetric::getDssReportXml2RawDates ( )
inline

◆ getDssReportXml2RawDates() [2/2]

bool DSSTemplateMetric::getDssReportXml2RawDates ( )
inline

◆ getForecastBackward() [1/2]

const CComVariant& DSSTemplateMetric::getForecastBackward ( ) const
inline

◆ getForecastBackward() [2/2]

const CComVariant& DSSTemplateMetric::getForecastBackward ( ) const
inline

◆ getForecastEnable() [1/2]

bool DSSTemplateMetric::getForecastEnable ( )
inline

◆ getForecastEnable() [2/2]

bool DSSTemplateMetric::getForecastEnable ( )
inline

◆ getForecastForward() [1/2]

const CComVariant& DSSTemplateMetric::getForecastForward ( ) const
inline

◆ getForecastForward() [2/2]

const CComVariant& DSSTemplateMetric::getForecastForward ( ) const
inline

◆ getFormat() [1/2]

DSSFormat* DSSTemplateMetric::getFormat ( int  iFormatType,
bool  isReadOnly = true 
)

◆ getFormat() [2/2]

DSSFormat* DSSTemplateMetric::getFormat ( int  iFormatType,
bool  isReadOnly = true 
)

◆ getGridFormat() [1/2]

DSSFormat* DSSTemplateMetric::getGridFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getGridFormat() [2/2]

DSSFormat* DSSTemplateMetric::getGridFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getHeaderFormat() [1/2]

DSSFormat* DSSTemplateMetric::getHeaderFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getHeaderFormat() [2/2]

DSSFormat* DSSTemplateMetric::getHeaderFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getInputControl() [1/2]

DSSRWControl* DSSTemplateMetric::getInputControl ( )

◆ getInputControl() [2/2]

DSSRWControl* DSSTemplateMetric::getInputControl ( )

◆ getInputControlKey() [1/2]

std::string DSSTemplateMetric::getInputControlKey ( )

◆ getInputControlKey() [2/2]

std::string DSSTemplateMetric::getInputControlKey ( )

◆ getInputFormat() [1/2]

std::string DSSTemplateMetric::getInputFormat ( )

◆ getInputFormat() [2/2]

std::string DSSTemplateMetric::getInputFormat ( )

◆ getIsDuplicatedRuntimeMetric() [1/2]

bool DSSTemplateMetric::getIsDuplicatedRuntimeMetric ( )
inline

◆ getIsDuplicatedRuntimeMetric() [2/2]

bool DSSTemplateMetric::getIsDuplicatedRuntimeMetric ( )
inline

◆ getLimitExpression() [1/2]

DSSCExpression* DSSTemplateMetric::getLimitExpression ( )

◆ getLimitExpression() [2/2]

DSSCExpression* DSSTemplateMetric::getLimitExpression ( )

◆ getMetric() [1/2]

DSSMetric* DSSTemplateMetric::getMetric ( )

◆ getMetric() [2/2]

DSSMetric* DSSTemplateMetric::getMetric ( )

◆ getMetricWidth() [1/2]

int DSSTemplateMetric::getMetricWidth ( )

◆ getMetricWidth() [2/2]

int DSSTemplateMetric::getMetricWidth ( )

◆ getModels() [1/4]

DSSModels* DSSTemplateMetric::getModels ( )
inline

◆ getModels() [2/4]

DSSModels* DSSTemplateMetric::getModels ( )
inline

◆ getModels() [3/4]

const DSSModels* DSSTemplateMetric::getModels ( ) const
inline

◆ getModels() [4/4]

const DSSModels* DSSTemplateMetric::getModels ( ) const
inline

◆ getOfflineColumnIndex() [1/2]

int DSSTemplateMetric::getOfflineColumnIndex ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ getOfflineColumnIndex() [2/2]

int DSSTemplateMetric::getOfflineColumnIndex ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ getPosInCalcPlan() [1/2]

int DSSTemplateMetric::getPosInCalcPlan ( )
inline

◆ getPosInCalcPlan() [2/2]

int DSSTemplateMetric::getPosInCalcPlan ( )
inline

◆ getRuntimeLimitExpression() [1/2]

DSSCExpression* DSSTemplateMetric::getRuntimeLimitExpression ( )

◆ getRuntimeLimitExpression() [2/2]

DSSCExpression* DSSTemplateMetric::getRuntimeLimitExpression ( )

◆ getThresholds() [1/2]

DSSThresholds* DSSTemplateMetric::getThresholds ( )

◆ getThresholds() [2/2]

DSSThresholds* DSSTemplateMetric::getThresholds ( )

◆ IsEditable() [1/2]

EnumUnitTransactionFlags DSSTemplateMetric::IsEditable ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsEditable() [2/2]

EnumUnitTransactionFlags DSSTemplateMetric::IsEditable ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequired() [1/2]

EnumUnitTransactionFlags DSSTemplateMetric::IsRequired ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequired() [2/2]

EnumUnitTransactionFlags DSSTemplateMetric::IsRequired ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ LoadDefnFromBinary() [1/2]

int DSSTemplateMetric::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
int  iIndex 
)

◆ LoadDefnFromBinary() [2/2]

int DSSTemplateMetric::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
int  iIndex 
)

◆ setFormatRefID() [1/2]

void DSSTemplateMetric::setFormatRefID ( int  iIndex,
int  iFormatRefID 
)

◆ setFormatRefID() [2/2]

void DSSTemplateMetric::setFormatRefID ( int  iIndex,
int  iFormatRefID 
)

◆ setLimitExpression() [1/2]

void DSSTemplateMetric::setLimitExpression ( DSSCExpression ipLimitExpression)

◆ setLimitExpression() [2/2]

void DSSTemplateMetric::setLimitExpression ( DSSCExpression ipLimitExpression)

◆ setPosInCalcPlan() [1/2]

void DSSTemplateMetric::setPosInCalcPlan ( int  iPosInCalcPlan)
inline

◆ setPosInCalcPlan() [2/2]

void DSSTemplateMetric::setPosInCalcPlan ( int  iPosInCalcPlan)
inline

◆ setResolvedFormatRefID() [1/2]

void DSSTemplateMetric::setResolvedFormatRefID ( int  iIndex,
int  iFormatRefID 
)

◆ setResolvedFormatRefID() [2/2]

void DSSTemplateMetric::setResolvedFormatRefID ( int  iIndex,
int  iFormatRefID 
)

◆ setRuntimeLimitExpression() [1/2]

void DSSTemplateMetric::setRuntimeLimitExpression ( DSSCExpression ipLimitExpression)

◆ setRuntimeLimitExpression() [2/2]

void DSSTemplateMetric::setRuntimeLimitExpression ( DSSCExpression ipLimitExpression)

◆ setThreholds() [1/2]

void DSSTemplateMetric::setThreholds ( DSSThresholds iThresholds)

◆ setThreholds() [2/2]

void DSSTemplateMetric::setThreholds ( DSSThresholds iThresholds)