empty
Documentation

# 1 Package API BASE

The API system classes and components
DO NOT MODIFY THEM !!!

## 1.1 Class View API BASE class view

The API system classes
DO NOT MODIFY THEM !!!

Class aRelationKind

Class aDirection

Class aVisibility

Class anItemKind

Class UmlParameter

Class UmlBaseActualParameter

Class UmlBaseFormalParameter

Class UmlTypeSpec

Class UmlBaseAttribute

Class UmlBaseClass

Class UmlBaseClassItem

Class UmlBaseClassDiagram

Class UmlBaseObjectDiagram

Class UmlBaseClassMember

Class UmlBaseClassView

Class UmlBaseArtifact

Class UmlBaseComponent

Class UmlBaseCollaborationDiagram

Class UmlBaseComponentDiagram

Class UmlBaseComponentView

Class UmlBaseDeploymentDiagram

Class UmlBaseDeploymentView

Class UmlBaseDeployment

Class UmlBaseDiagram

Class UmlBaseExtraClassMember

Class UmlBaseItem

Class UmlBaseNode

Class UmlBaseOperation

Class UmlBasePackage

Class UmlBaseRelation

Class UmlBaseNcRelation

Class UmlBaseSequenceDiagram

Class UmlBaseUseCase

Class UmlBaseUseCaseDiagram

Class UmlBaseUseCaseView

Class UmlBaseState

Class UmlBaseStateDiagram

Class StateBehavior

Class UmlBaseTransition

Class TransitionBehavior

Class UmlBaseRegion

Class UmlBaseStateAction

Class UmlBaseInitialPseudoState

Class UmlBaseEntryPointPseudoState

Class UmlBaseFinalState

Class UmlBaseTerminatePseudoState

Class UmlBaseExitPointPseudoState

Class UmlBaseDeepHistoryPseudoState

Class UmlBaseShallowHistoryPseudoState

Class UmlBaseJunctionPseudoState

Class UmlBaseChoicePseudoState

Class UmlBaseForkPseudoState

Class UmlBaseJoinPseudoState

Class UmlBuiltin

Class UmlStereotype

## 1.2 Deployment View API BASE Deployment view

The API system artifacts
DO NOT MODIFY THEM !!!

Artifact UmlBaseActualParameter

Artifact source associated with : UmlBaseActualParameter

Artifact UmlBaseClassItem

Artifact source associated with : UmlBaseClassItem

Artifact UmlBaseFormalParameter

Artifact source associated with : UmlBaseFormalParameter

Artifact UmlTypeSpec

Artifact source associated with : UmlTypeSpec

Artifact UmlBaseAttribute

Artifact source associated with : UmlBaseAttribute

Artifact UmlBaseClass

Artifact source associated with : UmlBaseClass

Artifact UmlBaseClassDiagram

Artifact source associated with : UmlBaseClassDiagram

Artifact UmlBaseClassMember

Artifact source associated with : UmlBaseClassMember

Artifact UmlBaseClassView

Artifact source associated with : UmlBaseClassView

Artifact UmlBaseCollaborationDiagram

Artifact source associated with : UmlBaseCollaborationDiagram

Artifact UmlBaseArtifact

Artifact source associated with : UmlBaseArtifact

Artifact UmlBaseComponent

Artifact source associated with : UmlBaseComponent

Artifact UmlBaseComponentDiagram

Artifact source associated with : UmlBaseComponentDiagram

Artifact UmlBaseComponentView

Artifact source associated with : UmlBaseComponentView

Artifact UmlBaseDeployment

Artifact source associated with : UmlBaseDeployment

Artifact UmlBaseDeploymentDiagram

Artifact source associated with : UmlBaseDeploymentDiagram

Artifact UmlBaseDeploymentView

Artifact source associated with : UmlBaseDeploymentView

Artifact UmlBaseDiagram

Artifact source associated with : UmlBaseDiagram

Artifact UmlBaseExtraClassMember

Artifact source associated with : UmlBaseExtraClassMember

Artifact UmlBaseItem

Artifact source associated with : UmlBaseItem

Artifact UmlBaseNode

Artifact source associated with : UmlBaseNode

Artifact UmlBaseOperation

Artifact source associated with : UmlBaseOperation

Artifact UmlBasePackage

Artifact source associated with : UmlBasePackage

Artifact UmlBaseRelation

Artifact source associated with : UmlBaseRelation

Artifact UmlBaseNcRelation

Artifact source associated with : UmlBaseNcRelation

Artifact UmlBaseSequenceDiagram

Artifact source associated with : UmlBaseSequenceDiagram

