Mobile API Reference  MicroStrategy 2019
DSSTemplateUnit Class Reference

#include <DSSTemplateUnit.h>

Inheritance diagram for DSSTemplateUnit:
DSSSecondClassObject DSSSecondClassObject DSSTemplateAttribute DSSTemplateAttribute DSSTemplateConsolidation DSSTemplateConsolidation DSSTemplateCustomGroup DSSTemplateCustomGroup DSSTemplateDimension DSSTemplateDimension DSSTemplateMetric DSSTemplateMetric DSSTemplateMetrics DSSTemplateMetrics

Public Member Functions

 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 EnumUnitTransactionFlags IsEditable ()
 
virtual EnumUnitTransactionFlags IsRequired ()
 
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 EnumUnitTransactionFlags IsEditable ()
 
virtual EnumUnitTransactionFlags IsRequired ()
 
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 ()
 

Protected Attributes

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

◆ DSSTemplateUnit() [1/4]

DSSTemplateUnit::DSSTemplateUnit ( )

◆ ~DSSTemplateUnit() [1/2]

virtual DSSTemplateUnit::~DSSTemplateUnit ( )
virtual

◆ DSSTemplateUnit() [2/4]

DSSTemplateUnit::DSSTemplateUnit ( DSSObjectContext ipObjectContext)

◆ DSSTemplateUnit() [3/4]

DSSTemplateUnit::DSSTemplateUnit ( )

◆ ~DSSTemplateUnit() [2/2]

virtual DSSTemplateUnit::~DSSTemplateUnit ( )
virtual

◆ DSSTemplateUnit() [4/4]

DSSTemplateUnit::DSSTemplateUnit ( DSSObjectContext ipObjectContext)

Member Function Documentation

◆ clearFormat() [1/2]

void DSSTemplateUnit::clearFormat ( )

◆ clearFormat() [2/2]

void DSSTemplateUnit::clearFormat ( )

◆ clone() [1/2]

void DSSTemplateUnit::clone ( DSSTemplateUnit ipUnit,
DSSAxis ipAxis 
)

◆ clone() [2/2]

void DSSTemplateUnit::clone ( DSSTemplateUnit ipUnit,
DSSAxis ipAxis 
)

◆ DecreaseIndex() [1/2]

void DSSTemplateUnit::DecreaseIndex ( )

◆ DecreaseIndex() [2/2]

void DSSTemplateUnit::DecreaseIndex ( )

◆ Duplicate() [1/2]

void DSSTemplateUnit::Duplicate ( DSSTemplateUnit ipUnit,
DSSAxis ipAxis = NULL 
)

◆ Duplicate() [2/2]

void DSSTemplateUnit::Duplicate ( DSSTemplateUnit ipUnit,
DSSAxis ipAxis = NULL 
)

◆ duplicateFormat() [1/2]

void DSSTemplateUnit::duplicateFormat ( DSSTemplateUnit ipUnit)

◆ duplicateFormat() [2/2]

void DSSTemplateUnit::duplicateFormat ( DSSTemplateUnit ipUnit)

◆ getAlias() [1/2]

std::string DSSTemplateUnit::getAlias ( )

◆ getAlias() [2/2]

std::string DSSTemplateUnit::getAlias ( )

◆ getAliasRef() [1/2]

std::string& DSSTemplateUnit::getAliasRef ( )

◆ getAliasRef() [2/2]

std::string& DSSTemplateUnit::getAliasRef ( )

◆ getAxis() [1/2]

DSSAxis* DSSTemplateUnit::getAxis ( )

◆ getAxis() [2/2]

DSSAxis* DSSTemplateUnit::getAxis ( )

◆ getColumnIndex() [1/2]

virtual int DSSTemplateUnit::getColumnIndex ( )
virtual

Reimplemented in DSSTemplateMetric, and DSSTemplateMetric.

◆ getColumnIndex() [2/2]

virtual int DSSTemplateUnit::getColumnIndex ( )
virtual

Reimplemented in DSSTemplateMetric, and DSSTemplateMetric.

◆ getColumnWidth() [1/2]

int DSSTemplateUnit::getColumnWidth ( int  iDepth)

◆ getColumnWidth() [2/2]

int DSSTemplateUnit::getColumnWidth ( int  iDepth)

◆ getColumnWidths() [1/4]

int DSSTemplateUnit::getColumnWidths ( int  iDepth)

◆ getColumnWidths() [2/4]

int DSSTemplateUnit::getColumnWidths ( int  iDepth)

◆ getColumnWidths() [3/4]

std::map<int, int> DSSTemplateUnit::getColumnWidths ( )

◆ getColumnWidths() [4/4]

std::map<int, int> DSSTemplateUnit::getColumnWidths ( )

◆ getDrillPaths() [1/2]

DSSDrillPathRefs* DSSTemplateUnit::getDrillPaths ( )

◆ getDrillPaths() [2/2]

DSSDrillPathRefs* DSSTemplateUnit::getDrillPaths ( )

