Mobile API Reference  MicroStrategy 2019
DSSDocumentDefinition Class Reference

#include <DSSDocumentDefinition.h>

Inheritance diagram for DSSDocumentDefinition:
DSSObjectInfo DSSObjectInfo

Public Member Functions

 DSSDocumentDefinition ()
 
 DSSDocumentDefinition (GUID &iID, EnumDSSObjectType iType, std::string iName, DSSObjectContext *iObjectContext, GUID iContainerID, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
virtual ~DSSDocumentDefinition ()
 
EnumDSSDocumentType getDocumentType ()
 
DSSRWNodegetRootNode (EnumDSSRWTreeType iTreeIndex)
 
void ClearRootNode (EnumDSSRWTreeType iTreeIndex, std::vector< DSSRWNode *> *ipNodesRmved=NULL, std::vector< DSSRWIterator *> *ipIteratorsRmved=NULL)
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, bool iIsPartial=false)
 
std::string getCurrentLayoutKey ()
 
void setCurrentLayoutKey (std::string iKey)
 
DSSRWSectionNodegetCurrentLayoutNode ()
 
bool HasLayout ()
 
std::vector< std::string > * getLayoutKeys ()
 
void AddLayoutKey (std::string iKey)
 
std::string getInitialLayoutKey ()
 
void setInitialLayoutKey (std::string iKey)
 
std::vector< DSSRWNode * > * getNodesLoadedOnDemand ()
 
void getNodesForDatasetSelector (DSSRWControl *ipControl, std::map< std::string, DSSRWNode * > *ipNodeMapServer, std::vector< DSSRWNode *> *ipNodesModelChanged, std::map< std::string, std::vector< std::string > > *ipDDICModelChanged=NULL)
 
int LoadLayoutKeysFromBinary (DSSBinaryDataReader *ipReader)
 
DSSDocumentViewsgetDocumentViews ()
 
void setDocumentViews (DSSDocumentViews *ipDocumentViews)
 
int getCurrentDocumentView ()
 
void setCurrentDocumentView (int iViewIdx)
 
void getLinkedAssociatedRWNodeKeys (std::string iNodeKey, std::vector< std::string > &iLinkedNodes, int iCategory, bool ibExcludeSelection=true)
 
void insertAssociatedInfo (std::string iNodeKey1, std::string iNodeKey2)
 
DSSElementsPropertiesMapgetElementsPropertiesMap ()
 
const GUIDgetThemeRef () const
 
const GUIDgetPaletteRef () const
 
