Mobile API Reference  MicroStrategy 2019
DSSTabularUnit Class Referenceabstract

#include <DSSTabularUnit.h>

Inheritance diagram for DSSTabularUnit:
IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo IStatisticsInfo DSSTabularAttribute DSSTabularAttribute DSSTabularConsolidation DSSTabularConsolidation DSSTabularCustomGroup DSSTabularCustomGroup DSSTabularMetrics DSSTabularMetrics DSSXTabRecursiveUnit DSSXTabRecursiveUnit

Public Member Functions

 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)
 
virtual int CountRows ()=0
 
void setIsRuntimeUnit (bool val)
 
virtual bool IsRuntimeUnit ()
 
virtual bool IsRecursiveUnit ()
 
virtual int FindElement (DSSBaseElementProxy *ipElement, int &orKey)=0
 
virtual int createElement (int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement, int iGlobalKey=-1, int iGlobalKeyVer=-1)=0
 
int createSpecialElement (EnumDSSElementType iElementType, int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement)
 
void setParentInfo (DSSDataModelBase *ipModel)
 
void setNullElement (int index, MBase::CString &irElementID)
 
virtual int size ()
 
void setObjectContextRef (DSSObjectContext *ipObjContext)
 
virtual bool compareElement (DSSBaseElementProxy *ipElement, int iKey)=0
 
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)
 
virtual int CountRows ()=0
 
void setIsRuntimeUnit (bool val)
 
virtual bool IsRuntimeUnit ()
 
virtual bool IsRecursiveUnit ()
 
virtual int FindElement (DSSBaseElementProxy *ipElement, int &orKey)=0
 
virtual int createElement (int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement, int iGlobalKey=-1, int iGlobalKeyVer=-1)=0
 
int createSpecialElement (EnumDSSElementType iElementType, int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement)
 
void setParentInfo (DSSDataModelBase *ipModel)
 
void setNullElement (int index, MBase::CString &irElementID)
 
virtual int size ()
 
void setObjectContextRef (DSSObjectContext *ipObjContext)
 
virtual bool compareElement (DSSBaseElementProxy *ipElement, int iKey)=0
 
virtual int getTabularUnit (DSSTabularUnit **oppUnit)
 
virtual MBase::CString getGUIDStr ()
 
- Public Member Functions inherited from IXTABAttributeInfo
virtual int getArity ()
 
virtual int Count ()
 
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 Count ()
 
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)
 

Protected Member Functions

DSSObjectContexthGetContext ()
 
DSSBaseElementProxyhGetNullElement ()
 
DSSObjectContexthGetContext ()
 
DSSBaseElementProxyhGetNullElement ()
 

Protected Attributes

int mUnitID
 
MBase::CString mGUIDStr
 
GUID mGUID
 
EnumDSSTemplateUnitType mUnitType
 
bool mbIsRuntimeUnit
 
DSSDataModelBasempModel
 
DSSObjectContextmpObjContext
 
int mNullElementIndex
 
MBase::CString mNullElementIDStr
 
DSSBaseElementProxympNullElement
 

Constructor & Destructor Documentation

◆ DSSTabularUnit() [1/2]

DSSTabularUnit::DSSTabularUnit ( )

◆ ~DSSTabularUnit() [1/2]

virtual DSSTabularUnit::~DSSTabularUnit ( )
virtual

◆ DSSTabularUnit() [2/2]

DSSTabularUnit::DSSTabularUnit ( )

◆ ~DSSTabularUnit() [2/2]

virtual DSSTabularUnit::~DSSTabularUnit ( )
virtual

Member Function Documentation

◆ compareElement() [1/2]

◆ compareElement() [2/2]

◆ CountRows() [1/2]

◆ CountRows() [2/2]

◆ createElement() [1/2]

◆ createElement() [2/2]

◆ createSpecialElement() [1/2]

int DSSTabularUnit::createSpecialElement ( EnumDSSElementType  iElementType,
int  key,
DSSObjectContext ipObjectContext,
DSSBaseElementProxy **  oppElement 
)

◆ createSpecialElement() [2/2]

int DSSTabularUnit::createSpecialElement ( EnumDSSElementType  iElementType,
int  key,
DSSObjectContext ipObjectContext,
DSSBaseElementProxy **  oppElement 
)

◆ FindElement() [1/2]

◆ FindElement() [2/2]

◆ get_IDI() [1/2]

int DSSTabularUnit::get_IDI ( GUID opID)

◆ get_IDI() [2/2]

int DSSTabularUnit::get_IDI ( GUID opID)

◆ get_UnitType() [1/2]

int DSSTabularUnit::get_UnitType ( EnumDSSTemplateUnitType opType)

◆ get_UnitType() [2/2]

