Mobile API Reference  MicroStrategy 2019
Public Member Functions | Protected Attributes | List of all members
DSSTabularAttribute Class Reference

#include <DSSTabularAttribute.h>

Inheritance diagram for DSSTabularAttribute:
DSSTabularUnit DSSTabularUnit IStatisticsInfo IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo IStatisticsInfo IXTABAttributeInfo DSSGlobalLookUpTable DSSGlobalLookUpTable DSSXTabRefLookupTable DSSXTabRefLookupTable

Public Member Functions

 DSSTabularAttribute ()
 
 ~DSSTabularAttribute ()
 
int Init (int index, int arity)
 
virtual int AddFormDataColumn (int iBaseFormID, int iBaseFormType, DSSDataColumn *ipColumn)
 
virtual int Count ()
 
virtual int Item (int iForm, DSSDataColumn **oppColumn)
 
virtual int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int &orColumn)
 
int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int *opColumn)
 
virtual int getArity ()
 
virtual int getBaseFormID (int iForm)
 
virtual EnumDSSBaseFormType getBaseFormType (int iForm)
 
virtual int CountRows ()
 
virtual int FindElement (DSSBaseElementProxy *ipElement, int &orKey)
 
virtual int FindElement (EnumDSSDataType *ipTypes, Int32 *ipcbDatas, unsigned char **ippDatas, DSSDataFlag *ipFlags, int &orKey)
 
virtual int createElement (int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement, int iGlobalKey=-1, int iGlobalKeyVer=-1)
 
int createNewDrivedElement (int key, DSSObjectContext *ipObjectContext, GUID *ipConsolidationElementID, DSSBaseElementProxy **oppElement, int iGlobalKey, int iGlobalKeyVer)
 
virtual int getAttributeElementIDForAutoText (int key, DSSObjectContext *ipObjectContext, MBase::CString &irAttributeIDText)
 
virtual int size ()
 
virtual int setData (int iBaseFormID, int iRow, char *ipData, int iSizeInByte)
 
virtual int setData (int iBaseFormID, int iOffset, MBase::CString &irText)
 
virtual bool compareElement (DSSBaseElementProxy *ipElement, int iKey)
 
bool FindElement (DSSBaseElementProxy *ipElement, const int *ipKey, int iNumKeys, int &orKeyIndex)
 
int createMMapMemory (const char *ipFilePath, bool ibUseNewFile)
 
int MapFileBuffer ()
 
int UnMapFileBuffer ()
 
int GetAllForm (vector< int > &orvForms)
 
int getWHNullPosition ()
 
void setWHNullPosition (int iPosition)
 
int replaceColumn (vector< DSSDataColumn *> ipNewColumn)
 
 DSSTabularAttribute ()
 
 ~DSSTabularAttribute ()
 
int Init (int index, int arity)
 
virtual int AddFormDataColumn (int iBaseFormID, int iBaseFormType, DSSDataColumn *ipColumn)
 
virtual int Count ()
 
virtual int Item (int iForm, DSSDataColumn **oppColumn)
 
virtual int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int &orColumn)
 
int FindFormWithLocale (int iAttribute, int iBaseFormID, int iLocale, int *opColumn)
 
virtual int getArity ()
 
virtual int getBaseFormID (int iForm)
 
virtual EnumDSSBaseFormType getBaseFormType (int iForm)
 
virtual int CountRows ()
 
virtual int FindElement (DSSBaseElementProxy *ipElement, int &orKey)
 
virtual int FindElement (EnumDSSDataType *ipTypes, Int32 *ipcbDatas, unsigned char **ippDatas, DSSDataFlag *ipFlags, int &orKey)
 
virtual int createElement (int key, DSSObjectContext *ipObjectContext, DSSBaseElementProxy **oppElement, int iGlobalKey=-1, int iGlobalKeyVer=-1)
 
int createNewDrivedElement (int key, DSSObjectContext *ipObjectContext, GUID *ipConsolidationElementID, DSSBaseElementProxy **oppElement, int iGlobalKey, int iGlobalKeyVer)
 
virtual int getAttributeElementIDForAutoText (int key, DSSObjectContext *ipObjectContext, MBase::CString &irAttributeIDText)
 
virtual int size ()
 
virtual int setData (int iBaseFormID, int iRow, char *ipData, int iSizeInByte)
 