const std::vector< int > & getPaletteColors () const
 
 DSSDocumentDefinition ()
 
 DSSDocumentDefinition (GUID &iID, EnumDSSObjectType iType, std::string iName, DSSObjectContext *iObjectContext, GUID iContainerID, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
virtual ~DSSDocumentDefinition ()
 
EnumDSSDocumentType getDocumentType ()
 
DSSRWNodegetRootNode (EnumDSSRWTreeType iTreeIndex)
 
void ClearRootNode (EnumDSSRWTreeType iTreeIndex, std::vector< DSSRWNode *> *ipNodesRmved=NULL, std::vector< DSSRWIterator *> *ipIteratorsRmved=NULL)
 
int LoadDefnFromBinary (DSSBinaryDataReader *ipReader, bool iIsPartial=false)
 
std::string getCurrentLayoutKey ()
 
void setCurrentLayoutKey (std::string iKey)
 
DSSRWSectionNodegetCurrentLayoutNode ()
 
bool HasLayout ()
 
std::vector< std::string > * getLayoutKeys ()
 
void AddLayoutKey (std::string iKey)
 
std::string getInitialLayoutKey ()
 
void setInitialLayoutKey (std::string iKey)
 
std::vector< DSSRWNode * > * getNodesLoadedOnDemand ()
 
void getNodesForDatasetSelector (DSSRWControl *ipControl, std::map< std::string, DSSRWNode * > *ipNodeMapServer, std::vector< DSSRWNode *> *ipNodesModelChanged, std::map< std::string, std::vector< std::string > > *ipDDICModelChanged=NULL)
 
int LoadLayoutKeysFromBinary (DSSBinaryDataReader *ipReader)
 
DSSDocumentViewsgetDocumentViews ()
 
void setDocumentViews (DSSDocumentViews *ipDocumentViews)
 
int getCurrentDocumentView ()
 
void setCurrentDocumentView (int iViewIdx)
 
void getLinkedAssociatedRWNodeKeys (std::string iNodeKey, std::vector< std::string > &iLinkedNodes, int iCategory, bool ibExcludeSelection=true)
 
void insertAssociatedInfo (std::string iNodeKey1, std::string iNodeKey2)
 
DSSElementsPropertiesMapgetElementsPropertiesMap ()
 
const GUIDgetThemeRef () const
 
const GUIDgetPaletteRef () const
 
const std::vector< int > & getPaletteColors () const
 
- Public Member Functions inherited from DSSObjectInfo
 DSSObjectInfo ()
 
virtual ~DSSObjectInfo ()
 
 DSSObjectInfo (GUID &iID, GUID &iOnwerID, DSSObjectContext *iObjectContext, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
 DSSObjectInfo (GUID &iID, EnumDSSObjectType iType, std::string iName, DSSObjectContext *iObjectContext, GUID iContainerID=GUID_NULL, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
GUID getID ()
 
EnumDSSObjectType getType ()
 
std::string getName ()
 
std::string & getNameRef ()
 
void setName (std::string iName)
 
void setDsc (std::string iDsc)
 
std::string getDsc ()
 
GUID getContainerID ()
 
DSSObjectContextgetObjectContext ()
 
int LoadPropertiesFromBinary (DSSBinaryDataReader *ipReader)
 
void InsertPropertySet (std::string iPropertySetName, DSSPropertySetBaseClass *ipPropertySet)
 
CComVariantgetPropertyValue (std::string iPropertySetName, std::string iPropertyName)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, std::string iPropertyValue)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, CComVariant &iPropertyValue)
 
virtual void MakeCleanDefn ()
 
PropertySetsMap getPropertySetsMap ()
 
GUID getOnwerID ()
 
void putOwnerID (GUID &iOnwerID)
 
void addACE (GUID &iTrusteeID, int iTypeAndRights)
 
bool CheckAccess (DSSUserRuntime *ipUserRuntime, int iDesiredAccess, bool iRequireAll=true)
 
EnumDSSViewMedia getViewMedia ()
 
std::vector< DSSAccessControlEntrygetACL ()
 
void Duplicate (DSSObjectInfo *ipObjectInfo)
 
 DSSObjectInfo ()
 
virtual ~DSSObjectInfo ()
 
 DSSObjectInfo (GUID &iID, GUID &iOnwerID, DSSObjectContext *iObjectContext, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
 DSSObjectInfo (GUID &iID, EnumDSSObjectType iType, std::string iName, DSSObjectContext *iObjectContext, GUID iContainerID=GUID_NULL, EnumDSSViewMedia iViewMedia=DssViewMediaReserved)
 
GUID getID ()
 
EnumDSSObjectType getType ()
 
std::string getName ()
 
std::string & getNameRef ()
 
void setName (std::string iName)
 
void setDsc (std::string iDsc)
 
std::string getDsc ()
 
GUID getContainerID ()
 
DSSObjectContextgetObjectContext ()
 
int LoadPropertiesFromBinary (DSSBinaryDataReader *ipReader)
 
void InsertPropertySet (std::string iPropertySetName, DSSPropertySetBaseClass *ipPropertySet)
 
CComVariantgetPropertyValue (std::string iPropertySetName, std::string iPropertyName)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, std::string iPropertyValue)
 
void setPropertyValue (std::string iPropertySetName, std::string iPropertyName, CComVariant &iPropertyValue)
 
virtual void MakeCleanDefn ()
 
PropertySetsMap getPropertySetsMap ()
 
GUID getOnwerID ()
 
void putOwnerID (GUID &iOnwerID)
 
void addACE (GUID &iTrusteeID, int iTypeAndRights)
 
bool CheckAccess (DSSUserRuntime *ipUserRuntime, int iDesiredAccess, bool iRequireAll=true)
 
EnumDSSViewMedia getViewMedia ()
 
std::vector< DSSAccessControlEntrygetACL ()
 
void Duplicate (DSSObjectInfo *ipObjectInfo)
 

Additional Inherited Members

- Protected Attributes inherited from DSSObjectInfo
EnumDSSObjectType mType
 
DSSObjectContextmpObjectContext
 
PropertySetsMap mPropertySetsMap
 

Constructor & Destructor Documentation

◆ DSSDocumentDefinition() [1/4]

DSSDocumentDefinition::DSSDocumentDefinition ( )

◆ DSSDocumentDefinition() [2/4]

DSSDocumentDefinition::DSSDocumentDefinition ( GUID iID,
EnumDSSObjectType  iType,
std::string  iName,
DSSObjectContext iObjectContext,
GUID  iContainerID,
EnumDSSViewMedia  iViewMedia = DssViewMediaReserved 
)

◆ ~DSSDocumentDefinition() [1/2]

virtual DSSDocumentDefinition::~DSSDocumentDefinition ( )
virtual

◆ DSSDocumentDefinition() [3/4]

DSSDocumentDefinition::DSSDocumentDefinition ( )

◆ DSSDocumentDefinition() [4/4]

DSSDocumentDefinition::DSSDocumentDefinition ( GUID iID,
EnumDSSObjectType  iType,
std::string  iName,
DSSObjectContext iObjectContext,
GUID  iContainerID,
EnumDSSViewMedia  iViewMedia = DssViewMediaReserved 
)

◆ ~DSSDocumentDefinition() [2/2]

virtual DSSDocumentDefinition::~DSSDocumentDefinition ( )
virtual

Member Function Documentation

◆ AddLayoutKey() [1/2]

void DSSDocumentDefinition::AddLayoutKey ( std::string  iKey)

◆ AddLayoutKey() [2/2]

void DSSDocumentDefinition::AddLayoutKey ( std::string  iKey)

◆ ClearRootNode() [1/2]

void DSSDocumentDefinition::ClearRootNode ( EnumDSSRWTreeType  iTreeIndex,
std::vector< DSSRWNode *> *  ipNodesRmved = NULL,
std::vector< DSSRWIterator *> *  ipIteratorsRmved = NULL 
)

◆ ClearRootNode() [2/2]

void DSSDocumentDefinition::ClearRootNode ( EnumDSSRWTreeType  iTreeIndex,
std::vector< DSSRWNode *> *  ipNodesRmved = NULL,
std::vector< DSSRWIterator *> *  ipIteratorsRmved = NULL 
)

◆ getCurrentDocumentView() [1/2]

int DSSDocumentDefinition::getCurrentDocumentView ( )

◆ getCurrentDocumentView() [2/2]

int DSSDocumentDefinition::getCurrentDocumentView ( )

◆ getCurrentLayoutKey() [1/2]

std::string DSSDocumentDefinition::getCurrentLayoutKey ( )

◆ getCurrentLayoutKey() [2/2]

std::string DSSDocumentDefinition::getCurrentLayoutKey ( )

◆ getCurrentLayoutNode() [1/2]

DSSRWSectionNode* DSSDocumentDefinition::getCurrentLayoutNode ( )

◆ getCurrentLayoutNode() [2/2]

DSSRWSectionNode* DSSDocumentDefinition::getCurrentLayoutNode ( )

◆ getDocumentType() [1/2]

EnumDSSDocumentType DSSDocumentDefinition::getDocumentType ( )

◆ getDocumentType() [2/2]

EnumDSSDocumentType DSSDocumentDefinition::getDocumentType ( )

◆ getDocumentViews() [1/2]

DSSDocumentViews* DSSDocumentDefinition::getDocumentViews ( )

◆ getDocumentViews() [2/2]

DSSDocumentViews* DSSDocumentDefinition::getDocumentViews ( )

◆ getElementsPropertiesMap() [1/2]

DSSElementsPropertiesMap* DSSDocumentDefinition::getElementsPropertiesMap ( )
inline

◆ getElementsPropertiesMap() [2/2]

DSSElementsPropertiesMap* DSSDocumentDefinition::getElementsPropertiesMap ( )
inline

◆ getInitialLayoutKey() [1/2]

std::string DSSDocumentDefinition::getInitialLayoutKey ( )

◆ getInitialLayoutKey() [2/2]

std::string DSSDocumentDefinition::getInitialLayoutKey ( )

◆ getLayoutKeys() [1/2]

std::vector<std::string>* DSSDocumentDefinition::getLayoutKeys ( )

◆ getLayoutKeys() [2/2]

std::vector<std::string>* DSSDocumentDefinition::getLayoutKeys ( )

◆ getLinkedAssociatedRWNodeKeys() [1/2]

void DSSDocumentDefinition::getLinkedAssociatedRWNodeKeys ( std::string  iNodeKey,
std::vector< std::string > &  iLinkedNodes,
int  iCategory,
bool  ibExcludeSelection = true 
)

◆ getLinkedAssociatedRWNodeKeys() [2/2]

void DSSDocumentDefinition::getLinkedAssociatedRWNodeKeys ( std::string  iNodeKey,
std::vector< std::string > &  iLinkedNodes,
int  iCategory,
bool  ibExcludeSelection = true 
)

◆ getNodesForDatasetSelector() [1/2]

void DSSDocumentDefinition::getNodesForDatasetSelector ( DSSRWControl ipControl,
std::map< std::string, DSSRWNode * > *  ipNodeMapServer,
std::vector< DSSRWNode *> *  ipNodesModelChanged,
std::map< std::string, std::vector< std::string > > *  ipDDICModelChanged = NULL 
)

◆ getNodesForDatasetSelector() [2/2]

void DSSDocumentDefinition::getNodesForDatasetSelector ( DSSRWControl ipControl,
std::map< std::string, DSSRWNode * > *  ipNodeMapServer,
std::vector< DSSRWNode *> *  ipNodesModelChanged,
std::map< std::string, std::vector< std::string > > *  ipDDICModelChanged = NULL 
)

◆ getNodesLoadedOnDemand() [1/2]

std::vector<DSSRWNode*>* DSSDocumentDefinition::getNodesLoadedOnDemand ( )

◆ getNodesLoadedOnDemand() [2/2]

std::vector<DSSRWNode*>* DSSDocumentDefinition::getNodesLoadedOnDemand ( )

◆ getPaletteColors() [1/2]

const std::vector<int>& DSSDocumentDefinition::getPaletteColors ( ) const
inline

◆ getPaletteColors() [2/2]

const std::vector<int>& DSSDocumentDefinition::getPaletteColors ( ) const
inline

◆ getPaletteRef() [1/2]

const GUID& DSSDocumentDefinition::getPaletteRef ( ) const
inline

◆ getPaletteRef() [2/2]

const GUID& DSSDocumentDefinition::getPaletteRef ( ) const
inline

◆ getRootNode() [1/2]

DSSRWNode* DSSDocumentDefinition::getRootNode ( EnumDSSRWTreeType  iTreeIndex)

◆ getRootNode() [2/2]

DSSRWNode* DSSDocumentDefinition::getRootNode ( EnumDSSRWTreeType  iTreeIndex)

◆ getThemeRef() [1/2]

const GUID& DSSDocumentDefinition::getThemeRef ( ) const
inline

◆ getThemeRef() [2/2]

const GUID& DSSDocumentDefinition::getThemeRef ( ) const
inline

◆ HasLayout() [1/2]

bool DSSDocumentDefinition::HasLayout ( )

◆ HasLayout() [2/2]

bool DSSDocumentDefinition::HasLayout ( )

◆ insertAssociatedInfo() [1/2]

void DSSDocumentDefinition::insertAssociatedInfo ( std::string  iNodeKey1,
std::string  iNodeKey2 
)

◆ insertAssociatedInfo() [2/2]

void DSSDocumentDefinition::insertAssociatedInfo ( std::string  iNodeKey1,
std::string  iNodeKey2 
)

◆ LoadDefnFromBinary() [1/2]

int DSSDocumentDefinition::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
bool  iIsPartial = false 
)

