SAP ABAP Class CL_CMP_COMPOSER (SAP INTERNAL USAGE: Code Composer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
     ⤷ SCCMP (Package) SAP INTERNAL USAGE: Code Composer

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SIW_CMP_COMPOSER	if_siw_composer_adapter	20100714

Properties

Class	CL_CMP_COMPOSER
Short Description	SAP INTERNAL USAGE: Code Composer
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SCCMP	SAP INTERNAL USAGE: Code Composer
Created	20051109	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_CMP_COMPOSER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_CMP_ANNOTATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_CMP_SLOT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_CMP_COMPOSER has no interface implemented.

Friends

Class CL_CMP_COMPOSER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_TEMPLTYPE_INCLUDE	Constant	Public	☐	Type reference (TYPE)	STRING	'INCLUDE'		20100419
2	C_TEMPLTYPE_TEMPLATE	Constant	Public	☐	Type reference (TYPE)	STRING	'TEMPLATE'		20100419
3	ID	Instance attribute	Public	☑	Type reference (TYPE)	STRING			20090427
4	REF_COMPOSER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	LCL_COMPOSER			20051110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CALLBACK_REF	Instance method	Public	Method	Insert Callback Reference	20060529
2	ADD_SLOTS_FROM_PROG	Instance method	Public	Method	Inserts all slots from passed program	20051215
3	ADD_VAR	Instance method	Public	Method	Position variable in the composer context	20051109
4	BREAK_CREATE	Instance method	Private	Method		20090518
5	BUILD_CODE	Instance method	Public	Method	Create/Generate Code	20051109
6	BUILD_CODE_DIRECT	Instance method	Public	Method	Create/Generate Coding from the passed template	20061018
7	BUILD_CODE_DIRECT_LONG	Instance method	Public	Method	Create/Generate Coding from the passed template	20130612
8	BUILD_CODE_LONG	Instance method	Public	Method	Create/Generate Code	20130612
9	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20051109
10	CREATE_REPEAT	Instance method	Public	Method	Creates a Repeat Block	20051110
11	DEFINE_SLOT	Instance method	Public	Method	Defines a Code Slot	20051123
12	GET_CORRESPONDING_TEMPL_LINE	Instance method	Public	Method	Returns Assigned Template Line	20080114
13	INIT_CONTEXT	Instance method	Public	Method	Initialization of Context	20080411
14	RAISE_EXCEPTION	Static method	Private	Method	Triggers Exception	20071108
15	S_CREATE	Static method	Public	Method	Generates Instance of Code Composer	20051109
16	S_FIND_SLOT	Static method	Public	Method	Finds a Code Slot in a Program	20051125
17	S_GET_ALL_ANNOTATIONS	Static method	Public	Method	Returns All Annotations in a Program	20051129
18	S_GET_ALL_SLOTS	Static method	Public	Method	Returns All Code Slots in a Program	20051125
19	S_INITIALIZE	Static method	Public	Method	Initialize Code Composer Buffer	20051213
20	S_SYNTAX_CHECK	Static method	Public	Method	Carries out a syntax check on a passed include	20051208
21	S_SYNTAX_CHECK_DIRECT	Static method	Public	Method	Performs Syntax Check of Passed Code	20120820

Events

Class CL_CMP_COMPOSER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	CODE	Public	See coding			20051109	code TYPE c LENGTH 255
2	CODE_LONG	Public	Type reference (TYPE)	STRING		20130422
3	STR_TEMPLATE	Public	See coding			20061129	begin of str_template, progname TYPE sy-repid, area type c LENGTH 255, END OF str_template
4	STR_TEMPL_LINE	Public	See coding			20080113	BEGIN OF str_templ_line, progname type sy-repid, template_name type string, template_type type string, line_no type i, line type code, END OF str_templ_line
5	TAB_CODE	Public	See coding			20051109	tab_code TYPE STANDARD TABLE OF code WITH DEFAULT KEY
6	TAB_CODE_LONG	Public	See coding			20130422	tab_code_long type STANDARD TABLE OF code_long with default key

Method Signatures

Method ADD_CALLBACK_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_CALLBACK	Value transfer	☐	Object reference (TYPE REF TO)	IF_CMP_CALLBACK		Callback Interface	20060529
2	Importing	I_REG_ID	Value transfer	☐	Type reference (TYPE)	CSEQUENCE	'*'	Registrierungs ID (Pattern)	20060529

Method ADD_CALLBACK_REF on class CL_CMP_COMPOSER has no exception.

Method ADD_SLOTS_FROM_PROG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_CLEAR_PREVIOUS	Value transfer	☑	Type reference (TYPE)	XFELD		Vorher vorhandene Slots löschen	20070912
2	Importing	I_PROG	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20051215
3	Importing	I_TAB_CODE	Value transfer	☑	Type reference (TYPE)	TAB_CODE			20070112
4	Returning	R_TAB_SLOTS	Value transfer	☐	Type reference (TYPE)	IF_CMP_SLOT=>TAB			20051215

#	Exception	Resumable	Description	Created on
1	CX_STATIC_CHECK	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20051215

Method ADD_VAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	CSEQUENCE			20051109
2	Importing	I_VALUE	Value transfer	☐	Type reference (TYPE)	ANY			20051109

#	Exception	Resumable	Description	Created on
1	CX_CMP_DYN	☐		20130919

Method BREAK_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FLG_BREAK	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20090518

Method BREAK_CREATE on class CL_CMP_COMPOSER has no exception.

Method BUILD_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Area (optional)	20051109
2	Importing	I_FLG_DECOMMENT	Value transfer	☑	Type reference (TYPE)	C		Template Code dekommentieren	20051109
3	Importing	I_TEMPLATE_INCLUDE	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Name des Includes in dem sich	20051109
4	Importing	I_TEMPLATE_NAME	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		NEU: TEMPLATE	20100414
5	Returning	R_TAB_CODE	Value transfer	☐	Type reference (TYPE)	TAB_CODE		Coding	20051109

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Fehler beim Generieren	20071108
2	CX_CMP_INVALID_PARAM	☐	Initialer Parameter	20100414

Method BUILD_CODE_DIRECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Area (optional)	20061018
2	Importing	I_FLG_DECOMMENT	Value transfer	☑	Type reference (TYPE)	C		Template Code dekommentieren	20061018
3	Importing	I_TAB_TEMPL_CODE	Value transfer	☑	Type reference (TYPE)	TAB_CODE		Name des Includes in dem sich	20061018
4	Importing	I_TAB_TEMPL_CODE_LONG	Value transfer	☑	Type reference (TYPE)	TAB_CODE_LONG			20130422
5	Returning	R_TAB_CODE	Value transfer	☐	Type reference (TYPE)	TAB_CODE		Coding	20061018

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Fehler beim Generieren	20071108

Method BUILD_CODE_DIRECT_LONG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Area (optional)	20130612
2	Importing	I_FLG_DECOMMENT	Value transfer	☑	Type reference (TYPE)	C		Template Code dekommentieren	20130612
3	Importing	I_TAB_TEMPL_CODE	Value transfer	☑	Type reference (TYPE)	TAB_CODE		Name des Includes in dem sich	20130612
4	Importing	I_TAB_TEMPL_CODE_LONG	Value transfer	☑	Type reference (TYPE)	TAB_CODE_LONG			20130612
5	Returning	R_TAB_CODE	Value transfer	☐	Type reference (TYPE)	TAB_CODE_LONG		Coding	20130612

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Fehler beim Generieren	20130612

Method BUILD_CODE_LONG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Area (optional)	20130612
2	Importing	I_FLG_DECOMMENT	Value transfer	☑	Type reference (TYPE)	C		Template Code dekommentieren	20130612
3	Importing	I_TEMPLATE_INCLUDE	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Name des Includes in dem sich	20130612
4	Importing	I_TEMPLATE_NAME	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		NEU: TEMPLATE	20130612
5	Returning	R_TAB_CODE	Value transfer	☐	Type reference (TYPE)	TAB_CODE_LONG		Coding	20130612

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Fehler beim Generieren	20130612
2	CX_CMP_INVALID_PARAM	☐	Initialer Parameter	20130612

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CMP_COMPOSER has no parameter.
Method CONSTRUCTOR on class CL_CMP_COMPOSER has no exception.

Method CREATE_REPEAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	CSEQUENCE			20051110
2	Returning	R_REF_REPEAT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CMP_REPEAT		Context für wiederholende Blöcke	20051111

Method CREATE_REPEAT on class CL_CMP_COMPOSER has no exception.

Method DEFINE_SLOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	CSEQUENCE		Name des Slots	20051123
2	Returning	R_REF_SLOT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CMP_SLOT		Interface zur Trennung von Code Abschnitten	20051124

Method DEFINE_SLOT on class CL_CMP_COMPOSER has no exception.

Method GET_CORRESPONDING_TEMPL_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LINE_NO	Value transfer	☐	Type reference (TYPE)	I			20080114
2	Returning	R_STR_TEMPL_LINE	Value transfer	☐	Type reference (TYPE)	STR_TEMPL_LINE			20080114

Method GET_CORRESPONDING_TEMPL_LINE on class CL_CMP_COMPOSER has no exception.

Method INIT_CONTEXT Signature

Method INIT_CONTEXT on class CL_CMP_COMPOSER has no parameter.
Method INIT_CONTEXT on class CL_CMP_COMPOSER has no exception.

Method RAISE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROG	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20071108
2	Importing	I_RCX_FAILURE	Call by reference	☐	Object reference (TYPE REF TO)	LCX_CMP_FAILURE			20071108

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Fehlerklasse Code Composer	20071108

Method S_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLASSNAME	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20100715
2	Importing	I_ID	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		ID der Composer Instanz	20090427
3	Returning	R_REF_COMPOSER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CMP_COMPOSER		Code Composer	20051109

Method S_CREATE on class CL_CMP_COMPOSER has no exception.

Method S_FIND_SLOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	CSEQUENCE		Name des Slots	20051125
2	Importing	I_PROG	Value transfer	☑	Type reference (TYPE)	CSEQUENCE		Programmname	20051125
3	Importing	I_TAB_CODE	Value transfer	☑	Type reference (TYPE)	TAB_CODE		Source Code (Alternativ)	20070222
4	Importing	I_TAB_CODE_LONG	Value transfer	☑	Type reference (TYPE)	TAB_CODE_LONG			20130422
5	Returning	R_REF_SLOT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CMP_SLOT		Interface zur Trennung von Code Abschnitten	20051125

#	Exception	Resumable	Description	Created on
1	CX_STATIC_CHECK	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20051125

Method S_GET_ALL_ANNOTATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROG	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20051129
2	Importing	I_TAB_CODE	Call by reference	☑	Type reference (TYPE)	TAB_CODE			20070104
3	Returning	R_TAB_ANNOTATIONS	Value transfer	☐	Type reference (TYPE)	IF_CMP_ANNOTATION=>TAB			20051129

#	Exception	Resumable	Description	Created on
1	CX_STATIC_CHECK	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20051213

Method S_GET_ALL_SLOTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROG	Call by reference	☑	Type reference (TYPE)	CSEQUENCE		Name des Programmes	20051125
2	Importing	I_TAB_CODE	Call by reference	☑	Type reference (TYPE)	TAB_CODE			20070104
3	Returning	R_TAB_SLOTS	Value transfer	☐	Type reference (TYPE)	IF_CMP_SLOT=>TAB		Tabelle von Slots	20051125

#	Exception	Resumable	Description	Created on
1	CX_STATIC_CHECK	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20051125

Method S_INITIALIZE Signature

Method S_INITIALIZE on class CL_CMP_COMPOSER has no parameter.
Method S_INITIALIZE on class CL_CMP_COMPOSER has no exception.

Method S_SYNTAX_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_DECOMMENT	Value transfer	☑	Type reference (TYPE)	C			20060127
2	Importing	I_TEMPL_INCLUDE	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20051208
3	Importing	I_TEMPL_NAME	Value transfer	☑	Type reference (TYPE)	CSEQUENCE			20100414
4	Returning	R_FLG_IS_TEMPLATE	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20051212

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20080128

Method S_SYNTAX_CHECK_DIRECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_TEMPL_CODE	Value transfer	☑	Type reference (TYPE)	TAB_CODE			20120820
2	Importing	I_TAB_TEMPL_CODE_LONG	Value transfer	☑	Type reference (TYPE)	TAB_CODE_LONG			20130422

#	Exception	Resumable	Description	Created on
1	CX_CMP_FAILURE	☐	Ausnahmen mit statischer und dynamischer Prüfung von RAISING	20120820

History

Last changed by/on	SAP	20141121
SAP Release Created in	710