virtual int setData (int iBaseFormID, int iOffset, MBase::CString &irText)
 
virtual bool compareElement (DSSBaseElementProxy *ipElement, int iKey)
 
bool FindElement (DSSBaseElementProxy *ipElement, const int *ipKey, int iNumKeys, int &orKeyIndex)
 
int createMMapMemory (const char *ipFilePath, bool ibUseNewFile)
 
int MapFileBuffer ()
 
int UnMapFileBuffer ()
 
int GetAllForm (vector< int > &orvForms)
 
int getWHNullPosition ()
 
void setWHNullPosition (int iPosition)
 
int replaceColumn (vector< DSSDataColumn *> ipNewColumn)
 
- 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 GUID & getGUID ()
 
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 GUID & getGUID ()
 
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 ()
 

Protected Attributes

int mArity
 
int mnForms
 
vector< DSSDataColumn *> mvColumns
 
vector< int > mvBaseFormID
 
vector< EnumDSSBaseFormType > mvBaseFormType
 
vector< int > mvKeyFormID
 
vector< EnumDSSBaseFormType > mvKeyFormType
 
vector< unsigned char > mvIDFormDataBuffer
 
int mWHNullPosition
 
- Protected Attributes inherited from DSSTabularUnit
int mUnitID
 
MBase::CString mGUIDStr
 
GUID mGUID
 
EnumDSSTemplateUnitType mUnitType
 
bool mbIsRuntimeUnit
 
DSSDataModelBase * mpModel
 
DSSObjectContext * mpObjContext
 
int mNullElementIndex
 
MBase::CString mNullElementIDStr
 
DSSBaseElementProxy * mpNullElement
 

Additional Inherited Members

- Protected Member Functions inherited from DSSTabularUnit
DSSObjectContext * hGetContext ()
 
DSSBaseElementProxy * hGetNullElement ()
 
DSSObjectContext * hGetContext ()
 
DSSBaseElementProxy * hGetNullElement ()
 

Constructor & Destructor Documentation

◆ DSSTabularAttribute() [1/2]

DSSTabularAttribute::DSSTabularAttribute ( )

◆ ~DSSTabularAttribute() [1/2]

DSSTabularAttribute::~DSSTabularAttribute ( )

◆ DSSTabularAttribute() [2/2]

DSSTabularAttribute::DSSTabularAttribute ( )

◆ ~DSSTabularAttribute() [2/2]

DSSTabularAttribute::~DSSTabularAttribute ( )

Member Function Documentation

◆ AddFormDataColumn() [1/2]

virtual int DSSTabularAttribute::AddFormDataColumn ( int  iBaseFormID,
int  iBaseFormType,
DSSDataColumn *  ipColumn 
)
virtual

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ AddFormDataColumn() [2/2]

virtual int DSSTabularAttribute::AddFormDataColumn ( int  iBaseFormID,
int  iBaseFormType,
DSSDataColumn *  ipColumn 
)
virtual

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ compareElement() [1/2]

virtual bool DSSTabularAttribute::compareElement ( DSSBaseElementProxy *  ipElement,
int  iKey 
)
virtual

Implements DSSTabularUnit.

◆ compareElement() [2/2]

virtual bool DSSTabularAttribute::compareElement ( DSSBaseElementProxy *  ipElement,
int  iKey 
)
virtual

Implements DSSTabularUnit.

◆ Count() [1/2]

virtual int DSSTabularAttribute::Count ( )
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ Count() [2/2]

virtual int DSSTabularAttribute::Count ( )
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ CountRows() [1/2]

virtual int DSSTabularAttribute::CountRows ( )
virtual

Implements DSSTabularUnit.

Reimplemented in DSSGlobalLookUpTable, DSSGlobalLookUpTable, DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ CountRows() [2/2]

virtual int DSSTabularAttribute::CountRows ( )
virtual

Implements DSSTabularUnit.

Reimplemented in DSSGlobalLookUpTable, DSSGlobalLookUpTable, DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ createElement() [1/2]

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

Implements DSSTabularUnit.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ createElement() [2/2]

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

Implements DSSTabularUnit.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ createMMapMemory() [1/2]

int DSSTabularAttribute::createMMapMemory ( const char *  ipFilePath,
bool  ibUseNewFile 
)

◆ createMMapMemory() [2/2]