Artifact UmlBaseUseCase

Artifact source associated with : UmlBaseUseCase

Artifact UmlBaseUseCaseDiagram

Artifact source associated with : UmlBaseUseCaseDiagram

Artifact UmlBaseUseCaseView

Artifact source associated with : UmlBaseUseCaseView

Artifact UmlBaseState

Artifact source associated with : UmlBaseState

Artifact UmlBaseStateDiagram

Artifact source associated with : UmlBaseStateDiagram

Artifact StateBehavior

Artifact source associated with : StateBehavior

Artifact UmlBaseTransition

Artifact source associated with : UmlBaseTransition

Artifact TransitionBehavior

Artifact source associated with : TransitionBehavior

Artifact UmlBaseRegion

Artifact source associated with : UmlBaseRegion

Artifact UmlBaseStateAction

Artifact source associated with : UmlBaseStateAction

Artifact UmlBaseInitialPseudoState

Artifact source associated with : UmlBaseInitialPseudoState

Artifact UmlBaseEntryPointPseudoState

Artifact source associated with : UmlBaseEntryPointPseudoState

Artifact UmlBaseFinalState

Artifact source associated with : UmlBaseFinalState

Artifact UmlBaseTerminatePseudoState

Artifact source associated with : UmlBaseTerminatePseudoState

Artifact UmlBaseExitPointPseudoState

Artifact source associated with : UmlBaseExitPointPseudoState

Artifact UmlBaseDeepHistoryPseudoState

Artifact source associated with : UmlBaseDeepHistoryPseudoState

Artifact UmlBaseShallowHistoryPseudoState

Artifact source associated with : UmlBaseShallowHistoryPseudoState

Artifact UmlBaseJunctionPseudoState

Artifact source associated with : UmlBaseJunctionPseudoState

Artifact UmlBaseChoicePseudoState

Artifact source associated with : UmlBaseChoicePseudoState

Artifact UmlBaseForkPseudoState

Artifact source associated with : UmlBaseForkPseudoState

Artifact UmlBaseJoinPseudoState

Artifact source associated with : UmlBaseJoinPseudoState

Artifact aRelationKind

Artifact source associated with : aRelationKind

Artifact aDirection

Artifact source associated with : aDirection

Artifact aVisibility

Artifact source associated with : aVisibility

Artifact anItemKind

Artifact source associated with : anItemKind

Artifact UmlParameter

Artifact source associated with : UmlParameter

Artifact UmlBuiltin

Artifact source associated with : UmlBuiltin

Artifact UmlStereotype

Artifact source associated with : UmlStereotype

Artifact UmlBaseObjectDiagram

Artifact source associated with : UmlBaseObjectDiagram

## 1.3 Package Settings

The API system classes and components concerning the settings
DO NOT MODIFY THEM !!!

### 1.3.1 Class View Settings Class view

The API system classes concerning the settings
DO NOT MODIFY THEM !!!

Class CppSettings

Class IdlSettings

Class JavaSettings

Class UmlSettings

### 1.3.2 Deployment View Settings Deployment view

The API system artifacts concerning the settings
DO NOT MODIFY THEM !!!

Artifact CppSettings

Artifact source associated with : CppSettings

Artifact IdlSettings

Artifact source associated with : IdlSettings

Artifact JavaSettings

Artifact source associated with : JavaSettings

Artifact UmlSettings

Artifact source associated with : UmlSettings

## 1.4 Package Com

The API system classes and components concerning the communication with BOUML
DO NOT MODIFY THEM !!!

### 1.4.1 Class View Com Class view

The API system classes concerning the communication with BOUML
DO NOT MODIFY THEM !!!

Class UmlCom

Class CmdFamily

Class MiscGlobalCmd

Class OnInstanceCmd

Class ClassGlobalCmd

Class PackageGlobalCmd

Class UmlSettingsCmd

Class CppSettingsCmd

Class JavaSettingsCmd

Class IdlSettingsCmd

### 1.4.2 Deployment View Com Deployment view

The API system artifacts concerning the communication with BOUML
DO NOT MODIFY THEM !!!

Artifact UmlCom

Artifact source associated with : UmlCom

Artifact CmdFamily

Artifact source associated with : CmdFamily

Artifact MiscGlobalCmd

Artifact source associated with : MiscGlobalCmd

Artifact OnInstanceCmd

Artifact source associated with : OnInstanceCmd

Artifact ClassGlobalCmd

Artifact source associated with : ClassGlobalCmd

Artifact PackageGlobalCmd

Artifact source associated with : PackageGlobalCmd

Artifact UmlSettingsCmd