◆ LoadDefnFromBinary() [2/2]

int DSSDocumentDefinition::LoadDefnFromBinary ( DSSBinaryDataReader ipReader,
bool  iIsPartial = false 
)

◆ LoadLayoutKeysFromBinary() [1/2]

int DSSDocumentDefinition::LoadLayoutKeysFromBinary ( DSSBinaryDataReader ipReader)

◆ LoadLayoutKeysFromBinary() [2/2]

int DSSDocumentDefinition::LoadLayoutKeysFromBinary ( DSSBinaryDataReader ipReader)

◆ setCurrentDocumentView() [1/2]

void DSSDocumentDefinition::setCurrentDocumentView ( int  iViewIdx)

◆ setCurrentDocumentView() [2/2]

void DSSDocumentDefinition::setCurrentDocumentView ( int  iViewIdx)

◆ setCurrentLayoutKey() [1/2]

void DSSDocumentDefinition::setCurrentLayoutKey ( std::string  iKey)

◆ setCurrentLayoutKey() [2/2]

void DSSDocumentDefinition::setCurrentLayoutKey ( std::string  iKey)

◆ setDocumentViews() [1/2]

void DSSDocumentDefinition::setDocumentViews ( DSSDocumentViews ipDocumentViews)

◆ setDocumentViews() [2/2]

void DSSDocumentDefinition::setDocumentViews ( DSSDocumentViews ipDocumentViews)

◆ setInitialLayoutKey() [1/2]

void DSSDocumentDefinition::setInitialLayoutKey ( std::string  iKey)

◆ setInitialLayoutKey() [2/2]

void DSSDocumentDefinition::setInitialLayoutKey ( std::string  iKey)