int DSSTabularAttribute::createMMapMemory ( const char *  ipFilePath,
bool  ibUseNewFile 
)

◆ createNewDrivedElement() [1/2]

int DSSTabularAttribute::createNewDrivedElement ( int  key,
DSSObjectContext *  ipObjectContext,
GUID *  ipConsolidationElementID,
DSSBaseElementProxy **  oppElement,
int  iGlobalKey,
int  iGlobalKeyVer 
)

◆ createNewDrivedElement() [2/2]

int DSSTabularAttribute::createNewDrivedElement ( int  key,
DSSObjectContext *  ipObjectContext,
GUID *  ipConsolidationElementID,
DSSBaseElementProxy **  oppElement,
int  iGlobalKey,
int  iGlobalKeyVer 
)

◆ FindElement() [1/6]

virtual int DSSTabularAttribute::FindElement ( DSSBaseElementProxy *  ipElement,
int &  orKey 
)
virtual

Implements DSSTabularUnit.

Reimplemented in DSSGlobalLookUpTable, DSSGlobalLookUpTable, DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ FindElement() [2/6]

virtual int DSSTabularAttribute::FindElement ( DSSBaseElementProxy *  ipElement,
int &  orKey 
)
virtual

Implements DSSTabularUnit.

Reimplemented in DSSGlobalLookUpTable, DSSGlobalLookUpTable, DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ FindElement() [3/6]

virtual int DSSTabularAttribute::FindElement ( EnumDSSDataType *  ipTypes,
Int32 *  ipcbDatas,
unsigned char **  ippDatas,
DSSDataFlag *  ipFlags,
int &  orKey 
)
virtual

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ FindElement() [4/6]

virtual int DSSTabularAttribute::FindElement ( EnumDSSDataType *  ipTypes,
Int32 *  ipcbDatas,
unsigned char **  ippDatas,
DSSDataFlag *  ipFlags,
int &  orKey 
)
virtual

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ FindElement() [5/6]

bool DSSTabularAttribute::FindElement ( DSSBaseElementProxy *  ipElement,
const int *  ipKey,
int  iNumKeys,
int &  orKeyIndex 
)

◆ FindElement() [6/6]

bool DSSTabularAttribute::FindElement ( DSSBaseElementProxy *  ipElement,
const int *  ipKey,
int  iNumKeys,
int &  orKeyIndex 
)

◆ FindFormWithLocale() [1/4]