◆ getFormat() [1/2]

DSSFormat* DSSTemplateUnit::getFormat ( int  iFormatType,
bool  iIsReadOnly = true 
)

◆ getFormat() [2/2]

DSSFormat* DSSTemplateUnit::getFormat ( int  iFormatType,
bool  iIsReadOnly = true 
)

◆ getGridFormat() [1/2]

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

◆ getGridFormat() [2/2]

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

◆ getHasDataGridFormat() [1/2]

bool DSSTemplateUnit::getHasDataGridFormat ( )

◆ getHasDataGridFormat() [2/2]

bool DSSTemplateUnit::getHasDataGridFormat ( )

◆ getHasDataHeaderFormat() [1/2]

bool DSSTemplateUnit::getHasDataHeaderFormat ( )

◆ getHasDataHeaderFormat() [2/2]

bool DSSTemplateUnit::getHasDataHeaderFormat ( )

◆ getHeaderFormat() [1/2]

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

◆ getHeaderFormat() [2/2]

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

◆ getID() [1/2]

GUID DSSTemplateUnit::getID ( )

◆ getID() [2/2]

GUID DSSTemplateUnit::getID ( )

◆ getIndex() [1/2]

int DSSTemplateUnit::getIndex ( )

◆ getIndex() [2/2]

int DSSTemplateUnit::getIndex ( )

◆ getObject() [1/2]

DSSObjectInfo* DSSTemplateUnit::getObject ( )

◆ getObject() [2/2]

DSSObjectInfo* DSSTemplateUnit::getObject ( )

◆ getOfflineColumnIndex() [1/2]

virtual int DSSTemplateUnit::getOfflineColumnIndex ( )
virtual

Reimplemented in DSSTemplateMetric, and DSSTemplateMetric.

◆ getOfflineColumnIndex() [2/2]

virtual int DSSTemplateUnit::getOfflineColumnIndex ( )
virtual

Reimplemented in DSSTemplateMetric, and DSSTemplateMetric.

◆ getReplaceByUnitID() [1/2]

GUID DSSTemplateUnit::getReplaceByUnitID ( )

◆ getReplaceByUnitID() [2/2]

GUID DSSTemplateUnit::getReplaceByUnitID ( )

◆ getResolvedFormatRefID() [1/2]

int DSSTemplateUnit::getResolvedFormatRefID ( int  iIndex)

◆ getResolvedFormatRefID() [2/2]

int DSSTemplateUnit::getResolvedFormatRefID ( int  iIndex)

◆ getSubtotalGridFormat() [1/2]

DSSFormat* DSSTemplateUnit::getSubtotalGridFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getSubtotalGridFormat() [2/2]

DSSFormat* DSSTemplateUnit::getSubtotalGridFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getSubtotalHeaderFormat() [1/2]

DSSFormat* DSSTemplateUnit::getSubtotalHeaderFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getSubtotalHeaderFormat() [2/2]

DSSFormat* DSSTemplateUnit::getSubtotalHeaderFormat ( bool  ibUseResolved = false,
bool  ibOriginal = false 
)

◆ getSubtotalTypes() [1/2]

std::vector<int>& DSSTemplateUnit::getSubtotalTypes ( )
inline

◆ getSubtotalTypes() [2/2]

std::vector<int>& DSSTemplateUnit::getSubtotalTypes ( )
inline

◆ getType() [1/2]

EnumDSSTemplateUnitType DSSTemplateUnit::getType ( )

◆ getType() [2/2]

EnumDSSTemplateUnitType DSSTemplateUnit::getType ( )

◆ getUnitData() [1/2]

std::string DSSTemplateUnit::getUnitData ( )

◆ getUnitData() [2/2]

std::string DSSTemplateUnit::getUnitData ( )

◆ IncreaseIndex() [1/2]

void DSSTemplateUnit::IncreaseIndex ( )

◆ IncreaseIndex() [2/2]

void DSSTemplateUnit::IncreaseIndex ( )

◆ IsEditable() [1/2]

◆ IsEditable() [2/2]

◆ IsInvalidateResolvedFormat() [1/2]

virtual bool DSSTemplateUnit::IsInvalidateResolvedFormat ( )
virtual

◆ IsInvalidateResolvedFormat() [2/2]

virtual bool DSSTemplateUnit::IsInvalidateResolvedFormat ( )
virtual

◆ IsMappedForOfflineTransaction() [1/2]

virtual bool DSSTemplateUnit::IsMappedForOfflineTransaction ( )
virtual

◆ IsMappedForOfflineTransaction() [2/2]

virtual bool DSSTemplateUnit::IsMappedForOfflineTransaction ( )
virtual

◆ IsMappedForTransaction() [1/2]

virtual bool DSSTemplateUnit::IsMappedForTransaction ( )
virtual

◆ IsMappedForTransaction() [2/2]

virtual bool DSSTemplateUnit::IsMappedForTransaction ( )
virtual

◆ isPushedDown() [1/2]

