DSSDocumentInstance Class Reference

#include <DSSDocumentInstance.h>

Public Member Functions
	DSSDocumentInstance ()
virtual	~DSSDocumentInstance ()
DSSDocumentDefinition *	getDefinition ()
int	LoadInstanceFromBinary (unsigned char *ipBinary, int length, bool iIsPartialRefresh, const char *ipBinaryFilePath=NULL)
int	CreateIterator (EnumDSSRWTreeType iTreeType, DSSRWIterator **oppIterator)
int	getVersion ()
int	getFlag1 ()
int	getFlag2 ()
GUID	getDefaultDataSetID ()
EnumDSSReportType	getReportType ()
DSSObjectContext *	getObjectContext ()
DSSRWGroupbyIterator *	getLayoutGroupByIterator (std::string iKey)
DSSRWSectionNode *	getGBParentNode (std::string iKey)
GUID	getCacheID ()
Int64	getCacheUpdateTime ()
Int64	getCacheExpireTime ()
int	LoadImageSkipOthersFromBinary (unsigned char *ipBinaryDefn, int length, const char *ipBinaryFilePath=NULL)
int	LoadWidgetSkipOthersFromBinary (unsigned char *ipBinaryDefn, int length, const char *ipBinaryFilePath=NULL)
void	InitUserRuntimeFromData (std::string iData)
DSSUserRuntime *	getUserRuntime ()
int	getDefinitionBinaryLimit ()
void	setDefinitionBinaryLimit (int iLimit)
void	setLayoutLoaded (std::string iLayoutNodeKey, bool iLoaded)
bool	isInitialLayoutLoaded ()
bool	IsTransactionEnabled ()
bool	IsSmartClient ()
bool	IsSmartClientProperty ()
bool	HasOfflineCSI ()
DSSRWDataModel *	getDataModel ()
int	hLoadCellFormatsFromBinary (DSSBinaryDataReader *ipReader)
int	LoadCacheFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
int	LoadLayoutKeysFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
int	LoadDatasetsInfoFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
int	LoadPropertiesOfDocDefinitionOnlyFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
void	setProjectID (std::string iProjectID)
void	setProjectProperties (std::string istrPrjProperties)
void	setTemplateUnitAliasEnable (bool iIsEnabled)
std::vector< std::string > *	getNodeKeysCategory2 ()
void	setNodeKeysCategory2 (std::vector< std::string > lvNodeKeysCategory2)
void	resetNodeKeysCategory2 ()
int	applyTransactionDelta (std::vector< DSS_ID > ivDataSets, std::vector< unsigned char *>ivDelta, std::vector< int > ivDeltaSize, int *opFirstInvalidDelta=NULL)
int	getCachedIterator (std::string iNodeKey, DSSRWIterator **opIterator)
bool	IsSmartClientNotSupported ()
EnumDSSTransactionErrorCode	getDSTxnErrorCode ()
std::vector< std::string >	getDSTxnErrorInfo ()
DatasetPromptAnswersMap	getDatasetPromptAnswers ()
std::string	getDatasetPromptAnswer (std::string iDatasetID)
bool	isDDA ()
	DSSDocumentInstance ()