int DSSTabularUnit::get_UnitType ( EnumDSSTemplateUnitType opType)
inline

◆ getGUID() [1/4]

◆ getGUID() [2/4]

◆ getGUID() [3/4]

◆ getGUID() [4/4]

◆ getGUIDStr() [1/2]

virtual MBase::CString DSSTabularUnit::getGUIDStr ( )
inlinevirtual

◆ getGUIDStr() [2/2]

virtual MBase::CString DSSTabularUnit::getGUIDStr ( )
inlinevirtual

◆ getTabularUnit() [1/2]

◆ getTabularUnit() [2/2]

◆ getUnitIndex() [1/2]

int DSSTabularUnit::getUnitIndex ( )
inline

◆ getUnitIndex() [2/2]

int DSSTabularUnit::getUnitIndex ( )

◆ getUnitType() [1/2]

EnumDSSTemplateUnitType DSSTabularUnit::getUnitType ( )

◆ getUnitType() [2/2]

EnumDSSTemplateUnitType DSSTabularUnit::getUnitType ( )
inline

◆ hGetContext() [1/2]

DSSObjectContext* DSSTabularUnit::hGetContext ( )
protected

◆ hGetContext() [2/2]

DSSObjectContext* DSSTabularUnit::hGetContext ( )
protected

◆ hGetNullElement() [1/2]

DSSBaseElementProxy* DSSTabularUnit::hGetNullElement ( )
protected

◆ hGetNullElement() [2/2]

DSSBaseElementProxy* DSSTabularUnit::hGetNullElement ( )
protected

◆ IsRecursiveUnit() [1/2]

virtual bool DSSTabularUnit::IsRecursiveUnit ( )
virtual

◆ IsRecursiveUnit() [2/2]

virtual bool DSSTabularUnit::IsRecursiveUnit ( )
virtual

◆ IsRuntimeUnit() [1/2]

virtual bool DSSTabularUnit::IsRuntimeUnit ( )
virtual

◆ IsRuntimeUnit() [2/2]

virtual bool DSSTabularUnit::IsRuntimeUnit ( )
virtual

◆ setGUID() [1/4]

int DSSTabularUnit::setGUID ( MBase::CString irVal)

◆ setGUID() [2/4]

int DSSTabularUnit::setGUID ( MBase::CString irVal)

◆ setGUID() [3/4]

int DSSTabularUnit::setGUID ( GUID irVal)

◆ setGUID() [4/4]

int DSSTabularUnit::setGUID ( GUID irVal)

◆ setIsRuntimeUnit() [1/2]

void DSSTabularUnit::setIsRuntimeUnit ( bool  val)
inline

◆ setIsRuntimeUnit() [2/2]

void DSSTabularUnit::setIsRuntimeUnit ( bool  val)
inline

◆ setNullElement() [1/2]

void DSSTabularUnit::setNullElement ( int  index,
MBase::CString irElementID 
)

◆ setNullElement() [2/2]

void DSSTabularUnit::setNullElement ( int  index,
MBase::CString irElementID 
)

◆ setObjectContextRef() [1/2]

void DSSTabularUnit::setObjectContextRef ( DSSObjectContext ipObjContext)
inline

◆ setObjectContextRef() [2/2]

void DSSTabularUnit::setObjectContextRef ( DSSObjectContext ipObjContext)
inline

◆ setParentInfo() [1/2]

void DSSTabularUnit::setParentInfo ( DSSDataModelBase ipModel)

◆ setParentInfo() [2/2]

void DSSTabularUnit::setParentInfo ( DSSDataModelBase ipModel)

◆ setUnitIndex() [1/2]

void DSSTabularUnit::setUnitIndex ( int  iIndex)
inline

◆ setUnitIndex() [2/2]

void DSSTabularUnit::setUnitIndex ( int  iIndex)

◆ size() [1/2]

◆ size() [2/2]

Member Data Documentation

◆ mbIsRuntimeUnit

bool DSSTabularUnit::mbIsRuntimeUnit
protected

◆ mGUID

GUID DSSTabularUnit::mGUID
protected

◆ mGUIDStr

MBase::CString DSSTabularUnit::mGUIDStr
protected

◆ mNullElementIDStr

MBase::CString DSSTabularUnit::mNullElementIDStr
protected

◆ mNullElementIndex

int DSSTabularUnit::mNullElementIndex
protected

◆ mpModel

DSSDataModelBase * DSSTabularUnit::mpModel
protected

◆ mpNullElement

DSSBaseElementProxy * DSSTabularUnit::mpNullElement
protected

◆ mpObjContext

DSSObjectContext * DSSTabularUnit::mpObjContext
protected

◆ mUnitID

int DSSTabularUnit::mUnitID
protected

◆ mUnitType

EnumDSSTemplateUnitType DSSTabularUnit::mUnitType
protected