bool DSSTemplateUnit::isPushedDown ( )

◆ isPushedDown() [2/2]

bool DSSTemplateUnit::isPushedDown ( )

◆ isRecursive() [1/2]

bool DSSTemplateUnit::isRecursive ( )

◆ isRecursive() [2/2]

bool DSSTemplateUnit::isRecursive ( )

◆ IsRequired() [1/2]

◆ IsRequired() [2/2]

◆ LoadDefnFromBinary() [1/4]

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

◆ LoadDefnFromBinary() [2/4]

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

◆ LoadDefnFromBinary() [3/4]

int DSSTemplateUnit::LoadDefnFromBinary ( DSSBinaryDataReader ipReader)

◆ LoadDefnFromBinary() [4/4]

int DSSTemplateUnit::LoadDefnFromBinary ( DSSBinaryDataReader ipReader)

◆ pushDown() [1/2]

void DSSTemplateUnit::pushDown ( )

◆ pushDown() [2/2]

void DSSTemplateUnit::pushDown ( )

◆ setAlias() [1/2]

void DSSTemplateUnit::setAlias ( std::string  iAlias)

◆ setAlias() [2/2]

void DSSTemplateUnit::setAlias ( std::string  iAlias)

◆ setAxis() [1/2]

void DSSTemplateUnit::setAxis ( DSSAxis ipAxis)

◆ setAxis() [2/2]

void DSSTemplateUnit::setAxis ( DSSAxis ipAxis)

◆ setColumnWidths() [1/2]

void DSSTemplateUnit::setColumnWidths ( int  iDepth,
int  iWidth 
)

◆ setColumnWidths() [2/2]

void DSSTemplateUnit::setColumnWidths ( int  iDepth,
int  iWidth 
)

◆ setHasDataGridFormat() [1/2]

void DSSTemplateUnit::setHasDataGridFormat ( bool  ibHasDataGridFormat)

◆ setHasDataGridFormat() [2/2]

void DSSTemplateUnit::setHasDataGridFormat ( bool  ibHasDataGridFormat)

◆ setHasDataHeaderFormat() [1/2]

void DSSTemplateUnit::setHasDataHeaderFormat ( bool  ibHasDataHeaderFormat)

◆ setHasDataHeaderFormat() [2/2]

void DSSTemplateUnit::setHasDataHeaderFormat ( bool  ibHasDataHeaderFormat)

◆ setID() [1/2]

void DSSTemplateUnit::setID ( GUID iGUID)

◆ setID() [2/2]

void DSSTemplateUnit::setID ( GUID iGUID)

◆ setIndex() [1/2]

void DSSTemplateUnit::setIndex ( int  iIndex)

◆ setIndex() [2/2]

void DSSTemplateUnit::setIndex ( int  iIndex)

◆ SetInvalidateResolvedFormat() [1/2]

virtual void DSSTemplateUnit::SetInvalidateResolvedFormat ( bool  iInvalidate)
virtual

◆ SetInvalidateResolvedFormat() [2/2]

virtual void DSSTemplateUnit::SetInvalidateResolvedFormat ( bool  iInvalidate)
virtual

◆ setRecursive() [1/2]

void DSSTemplateUnit::setRecursive ( )

◆ setRecursive() [2/2]

void DSSTemplateUnit::setRecursive ( )

◆ setReplaceByUnitID() [1/2]

void DSSTemplateUnit::setReplaceByUnitID ( GUID  iID)

◆ setReplaceByUnitID() [2/2]

void DSSTemplateUnit::setReplaceByUnitID ( GUID  iID)

◆ setResolvedFormatRefID() [1/2]

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

◆ setResolvedFormatRefID() [2/2]

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

◆ setSubtotalTypes() [1/2]

void DSSTemplateUnit::setSubtotalTypes ( std::vector< int >  iSubtotalTypes)
inline

◆ setSubtotalTypes() [2/2]

void DSSTemplateUnit::setSubtotalTypes ( std::vector< int >  iSubtotalTypes)
inline

◆ setType() [1/2]

void DSSTemplateUnit::setType ( EnumDSSTemplateUnitType  iType)

◆ setType() [2/2]

void DSSTemplateUnit::setType ( EnumDSSTemplateUnitType  iType)

Member Data Documentation

◆ mAlias

std::string DSSTemplateUnit::mAlias
protected

◆ mbHasAlias

bool DSSTemplateUnit::mbHasAlias
protected

◆ mID

GUID DSSTemplateUnit::mID
protected

◆ mIndex

int DSSTemplateUnit::mIndex
protected

◆ mIsPushedDown

bool DSSTemplateUnit::mIsPushedDown
protected

◆ mIsRecursive

bool DSSTemplateUnit::mIsRecursive
protected

◆ mReplacedByUnitID

GUID DSSTemplateUnit::mReplacedByUnitID
protected

◆ mType

EnumDSSTemplateUnitType DSSTemplateUnit::mType
protected

◆ mUnitData

std::string DSSTemplateUnit::mUnitData
protected