Mobile API Reference  MicroStrategy 2019
DSSTemplateAttribute Class Reference

#include <DSSTemplateAttribute.h>

Inheritance diagram for DSSTemplateAttribute:
DSSTemplateUnit DSSTemplateUnit DSSSecondClassObject DSSSecondClassObject DSSSecondClassObject DSSSecondClassObject

Public Member Functions

 DSSTemplateAttribute ()
 
virtual ~DSSTemplateAttribute ()
 
 DSSTemplateAttribute (DSSObjectContext *ipObjectContext)
 
DSSAttributegetAttribute ()
 
DSSAttributeFormWrappersgetFormWrappers ()
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex, DSSAxis *ipAxis, DSSTemplate *ipOwnerTemplate=NULL)
 
EnumUnitTransactionFlags IsEditable ()
 
EnumUnitTransactionFlags IsEditableByForm (GUID iFormID)
 
EnumUnitTransactionFlags IsRequired ()
 
EnumUnitTransactionFlags IsRequiredByForm (GUID iFormID)
 
int getColumnIndexByForm (GUID iFormID)
 
std::string getInputFormatByForm (GUID iFormID)
 
bool IsMappedForTransaction ()
 
bool IsMappedForOfflineTransaction ()
 
DSSRWControlgetInputControlByForm (GUID iFormID)
 
std::string getInputControlKeyByForm (GUID iFormID)
 
void PopulateDefaultForms ()
 
int getOfflineColumnIndexByForm (GUID iFormID)
 
void clone (DSSTemplateUnit *iAttribute, DSSAxis *ipAxis)
 
DSSThresholdsgetThresholds ()
 
void setThreholds (DSSThresholds *iThresholds)
 
 DSSTemplateAttribute ()
 
virtual ~DSSTemplateAttribute ()
 
 DSSTemplateAttribute (DSSObjectContext *ipObjectContext)
 
DSSAttributegetAttribute ()
 
DSSAttributeFormWrappersgetFormWrappers ()
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, int iIndex, DSSAxis *ipAxis, DSSTemplate *ipOwnerTemplate=NULL)
 
EnumUnitTransactionFlags IsEditable ()
 
EnumUnitTransactionFlags IsEditableByForm (GUID iFormID)
 
EnumUnitTransactionFlags IsRequired ()
 
EnumUnitTransactionFlags IsRequiredByForm (GUID iFormID)
 
int getColumnIndexByForm (GUID iFormID)
 
std::string getInputFormatByForm (GUID iFormID)
 
bool IsMappedForTransaction ()
 
bool IsMappedForOfflineTransaction ()
 
DSSRWControlgetInputControlByForm (GUID iFormID)
 
std::string getInputControlKeyByForm (GUID iFormID)
 
void PopulateDefaultForms ()
 
int getOfflineColumnIndexByForm (GUID iFormID)
 
void clone (DSSTemplateUnit *iAttribute, DSSAxis *ipAxis)
 
DSSThresholdsgetThresholds ()
 
void setThreholds (DSSThresholds *iThresholds)
 
- 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 ()
 
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 ()
 
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

◆ DSSTemplateAttribute() [1/4]

DSSTemplateAttribute::DSSTemplateAttribute ( )

◆ ~DSSTemplateAttribute() [1/2]

virtual DSSTemplateAttribute::~DSSTemplateAttribute ( )
virtual

◆ DSSTemplateAttribute() [2/4]

DSSTemplateAttribute::DSSTemplateAttribute ( DSSObjectContext ipObjectContext)

◆ DSSTemplateAttribute() [3/4]

DSSTemplateAttribute::DSSTemplateAttribute ( )

◆ ~DSSTemplateAttribute() [2/2]

virtual DSSTemplateAttribute::~DSSTemplateAttribute ( )
virtual

◆ DSSTemplateAttribute() [4/4]

DSSTemplateAttribute::DSSTemplateAttribute ( DSSObjectContext ipObjectContext)

Member Function Documentation

◆ clone() [1/2]

void DSSTemplateAttribute::clone ( DSSTemplateUnit iAttribute,
DSSAxis ipAxis 
)

◆ clone() [2/2]

void DSSTemplateAttribute::clone ( DSSTemplateUnit iAttribute,
DSSAxis ipAxis 
)