virtual int DSSTabularAttribute::FindFormWithLocale ( int  iAttribute,
int  iBaseFormID,
int  iLocale,
int &  orColumn 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ FindFormWithLocale() [2/4]

virtual int DSSTabularAttribute::FindFormWithLocale ( int  iAttribute,
int  iBaseFormID,
int  iLocale,
int &  orColumn 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ FindFormWithLocale() [3/4]

int DSSTabularAttribute::FindFormWithLocale ( int  iAttribute,
int  iBaseFormID,
int  iLocale,
int *  opColumn 
)
inlinevirtual

Reimplemented from IXTABAttributeInfo.

◆ FindFormWithLocale() [4/4]

int DSSTabularAttribute::FindFormWithLocale ( int  iAttribute,
int  iBaseFormID,
int  iLocale,
int *  opColumn 
)
inlinevirtual

Reimplemented from IXTABAttributeInfo.

◆ GetAllForm() [1/2]

int DSSTabularAttribute::GetAllForm ( vector< int > &  orvForms)

◆ GetAllForm() [2/2]

int DSSTabularAttribute::GetAllForm ( vector< int > &  orvForms)

◆ getArity() [1/2]

virtual int DSSTabularAttribute::getArity ( )
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ getArity() [2/2]

virtual int DSSTabularAttribute::getArity ( )
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ getAttributeElementIDForAutoText() [1/2]

virtual int DSSTabularAttribute::getAttributeElementIDForAutoText ( int  key,
DSSObjectContext *  ipObjectContext,
MBase::CString &  irAttributeIDText 
)
virtual

◆ getAttributeElementIDForAutoText() [2/2]

virtual int DSSTabularAttribute::getAttributeElementIDForAutoText ( int  key,
DSSObjectContext *  ipObjectContext,
MBase::CString &  irAttributeIDText 
)
virtual

◆ getBaseFormID() [1/2]

virtual int DSSTabularAttribute::getBaseFormID ( int  iForm)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ getBaseFormID() [2/2]

virtual int DSSTabularAttribute::getBaseFormID ( int  iForm)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ getBaseFormType() [1/2]

virtual EnumDSSBaseFormType DSSTabularAttribute::getBaseFormType ( int  iForm)
virtual

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ getBaseFormType() [2/2]

virtual EnumDSSBaseFormType DSSTabularAttribute::getBaseFormType ( int  iForm)
virtual

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ getWHNullPosition() [1/2]

int DSSTabularAttribute::getWHNullPosition ( )
virtual

Reimplemented from IXTABAttributeInfo.

◆ getWHNullPosition() [2/2]

int DSSTabularAttribute::getWHNullPosition ( )
virtual

Reimplemented from IXTABAttributeInfo.

◆ Init() [1/2]

int DSSTabularAttribute::Init ( int  index,
int  arity 
)

◆ Init() [2/2]

int DSSTabularAttribute::Init ( int  index,
int  arity 
)

◆ Item() [1/2]

virtual int DSSTabularAttribute::Item ( int  iForm,
DSSDataColumn **  oppColumn 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ Item() [2/2]

virtual int DSSTabularAttribute::Item ( int  iForm,
DSSDataColumn **  oppColumn 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ MapFileBuffer() [1/2]

int DSSTabularAttribute::MapFileBuffer ( )

◆ MapFileBuffer() [2/2]

int DSSTabularAttribute::MapFileBuffer ( )

◆ replaceColumn() [1/2]

int DSSTabularAttribute::replaceColumn ( vector< DSSDataColumn *>  ipNewColumn)

◆ replaceColumn() [2/2]

int DSSTabularAttribute::replaceColumn ( vector< DSSDataColumn *>  ipNewColumn)

◆ setData() [1/4]

virtual int DSSTabularAttribute::setData ( int  iBaseFormID,
int  iRow,
char *  ipData,
int  iSizeInByte 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ setData() [2/4]

virtual int DSSTabularAttribute::setData ( int  iBaseFormID,
int  iRow,
char *  ipData,
int  iSizeInByte 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ setData() [3/4]

virtual int DSSTabularAttribute::setData ( int  iBaseFormID,
int  iOffset,
MBase::CString &  irText 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ setData() [4/4]

virtual int DSSTabularAttribute::setData ( int  iBaseFormID,
int  iOffset,
MBase::CString &  irText 
)
virtual

Reimplemented from IXTABAttributeInfo.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ setWHNullPosition() [1/2]

void DSSTabularAttribute::setWHNullPosition ( int  iPosition)
virtual

Reimplemented from IXTABAttributeInfo.

◆ setWHNullPosition() [2/2]

void DSSTabularAttribute::setWHNullPosition ( int  iPosition)
virtual

Reimplemented from IXTABAttributeInfo.

◆ size() [1/2]

virtual int DSSTabularAttribute::size ( )
virtual

Reimplemented from DSSTabularUnit.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ size() [2/2]

virtual int DSSTabularAttribute::size ( )
virtual

Reimplemented from DSSTabularUnit.

Reimplemented in DSSXTabRefLookupTable, and DSSXTabRefLookupTable.

◆ UnMapFileBuffer() [1/2]

int DSSTabularAttribute::UnMapFileBuffer ( )

◆ UnMapFileBuffer() [2/2]

int DSSTabularAttribute::UnMapFileBuffer ( )

Member Data Documentation

◆ mArity

int DSSTabularAttribute::mArity
protected

◆ mnForms

int DSSTabularAttribute::mnForms
protected

◆ mvBaseFormID

vector< int > DSSTabularAttribute::mvBaseFormID
protected

◆ mvBaseFormType

vector< EnumDSSBaseFormType > DSSTabularAttribute::mvBaseFormType
protected

◆ mvColumns

vector< DSSDataColumn *> DSSTabularAttribute::mvColumns
protected

◆ mvIDFormDataBuffer

vector< unsigned char > DSSTabularAttribute::mvIDFormDataBuffer
protected

◆ mvKeyFormID

vector< int > DSSTabularAttribute::mvKeyFormID
protected

◆ mvKeyFormType

vector< EnumDSSBaseFormType > DSSTabularAttribute::mvKeyFormType
protected

◆ mWHNullPosition

int DSSTabularAttribute::mWHNullPosition
protected