virtual	~DSSDocumentInstance ()
DSSDocumentDefinition *	getDefinition ()
int	LoadInstanceFromBinary (unsigned char *ipBinary, int length, bool iIsPartialRefresh, const char *ipBinaryFilePath=NULL)
int	CreateIterator (EnumDSSRWTreeType iTreeType, DSSRWIterator **oppIterator)
int	getVersion ()
int	getFlag1 ()
int	getFlag2 ()
GUID	getDefaultDataSetID ()
EnumDSSReportType	getReportType ()
DSSObjectContext *	getObjectContext ()
DSSRWGroupbyIterator *	getLayoutGroupByIterator (std::string iKey)
DSSRWSectionNode *	getGBParentNode (std::string iKey)
GUID	getCacheID ()
Int64	getCacheUpdateTime ()
Int64	getCacheExpireTime ()
int	LoadImageSkipOthersFromBinary (unsigned char *ipBinaryDefn, int length, const char *ipBinaryFilePath=NULL)
int	LoadWidgetSkipOthersFromBinary (unsigned char *ipBinaryDefn, int length, const char *ipBinaryFilePath=NULL)
void	InitUserRuntimeFromData (std::string iData)
DSSUserRuntime *	getUserRuntime ()
int	getDefinitionBinaryLimit ()
void	setDefinitionBinaryLimit (int iLimit)
void	setLayoutLoaded (std::string iLayoutNodeKey, bool iLoaded)
bool	isInitialLayoutLoaded ()
bool	IsTransactionEnabled ()
bool	IsSmartClient ()
bool	IsSmartClientProperty ()
bool	HasOfflineCSI ()
DSSRWDataModel *	getDataModel ()
int	hLoadCellFormatsFromBinary (DSSBinaryDataReader *ipReader)
int	LoadCacheFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
int	LoadLayoutKeysFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
int	LoadDatasetsInfoFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
int	LoadPropertiesOfDocDefinitionOnlyFromBinary (unsigned char *ipBinary, int length, const char *ipBinaryFilePath=NULL)
void	setProjectID (std::string iProjectID)
void	setProjectProperties (std::string istrPrjProperties)
void	setTemplateUnitAliasEnable (bool iIsEnabled)
std::vector< std::string > *	getNodeKeysCategory2 ()
void	setNodeKeysCategory2 (std::vector< std::string > lvNodeKeysCategory2)
void	resetNodeKeysCategory2 ()
int	applyTransactionDelta (std::vector< DSS_ID > ivDataSets, std::vector< unsigned char *>ivDelta, std::vector< int > ivDeltaSize, int *opFirstInvalidDelta=NULL)
int	getCachedIterator (std::string iNodeKey, DSSRWIterator **opIterator)
bool	IsSmartClientNotSupported ()
EnumDSSTransactionErrorCode	getDSTxnErrorCode ()
std::vector< std::string >	getDSTxnErrorInfo ()
DatasetPromptAnswersMap	getDatasetPromptAnswers ()
std::string	getDatasetPromptAnswer (std::string iDatasetID)
bool	isDDA ()

Static Public Member Functions
static DSSUserRuntime *	CreateUserRuntimeFromData (std::string iData)
static DSSUserRuntime *	CreateUserRuntimeFromData (std::string iData)

Constructor & Destructor Documentation

DSSDocumentInstance() [1/2]

DSSDocumentInstance::DSSDocumentInstance

(

)

~DSSDocumentInstance() [1/2]

virtual DSSDocumentInstance::~DSSDocumentInstance ( )

virtual

DSSDocumentInstance() [2/2]

DSSDocumentInstance::DSSDocumentInstance

(

)

~DSSDocumentInstance() [2/2]

virtual DSSDocumentInstance::~DSSDocumentInstance ( )

virtual

Member Function Documentation

applyTransactionDelta() [1/2]

int DSSDocumentInstance::applyTransactionDelta	(	std::vector< DSS_ID >	ivDataSets,
		std::vector< unsigned char *>	ivDelta,
		std::vector< int >	ivDeltaSize,
		int *	opFirstInvalidDelta = NULL
	)

applyTransactionDelta() [2/2]

int DSSDocumentInstance::applyTransactionDelta	(	std::vector< DSS_ID >	ivDataSets,
		std::vector< unsigned char *>	ivDelta,
		std::vector< int >	ivDeltaSize,
		int *	opFirstInvalidDelta = NULL
	)

CreateIterator() [1/2]

int DSSDocumentInstance::CreateIterator	(	EnumDSSRWTreeType	iTreeType,
		DSSRWIterator **	oppIterator
	)

CreateIterator() [2/2]

int DSSDocumentInstance::CreateIterator	(	EnumDSSRWTreeType	iTreeType,
		DSSRWIterator **	oppIterator
	)

CreateUserRuntimeFromData() [1/2]