◆ getAttribute() [1/2]

DSSAttribute* DSSTemplateAttribute::getAttribute ( )

◆ getAttribute() [2/2]

DSSAttribute* DSSTemplateAttribute::getAttribute ( )

◆ getColumnIndexByForm() [1/2]

int DSSTemplateAttribute::getColumnIndexByForm ( GUID  iFormID)

◆ getColumnIndexByForm() [2/2]

int DSSTemplateAttribute::getColumnIndexByForm ( GUID  iFormID)

◆ getFormWrappers() [1/2]

DSSAttributeFormWrappers* DSSTemplateAttribute::getFormWrappers ( )

◆ getFormWrappers() [2/2]

DSSAttributeFormWrappers* DSSTemplateAttribute::getFormWrappers ( )

◆ getInputControlByForm() [1/2]

DSSRWControl* DSSTemplateAttribute::getInputControlByForm ( GUID  iFormID)

◆ getInputControlByForm() [2/2]

DSSRWControl* DSSTemplateAttribute::getInputControlByForm ( GUID  iFormID)

◆ getInputControlKeyByForm() [1/2]

std::string DSSTemplateAttribute::getInputControlKeyByForm ( GUID  iFormID)

◆ getInputControlKeyByForm() [2/2]

std::string DSSTemplateAttribute::getInputControlKeyByForm ( GUID  iFormID)

◆ getInputFormatByForm() [1/2]

std::string DSSTemplateAttribute::getInputFormatByForm ( GUID  iFormID)

◆ getInputFormatByForm() [2/2]

std::string DSSTemplateAttribute::getInputFormatByForm ( GUID  iFormID)

◆ getOfflineColumnIndexByForm() [1/2]

int DSSTemplateAttribute::getOfflineColumnIndexByForm ( GUID  iFormID)

◆ getOfflineColumnIndexByForm() [2/2]

int DSSTemplateAttribute::getOfflineColumnIndexByForm ( GUID  iFormID)

◆ getThresholds() [1/2]

DSSThresholds* DSSTemplateAttribute::getThresholds ( )

◆ getThresholds() [2/2]

DSSThresholds* DSSTemplateAttribute::getThresholds ( )

◆ IsEditable() [1/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsEditable ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsEditable() [2/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsEditable ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsEditableByForm() [1/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsEditableByForm ( GUID  iFormID)

◆ IsEditableByForm() [2/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsEditableByForm ( GUID  iFormID)

◆ IsMappedForOfflineTransaction() [1/2]

bool DSSTemplateAttribute::IsMappedForOfflineTransaction ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsMappedForOfflineTransaction() [2/2]

bool DSSTemplateAttribute::IsMappedForOfflineTransaction ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsMappedForTransaction() [1/2]

bool DSSTemplateAttribute::IsMappedForTransaction ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsMappedForTransaction() [2/2]

bool DSSTemplateAttribute::IsMappedForTransaction ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequired() [1/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsRequired ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequired() [2/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsRequired ( )
virtual

Reimplemented from DSSTemplateUnit.

◆ IsRequiredByForm() [1/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsRequiredByForm ( GUID  iFormID)

◆ IsRequiredByForm() [2/2]

EnumUnitTransactionFlags DSSTemplateAttribute::IsRequiredByForm ( GUID  iFormID)

◆ LoadDefnFromBinary() [1/2]

int DSSTemplateAttribute::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
int  iIndex,
DSSAxis ipAxis,
DSSTemplate ipOwnerTemplate = NULL 
)

◆ LoadDefnFromBinary() [2/2]

int DSSTemplateAttribute::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
int  iIndex,
DSSAxis ipAxis,
DSSTemplate ipOwnerTemplate = NULL 
)

◆ PopulateDefaultForms() [1/2]

void DSSTemplateAttribute::PopulateDefaultForms ( )

◆ PopulateDefaultForms() [2/2]

void DSSTemplateAttribute::PopulateDefaultForms ( )

◆ setThreholds() [1/2]

void DSSTemplateAttribute::setThreholds ( DSSThresholds iThresholds)

◆ setThreholds() [2/2]

void DSSTemplateAttribute::setThreholds ( DSSThresholds iThresholds)