SAP ABAP Class CL_FDT_SIMULATION_EXCEL (Export of function's signature to excel)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
     ⤷ SFDT_EXCEL_API (Package) Main api for handling Excel documents

Properties

Class	CL_FDT_SIMULATION_EXCEL
Short Description	Export of function's signature to excel
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SFDT_EXCEL_API	Main api for handling Excel documents
Created	20080904	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_FDT_SIMULATION_EXCEL	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_FDT_DOC_SPREADSHEET	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FDT_SIMULATION_EXCEL has no interface implemented.

Friends

Class CL_FDT_SIMULATION_EXCEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CURRENCY	Constant	Private	☐	Type reference (TYPE)	STRING	'CURRENCY'		20090309
2	GC_HYPHEN	Constant	Private	☐	Type reference (TYPE)	STRING	'-'		20081224
3	GC_NUMBER	Constant	Private	☐	Type reference (TYPE)	STRING	'NUMBER'		20090309
4	GC_RES_PREFIX	Constant	Private	☐	Type reference (TYPE)	STRING	'RES__'		20090306
5	GC_UNIT	Constant	Private	☐	Type reference (TYPE)	STRING	'UNIT'		20090309
6	GC_VARIANT_DEFAULT	Constant	Public	☐	Type reference (TYPE)	STRING	'Default'		20130515
7	GC_VARIANT_NEW_LEAN_TRACE	Constant	Public	☐	Type reference (TYPE)	STRING	'New_Lean_Trace'		20130515
8	GTH_COL_NAMES	Static Attribute	Private	☐	Type reference (TYPE)	TH_COL_NAMES			20120612
9	GTS_COL_NAME	Static Attribute	Private	☐	Type reference (TYPE)	TS_COL_NAME		Used Column Names	20120612
10	MO_FUNCTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FDT_FUNCTION		FDT: Function	20080904
11	MR_MAPPING_COL_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA			20120613
12	MT_COLUMN	Static Attribute	Private	☐	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN			20100721
13	MT_CONTEXT_COL	Instance attribute	Private	☐	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN			20081224
14	MT_MAPPING_COLUMN	Instance attribute	Private	☐	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN		Defining Columns for Mapping Sheet in Excel	20120608
15	MT_RESULT_COL	Instance attribute	Private	☐	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>T_COLUMN			20081224
16	MT_TRACE_TABLE	Static Attribute	Public	☐	Type reference (TYPE)	TS_TRACE_VALUE		Trace table	20100721
17	MV_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP		Time Stamp (active version)	20081223

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Creates the object loading signature data	20080904
2	CREATE_CONTENT_TRACE	Static method	Public	Method	Build trace content	20100721
3	CREATE_DYNAMIC_STRUCTURE	Instance method	Private	Method	Create a dynamic structure based on function's signature	20120613
4	CREATE_EXCEL_CONTENT	Instance method	Private	Method	Creates an excel content with function's signature data	20080904
5	CREATE_EXCEL_FOR_TRACE	Static method	Public	Method	Create trace to excel	20100721
6	CREATE_EXCEL_FROM_SIGNATURE	Static method	Public	Method	Creates an excel spreadsheet from the function's signature	20080904
7	GET_ALIAS_NAME	Instance method	Private	Method	Get the Alias name for the columns	20120611
8	GET_DATA_FROM_EXCEL	Instance method	Public	Method	Gets the data from the excel as an internal table	20080915
9	GET_FORMATTED_SIM_DATA	Instance method	Private	Method	Gets the data from function in excel compatible data format	20080904
10	GET_FORMATTED_TRACE_DATA	Static method	Public	Method	Build trace data	20100721
11	GET_FORMATTED_TRACE_DATA_DEF	Static method	Public	Method	Build trace data	20130515
12	GET_FORMATTED_TRACE_DATA_NLT	Static method	Public	Method	Build trace data	20130515
13	LOAD_CONTEXT	Instance method	Private	Method	Loads the context from the function	20080904
14	LOAD_DATA_OBJECT	Instance method	Private	Method	Loads all the elements of the data object	20081223
15	LOAD_RESULT	Instance method	Private	Method	Loads the result data object from the function	20081217
16	SET_RESULT_VALUE	Instance method	Private	Method	Sets the result value	20081226
17	SET_TRACE_TABLE	Static method	Public	Method	Set the trace table	20100721

Events

Class CL_FDT_SIMULATION_EXCEL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_COL_ALIAS	Public	See coding			20120614	BEGIN OF s_col_alias, alias_name TYPE if_fdt_types=>name, col_id TYPE if_fdt_types=>id, END OF s_col_alias
2	S_COL_NAMES	Private	See coding			20120612	BEGIN OF s_col_names , col_name TYPE char30, number TYPE i, END OF s_col_names
3	S_MAP_COL_DATA	Public	See coding			20120613	BEGIN OF s_map_col_data, col_name TYPE string, alias_name TYPE if_fdt_types=>name, id TYPE if_fdt_types=>id, END OF s_map_col_data
4	S_TRACE_DATA	Public	See coding			20100721	BEGIN OF s_trace_data, step TYPE string, type TYPE string, status TYPE string, value TYPE string, END OF s_trace_data
5	S_TRACE_DATA_NLT	Private	See coding			20130515	BEGIN OF s_trace_data_nlt, name TYPE string, value_name TYPE string, value_value TYPE string, color type string, level type int4, END OF s_trace_data_nlt
6	S_TRACE_VALUE	Public	See coding			20100721	BEGIN OF s_trace_value, name TYPE string, path TYPE string, is_leaf TYPE boole_d, is_expanded TYPE boole_d, children_loaded TYPE boole_d, id TYPE fdt_uuid, value_value TYPE string, processed_flag TYPE boole_d, time TYPE tims, user TYPE syuname, status TYPE string, color TYPE string, date TYPE dats, value_document TYPE REF TO if_ixml_node, symbol TYPE iconname, object_type TYPE string, value_name TYPE string, value_id TYPE fdt_uuid, value_symbol TYPE iconname, value_type TYPE char1, version TYPE sstring, is_exception TYPE boole_d, action TYPE string, link_type TYPE wdui_link_type, level TYPE int4, END OF s_trace_value
7	TH_COL_NAMES	Private	See coding			20120612	th_col_names TYPE HASHED TABLE OF s_col_names WITH UNIQUE KEY col_name
8	TS_COL_ALIAS	Public	See coding			20120614	ts_col_alias TYPE STANDARD TABLE OF s_col_alias
9	TS_COL_NAME	Private	See coding		Used Column Names	20120612	ts_col_name TYPE HASHED TABLE OF string WITH UNIQUE DEFAULT KEY
10	TS_MAP_COL_DATA	Public	See coding			20120613	ts_map_col_data TYPE STANDARD TABLE OF s_map_col_data
11	TS_TRACE_DATA	Public	See coding			20100721	ts_trace_data TYPE STANDARD TABLE OF s_trace_data
12	TS_TRACE_DATA_NLT	Private	See coding			20130515	ts_trace_data_nlt TYPE STANDARD TABLE OF s_trace_data_nlt
13	TS_TRACE_VALUE	Public	See coding		Trace table	20100721	ts_trace_value TYPE STANDARD TABLE OF s_trace_value

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		Universal Unique Identifier	20080904
2	Importing	IV_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP			20081223
3	Importing	IV_WITH_RESULT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		False by default	20081217

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20080904

Method CREATE_CONTENT_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_CONTENT	Value transfer	☐	Type reference (TYPE)	XSTRING		Excel content as raw string	20100721
2	Importing	IR_TABLE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Table of Simulation data	20110114
3	Importing	IV_DOCUMENT_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Name of the excel document	20100721
4	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	STRING	GC_VARIANT_DEFAULT	Variant for the appearance of the excel	20130516

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20100721

Method CREATE_DYNAMIC_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Context Structure	20120613
2	Exporting	ER_SIGNATURE	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Function's Signature ( Input and Output )	20120613
3	Exporting	ETR_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Reference to table of context	20120613
4	Exporting	ETR_SIGNATURE	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Table of function's signature components	20120613
5	Importing	IV_WITH_RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	'X': Define the function's result column in excel	20120613

Method CREATE_DYNAMIC_STRUCTURE on class CL_FDT_SIMULATION_EXCEL has no exception.

Method CREATE_EXCEL_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Excel data as raw string	20080904
2	Importing	IR_TABLE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Table of Simulation data	20110114
3	Importing	IV_DOCUMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the excel document	20080904

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20080904

Method CREATE_EXCEL_FOR_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Excel data as raw string	20100721
2	Importing	IT_TRACE_TABLE	Call by reference	☑	Type reference (TYPE)	TS_TRACE_VALUE		Trace table	20100721
3	Importing	IV_DOCUMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the excel document	20100721
4	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	STRING	GC_VARIANT_DEFAULT	Variant for the appearance of the excel	20130515

Method CREATE_EXCEL_FOR_TRACE on class CL_FDT_SIMULATION_EXCEL has no exception.

Method CREATE_EXCEL_FROM_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Excel Content as raw string	20080904
2	Importing	ITR_INPUT_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Test Simulation Data	20110114
3	Importing	IV_DOCUMENT_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Excel Document Name	20080904
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		Object Identifier	20080904
5	Importing	IV_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP		Timestamp	20081223
6	Importing	IV_WITH_RESULT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		'X': Create Simulation with Result	20081217

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20080904

Method GET_ALIAS_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COL	Call by reference	☐	Type reference (TYPE)	IF_FDT_DOC_SPREADSHEET=>S_COLUMN			20120612
2	Returning	RV_ALIAS_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Alias Name	20120611

Method GET_ALIAS_NAME on class CL_FDT_SIMULATION_EXCEL has no exception.

Method GET_DATA_FROM_EXCEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_TABLE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Parsed excel data	20120614
2	Exporting	ETS_COL_ALIAS	Call by reference	☐	Type reference (TYPE)	CL_FDT_SIMULATION_EXCEL=>TS_COL_ALIAS			20120614
3	Exporting	ET_COLUMN_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>T_OBJECT_ID		Object IDs as sorted table	20120614
4	Importing	IV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Excel data as raw string	20080915
5	Importing	IV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Path of the excel file name	20080915

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20080915

Method GET_FORMATTED_SIM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITR_INPUT_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA		Input Data	20110114
2	Importing	IV_WITH_RESULT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20081217
3	Returning	RR_TABLE_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Simulation data in excel compatible format	20110114

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20080904

Method GET_FORMATTED_TRACE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TRACE_TABLE	Call by reference	☐	Type reference (TYPE)	TS_TRACE_VALUE		Simulation trace table	20100721
2	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	STRING	GC_VARIANT_DEFAULT		20130515
3	Returning	RT_TABLE_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Excel compatible trace data	20100721

Method GET_FORMATTED_TRACE_DATA on class CL_FDT_SIMULATION_EXCEL has no exception.

Method GET_FORMATTED_TRACE_DATA_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TRACE_TABLE	Call by reference	☐	Type reference (TYPE)	TS_TRACE_VALUE		Simulation trace table	20130515
2	Returning	RT_TABLE_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Excel compatible trace data	20130515

Method GET_FORMATTED_TRACE_DATA_DEF on class CL_FDT_SIMULATION_EXCEL has no exception.

Method GET_FORMATTED_TRACE_DATA_NLT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TRACE_TABLE	Call by reference	☐	Type reference (TYPE)	TS_TRACE_VALUE		Simulation trace table	20130515
2	Returning	RT_TABLE_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Excel compatible trace data	20130515

Method GET_FORMATTED_TRACE_DATA_NLT on class CL_FDT_SIMULATION_EXCEL has no exception.

Method LOAD_CONTEXT Signature

Method LOAD_CONTEXT on class CL_FDT_SIMULATION_EXCEL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20090306

Method LOAD_DATA_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		DataObject ID	20081223
2	Importing	IV_IS_RESULT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		'X': Result object	20081223
3	Importing	IV_PATH	Call by reference	☑	Type reference (TYPE)	STRING		Path of the object if deeply nested	20081224

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20090306

Method LOAD_RESULT Signature

Method LOAD_RESULT on class CL_FDT_SIMULATION_EXCEL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20090306

Method SET_RESULT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_SIGNATURE	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Function's Signature ( Input/Output )	20110114
2	Changing	CV_POSITION	Call by reference	☐	Type reference (TYPE)	I		Position of the data object	20081226
3	Importing	IR_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Result of simulation	20081226
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		Data Object ID	20081226
5	Importing	IV_PATH	Call by reference	☑	Type reference (TYPE)	STRING		Path of the object if deeply nested	20081226

#	Exception	Resumable	Description	Created on
1	CX_FDT_EXCEL	☐	FDT: Export/Import to Excel errors	20090306

Method SET_TRACE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TRACE_TABLE	Call by reference	☐	Type reference (TYPE)	TS_TRACE_VALUE		Trace table	20100721

Method SET_TRACE_TABLE on class CL_FDT_SIMULATION_EXCEL has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	712