Artifact source associated with : UmlSettingsCmd

Artifact CppSettingsCmd

Artifact source associated with : CppSettingsCmd

Artifact JavaSettingsCmd

Artifact source associated with : JavaSettingsCmd

Artifact IdlSettingsCmd

Artifact source associated with : IdlSettingsCmd

# 2 Package API USER

'your' API classes and components, modify them !

## 2.1 Class View Diagrams

Some diagrams describing the API classes organisation

Package and Views classes inheritance diagram

Class and class members classes inheritance diagram

State (1)

State (2)

State (3)

Diagrams classes inheritance diagram

Typical Execution

Class bouml

Class plug_out

## 2.2 Class View API USER class view

'your' API classes, modify them !

Class UmlActualParameter

Class UmlFormalParameter

Class UmlAttribute

Class UmlClass

Class UmlClassDiagram

Class UmlObjectDiagram

Class UmlClassItem

Class UmlClassMember

Class UmlClassView

Class UmlCollaborationDiagram

Class UmlComponentDiagram

Class UmlComponentView

Class UmlArtifact

Class UmlComponent

Class UmlDeploymentDiagram

Class UmlDeploymentView

Class UmlDiagram

Class UmlExtraClassMember

Class UmlItem

Class UmlNode

Class UmlOperation

Class UmlPackage

Class UmlRelation

Class UmlNcRelation

Class UmlSequenceDiagram

Class UmlUseCase

Class UmlUseCaseDiagram

Class UmlUseCaseView

Class UmlStateItem

Class UmlState

Class UmlStateDiagram

Class UmlTransition

Class UmlRegion

Class UmlStateAction

Class UmlPseudoState

Class UmlInitialPseudoState

Class UmlEntryPointPseudoState

Class UmlFinalState

Class UmlTerminatePseudoState

Class UmlExitPointPseudoState

Class UmlDeepHistoryPseudoState

Class UmlShallowHistoryPseudoState

Class UmlJunctionPseudoState

Class UmlChoicePseudoState

Class UmlForkPseudoState

Class UmlJoinPseudoState

## 2.3 Deployment View API USER Deployment view

'your' API artifacts modify them !
Do not forget to modify Main !

Artifact executable

Reference all the components used to made a C++ executable,
used by 'genpro' to produce a .pro file allowing to produce a Makefile
with 'tmake' or 'qmake'

executable associated with : UmlBaseClassMember, UmlStateAction, UmlBaseFinalState, UmlBaseChoicePseudoState, UmlFormalParameter, UmlStereotype, UmlSettings, UmlState, UmlBaseOperation, UmlClass, TransitionBehavior, UmlOperation, UmlBaseTerminatePseudoState, UmlBaseExitPointPseudoState, IdlSettings, MiscGlobalCmd, JavaSettingsCmd, UmlBaseDeploymentView, UmlBaseComponentDiagram, UmlSequenceDiagram, UmlBaseInitialPseudoState, UmlFinalState, UmlBaseComponent, UmlBaseActualParameter, UmlDiagram, CmdFamily, UmlClassMember, UmlBaseState, UmlBaseNode, ClassGlobalCmd, UmlStateDiagram, UmlBaseClass, UmlBaseClassDiagram, UmlBaseRegion, UmlAttribute, UmlEntryPointPseudoState, aVisibility, UmlBaseDeployment, UmlNcRelation, UmlBaseClassView, UmlClassDiagram, JavaSettings, UmlBaseStateDiagram, UmlForkPseudoState, UmlBaseForkPseudoState, UmlTerminatePseudoState, aRelationKind, UmlBaseArtifact, UmlBaseUseCase, UmlBaseStateAction, UmlBaseSequenceDiagram, UmlBaseUseCaseView, UmlBaseExtraClassMember, UmlTransition, IdlSettingsCmd, PackageGlobalCmd, UmlCom, UmlPackage, UmlDeepHistoryPseudoState, UmlBaseComponentView, UmlBaseEntryPointPseudoState, UmlJunctionPseudoState, Main, UmlComponent, UmlRelation, UmlClassItem, anItemKind, UmlExtraClassMember, UmlBaseCollaborationDiagram, UmlBaseAttribute, UmlJoinPseudoState, UmlUseCaseDiagram, UmlBaseShallowHistoryPseudoState, UmlBaseDeepHistoryPseudoState, UmlSettingsCmd, UmlBaseItem, UmlPseudoState, UmlUseCase, UmlExitPointPseudoState, UmlCollaborationDiagram, UmlBaseClassItem, UmlBaseNcRelation, UmlBaseRelation, UmlDeploymentView, UmlBaseJunctionPseudoState, UmlShallowHistoryPseudoState, StateBehavior, UmlClassView, UmlArtifact, UmlUseCaseView, CppSettingsCmd, UmlInitialPseudoState, UmlChoicePseudoState, UmlBaseDiagram, UmlBasePackage, UmlStateItem, UmlBaseJoinPseudoState, UmlBaseTransition, UmlItem, UmlBaseFormalParameter, UmlDeploymentDiagram, UmlComponentView, OnInstanceCmd, CppSettings, UmlComponentDiagram, UmlBaseUseCaseDiagram, UmlBaseDeploymentDiagram, aDirection, UmlTypeSpec, UmlNode, UmlActualParameter, UmlRegion