static DSSUserRuntime* DSSDocumentInstance::CreateUserRuntimeFromData ( std::string  iData )

static

CreateUserRuntimeFromData() [2/2]

static DSSUserRuntime* DSSDocumentInstance::CreateUserRuntimeFromData ( std::string  iData )

static

getCachedIterator() [1/2]

int DSSDocumentInstance::getCachedIterator	(	std::string	iNodeKey,
		DSSRWIterator **	opIterator
	)

getCachedIterator() [2/2]

int DSSDocumentInstance::getCachedIterator	(	std::string	iNodeKey,
		DSSRWIterator **	opIterator
	)

getCacheExpireTime() [1/2]

Int64 DSSDocumentInstance::getCacheExpireTime

(

)

getCacheExpireTime() [2/2]

Int64 DSSDocumentInstance::getCacheExpireTime

(

)

getCacheID() [1/2]

GUID DSSDocumentInstance::getCacheID

(

)

getCacheID() [2/2]

GUID DSSDocumentInstance::getCacheID

(

)

getCacheUpdateTime() [1/2]

Int64 DSSDocumentInstance::getCacheUpdateTime

(

)

getCacheUpdateTime() [2/2]

Int64 DSSDocumentInstance::getCacheUpdateTime

(

)

getDataModel() [1/2]

DSSRWDataModel* DSSDocumentInstance::getDataModel

(

)

getDataModel() [2/2]

DSSRWDataModel* DSSDocumentInstance::getDataModel

(

)

getDatasetPromptAnswer() [1/2]

std::string DSSDocumentInstance::getDatasetPromptAnswer

(

std::string

iDatasetID

)

getDatasetPromptAnswer() [2/2]

std::string DSSDocumentInstance::getDatasetPromptAnswer

(

std::string

iDatasetID

)

getDatasetPromptAnswers() [1/2]

DatasetPromptAnswersMap DSSDocumentInstance::getDatasetPromptAnswers

(

)

getDatasetPromptAnswers() [2/2]

DatasetPromptAnswersMap DSSDocumentInstance::getDatasetPromptAnswers

(

)

getDefaultDataSetID() [1/2]

GUID DSSDocumentInstance::getDefaultDataSetID

(

)

getDefaultDataSetID() [2/2]

GUID DSSDocumentInstance::getDefaultDataSetID

(

)

getDefinition() [1/2]

DSSDocumentDefinition* DSSDocumentInstance::getDefinition

(

)

getDefinition() [2/2]

DSSDocumentDefinition* DSSDocumentInstance::getDefinition

(

)

getDefinitionBinaryLimit() [1/2]

int DSSDocumentInstance::getDefinitionBinaryLimit

(

)

getDefinitionBinaryLimit() [2/2]

int DSSDocumentInstance::getDefinitionBinaryLimit

(

)

getDSTxnErrorCode() [1/2]

EnumDSSTransactionErrorCode DSSDocumentInstance::getDSTxnErrorCode

(

)

getDSTxnErrorCode() [2/2]

EnumDSSTransactionErrorCode DSSDocumentInstance::getDSTxnErrorCode

(

)

getDSTxnErrorInfo() [1/2]

std::vector<std::string> DSSDocumentInstance::getDSTxnErrorInfo

(

)

getDSTxnErrorInfo() [2/2]

std::vector<std::string> DSSDocumentInstance::getDSTxnErrorInfo

(

)

getFlag1() [1/2]

int DSSDocumentInstance::getFlag1

(

)

getFlag1() [2/2]

int DSSDocumentInstance::getFlag1

(

)

getFlag2() [1/2]

int DSSDocumentInstance::getFlag2

(

)

getFlag2() [2/2]

int DSSDocumentInstance::getFlag2

(

)

getGBParentNode() [1/2]

DSSRWSectionNode* DSSDocumentInstance::getGBParentNode

(

std::string

iKey

)

getGBParentNode() [2/2]

DSSRWSectionNode* DSSDocumentInstance::getGBParentNode

(

std::string

iKey

)