Artifact Main

The main function, you have to modify at least the line containing
UmlCom::targetItem()->???();
it if you want your program does something !

Artifact source

Artifact UmlActualParameter

Artifact source associated with : UmlActualParameter

Artifact UmlClassItem

Artifact source associated with : UmlClassItem

Artifact UmlFormalParameter

Artifact source associated with : UmlFormalParameter

Artifact UmlAttribute

Artifact source associated with : UmlAttribute

Artifact UmlClass

Artifact source associated with : UmlClass

Artifact UmlClassDiagram

Artifact source associated with : UmlClassDiagram

Artifact UmlClassMember

Artifact source associated with : UmlClassMember

Artifact UmlClassView

Artifact source associated with : UmlClassView

Artifact UmlCollaborationDiagram

Artifact source associated with : UmlCollaborationDiagram

Artifact UmlArtifact

Artifact source associated with : UmlArtifact

Artifact UmlComponent

Artifact source associated with : UmlComponent

Artifact UmlComponentDiagram

Artifact source associated with : UmlComponentDiagram

Artifact UmlComponentView

Artifact source associated with : UmlComponentView

Artifact UmlDeploymentDiagram

Artifact source associated with : UmlDeploymentDiagram

Artifact UmlDeploymentView

Artifact source associated with : UmlDeploymentView

Artifact UmlDiagram

Artifact source associated with : UmlDiagram

Artifact UmlExtraClassMember

Artifact source associated with : UmlExtraClassMember

Artifact UmlItem

Artifact source associated with : UmlItem

Artifact UmlNode

Artifact source associated with : UmlNode

Artifact UmlOperation

Artifact source associated with : UmlOperation

Artifact UmlPackage

Artifact source associated with : UmlPackage

Artifact UmlRelation

Artifact source associated with : UmlRelation

Artifact UmlNcRelation

Artifact source associated with : UmlNcRelation

Artifact UmlSequenceDiagram

Artifact source associated with : UmlSequenceDiagram

Artifact UmlUseCase

Artifact source associated with : UmlUseCase

Artifact UmlUseCaseDiagram

Artifact source associated with : UmlUseCaseDiagram

Artifact UmlUseCaseView

Artifact source associated with : UmlUseCaseView

Artifact UmlStateItem

Artifact source associated with : UmlStateItem

Artifact UmlState

Artifact source associated with : UmlState

Artifact UmlStateDiagram

Artifact source associated with : UmlStateDiagram

Artifact UmlTransition

Artifact source associated with : UmlTransition

Artifact UmlRegion

Artifact source associated with : UmlRegion

Artifact UmlStateAction

Artifact source associated with : UmlStateAction

Artifact UmlPseudoState

Artifact source associated with : UmlPseudoState

Artifact UmlInitialPseudoState

Artifact source associated with : UmlInitialPseudoState

Artifact UmlEntryPointPseudoState

Artifact source associated with : UmlEntryPointPseudoState

Artifact UmlFinalState

Artifact source associated with : UmlFinalState

Artifact UmlTerminatePseudoState

Artifact source associated with : UmlTerminatePseudoState

Artifact UmlExitPointPseudoState

Artifact source associated with : UmlExitPointPseudoState

Artifact UmlDeepHistoryPseudoState

Artifact source associated with : UmlDeepHistoryPseudoState

Artifact UmlShallowHistoryPseudoState

Artifact source associated with : UmlShallowHistoryPseudoState

Artifact UmlJunctionPseudoState

Artifact source associated with : UmlJunctionPseudoState

Artifact UmlChoicePseudoState

Artifact source associated with : UmlChoicePseudoState

Artifact UmlForkPseudoState

Artifact source associated with : UmlForkPseudoState

Artifact UmlJoinPseudoState

Artifact source associated with : UmlJoinPseudoState

Artifact UmlObjectDiagram

Artifact source associated with : UmlObjectDiagram