getLayoutGroupByIterator() [1/2]

DSSRWGroupbyIterator* DSSDocumentInstance::getLayoutGroupByIterator

(

std::string

iKey

)

getLayoutGroupByIterator() [2/2]

DSSRWGroupbyIterator* DSSDocumentInstance::getLayoutGroupByIterator

(

std::string

iKey

)

getNodeKeysCategory2() [1/2]

std::vector<std::string>* DSSDocumentInstance::getNodeKeysCategory2

(

)

getNodeKeysCategory2() [2/2]

std::vector<std::string>* DSSDocumentInstance::getNodeKeysCategory2

(

)

getObjectContext() [1/2]

DSSObjectContext* DSSDocumentInstance::getObjectContext

(

)

getObjectContext() [2/2]

DSSObjectContext* DSSDocumentInstance::getObjectContext

(

)

getReportType() [1/2]

EnumDSSReportType DSSDocumentInstance::getReportType

(

)

getReportType() [2/2]

EnumDSSReportType DSSDocumentInstance::getReportType

(

)

getUserRuntime() [1/2]

DSSUserRuntime* DSSDocumentInstance::getUserRuntime

(

)

getUserRuntime() [2/2]

DSSUserRuntime* DSSDocumentInstance::getUserRuntime

(

)

getVersion() [1/2]

int DSSDocumentInstance::getVersion

(

)

getVersion() [2/2]

int DSSDocumentInstance::getVersion

(

)

HasOfflineCSI() [1/2]

bool DSSDocumentInstance::HasOfflineCSI

(

)

HasOfflineCSI() [2/2]

bool DSSDocumentInstance::HasOfflineCSI

(

)

hLoadCellFormatsFromBinary() [1/2]

int DSSDocumentInstance::hLoadCellFormatsFromBinary

(

DSSBinaryDataReader *

ipReader

)

hLoadCellFormatsFromBinary() [2/2]

int DSSDocumentInstance::hLoadCellFormatsFromBinary

(

DSSBinaryDataReader *

ipReader

)

InitUserRuntimeFromData() [1/2]

void DSSDocumentInstance::InitUserRuntimeFromData

(

std::string

iData

)

InitUserRuntimeFromData() [2/2]

void DSSDocumentInstance::InitUserRuntimeFromData

(

std::string

iData

)

isDDA() [1/2]

bool DSSDocumentInstance::isDDA

(

)

isDDA() [2/2]

bool DSSDocumentInstance::isDDA

(

)

isInitialLayoutLoaded() [1/2]

bool DSSDocumentInstance::isInitialLayoutLoaded

(

)

isInitialLayoutLoaded() [2/2]

bool DSSDocumentInstance::isInitialLayoutLoaded

(

)

IsSmartClient() [1/2]

bool DSSDocumentInstance::IsSmartClient

(

)

IsSmartClient() [2/2]

bool DSSDocumentInstance::IsSmartClient

(

)

IsSmartClientNotSupported() [1/2]

bool DSSDocumentInstance::IsSmartClientNotSupported

(

)

IsSmartClientNotSupported() [2/2]

bool DSSDocumentInstance::IsSmartClientNotSupported

(

)

IsSmartClientProperty() [1/2]

bool DSSDocumentInstance::IsSmartClientProperty

(

)

IsSmartClientProperty() [2/2]

bool DSSDocumentInstance::IsSmartClientProperty

(

)

IsTransactionEnabled() [1/2]

bool DSSDocumentInstance::IsTransactionEnabled

(

)

IsTransactionEnabled() [2/2]

bool DSSDocumentInstance::IsTransactionEnabled

(

)

LoadCacheFromBinary() [1/2]

int DSSDocumentInstance::LoadCacheFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadCacheFromBinary() [2/2]

int DSSDocumentInstance::LoadCacheFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadDatasetsInfoFromBinary() [1/2]

int DSSDocumentInstance::LoadDatasetsInfoFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadDatasetsInfoFromBinary() [2/2]

int DSSDocumentInstance::LoadDatasetsInfoFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadImageSkipOthersFromBinary() [1/2]

int DSSDocumentInstance::LoadImageSkipOthersFromBinary	(	unsigned char *	ipBinaryDefn,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadImageSkipOthersFromBinary() [2/2]

int DSSDocumentInstance::LoadImageSkipOthersFromBinary	(	unsigned char *	ipBinaryDefn,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadInstanceFromBinary() [1/2]

int DSSDocumentInstance::LoadInstanceFromBinary	(	unsigned char *	ipBinary,
		int	length,
		bool	iIsPartialRefresh,
		const char *	ipBinaryFilePath = NULL
	)

LoadInstanceFromBinary() [2/2]

int DSSDocumentInstance::LoadInstanceFromBinary	(	unsigned char *	ipBinary,
		int	length,
		bool	iIsPartialRefresh,
		const char *	ipBinaryFilePath = NULL
	)

LoadLayoutKeysFromBinary() [1/2]

int DSSDocumentInstance::LoadLayoutKeysFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadLayoutKeysFromBinary() [2/2]

int DSSDocumentInstance::LoadLayoutKeysFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadPropertiesOfDocDefinitionOnlyFromBinary() [1/2]

int DSSDocumentInstance::LoadPropertiesOfDocDefinitionOnlyFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadPropertiesOfDocDefinitionOnlyFromBinary() [2/2]

int DSSDocumentInstance::LoadPropertiesOfDocDefinitionOnlyFromBinary	(	unsigned char *	ipBinary,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadWidgetSkipOthersFromBinary() [1/2]

int DSSDocumentInstance::LoadWidgetSkipOthersFromBinary	(	unsigned char *	ipBinaryDefn,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

LoadWidgetSkipOthersFromBinary() [2/2]

int DSSDocumentInstance::LoadWidgetSkipOthersFromBinary	(	unsigned char *	ipBinaryDefn,
		int	length,
		const char *	ipBinaryFilePath = NULL
	)

resetNodeKeysCategory2() [1/2]

void DSSDocumentInstance::resetNodeKeysCategory2

(

)

resetNodeKeysCategory2() [2/2]

void DSSDocumentInstance::resetNodeKeysCategory2

(

)

setDefinitionBinaryLimit() [1/2]

void DSSDocumentInstance::setDefinitionBinaryLimit

(

int

iLimit

)

setDefinitionBinaryLimit() [2/2]

void DSSDocumentInstance::setDefinitionBinaryLimit

(

int

iLimit

)

setLayoutLoaded() [1/2]

void DSSDocumentInstance::setLayoutLoaded	(	std::string	iLayoutNodeKey,
		bool	iLoaded
	)

setLayoutLoaded() [2/2]

void DSSDocumentInstance::setLayoutLoaded	(	std::string	iLayoutNodeKey,
		bool	iLoaded
	)

setNodeKeysCategory2() [1/2]

void DSSDocumentInstance::setNodeKeysCategory2

(

std::vector< std::string >

lvNodeKeysCategory2

)

setNodeKeysCategory2() [2/2]

void DSSDocumentInstance::setNodeKeysCategory2

(

std::vector< std::string >

lvNodeKeysCategory2

)

setProjectID() [1/2]

void DSSDocumentInstance::setProjectID

(

std::string

iProjectID

)

setProjectID() [2/2]

void DSSDocumentInstance::setProjectID

(

std::string

iProjectID

)

setProjectProperties() [1/2]

void DSSDocumentInstance::setProjectProperties

(

std::string

istrPrjProperties

)

setProjectProperties() [2/2]

void DSSDocumentInstance::setProjectProperties

(

std::string

istrPrjProperties

)

setTemplateUnitAliasEnable() [1/2]

void DSSDocumentInstance::setTemplateUnitAliasEnable

(

bool

iIsEnabled

)

setTemplateUnitAliasEnable() [2/2]

void DSSDocumentInstance::setTemplateUnitAliasEnable

(

bool

iIsEnabled

)