diff --git a/doc/devel/uml/class148997.html b/doc/devel/uml/class148997.html index 85ab6a55d..b5af009ca 100644 --- a/doc/devel/uml/class148997.html +++ b/doc/devel/uml/class148997.html @@ -16,11 +16,6 @@ -

Declaration :

- -
Relation targets (<directional composition>)

Declaration :

Stereotype: list

- -
Relation params (<directional composition>)

Declaration :

Stereotype: list

-
+

Declaration :

Directly inherited by : ArgumentHolder Closure

diff --git a/doc/devel/uml/class149637.html b/doc/devel/uml/class149637.html index da4da6a27..21f30ad43 100644 --- a/doc/devel/uml/class149637.html +++ b/doc/devel/uml/class149637.html @@ -4,17 +4,17 @@ -Class Target +Class ParamAccessor -
Class Target
+
Class ParamAccessor

-

Declaration :

+

Declaration :

diff --git a/doc/devel/uml/class150789.html b/doc/devel/uml/class150789.html new file mode 100644 index 000000000..f6e0b20ae --- /dev/null +++ b/doc/devel/uml/class150789.html @@ -0,0 +1,24 @@ + + + + + + +Class Closure + + + + + +
Class Closure
+

+ + + + +

Declaration :

+ +
Relation params (<directional composition>)

Declaration :

Stereotype: tuple

+
+ + diff --git a/doc/devel/uml/class150917.html b/doc/devel/uml/class150917.html new file mode 100644 index 000000000..2332f06df --- /dev/null +++ b/doc/devel/uml/class150917.html @@ -0,0 +1,24 @@ + + + + + + +Class ArgumentHolder + + + + + +
Class ArgumentHolder
+

+ + + + +

Declaration :

+ +
Relation arguments (<unidirectional association>)

Declaration :

Stereotype: manages

+
+ + diff --git a/doc/devel/uml/classes.html b/doc/devel/uml/classes.html index 8c54eb58f..ebec4c117 100644 --- a/doc/devel/uml/classes.html +++ b/doc/devel/uml/classes.html @@ -21,6 +21,7 @@ Allocationa directive to place a MObject in a specific way AppconfigsingletonSingleton to hold inevitable global flags and constants and for performing erarly (static) global initialization tasks. Applicable +ArgumentHolder AssemblerThis is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects AssetinterfaceSuperinterface describing especially the bookeeping properties of Assets AssetManagerboundaryFacade for the Asset subsystem @@ -38,6 +39,7 @@ Categorytree like classification of Assets Clipbookkeeping (asset) view of a media clip. Clip +Closure CmdClosure Codecdescription of some media data decoder or encoder facility CodecAdapter @@ -107,6 +109,7 @@ NodeCreatorToolThis Tool implementation plays the central role in the buld process: given a MObject from Session, it is able to attach ProcNodes to the render engine under construction such as to reflect the properties of the MObject in the actual render. NodeWiring OperationBase +ParamAccessor ParameterDescriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated. ParamProviderinterfaceA facility to get the actual value of a plugin/effect parameter PathManagerWhile building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state) @@ -164,7 +167,6 @@ StreamTypeID Structkey abstraction: structural asset STypeManager -Target ThreadWe can basically reuse the Thread class design from Cinelerra2, Thread becomes a baseclass for all Threads Timedenotes a temporal position (time point), based on timeline start.

investigate posix.4 realtime timers, wrap these here Timeline diff --git a/doc/devel/uml/classes_list.html b/doc/devel/uml/classes_list.html index c9f7a4cd0..173ec52e4 100644 --- a/doc/devel/uml/classes_list.html +++ b/doc/devel/uml/classes_list.html @@ -22,6 +22,7 @@ Allocation
Appconfig
Applicable
+ArgumentHolder
Assembler
Asset
AssetManager
@@ -39,6 +40,7 @@ Category
Clip
Clip
+Closure
CmdClosure
Codec
CodecAdapter
@@ -108,6 +110,7 @@ NodeCreatorTool
NodeWiring
OperationBase
+ParamAccessor
Parameter
ParamProvider
PathManager
@@ -165,7 +168,6 @@ StreamTypeID
Struct
STypeManager
-Target
Thread
Time
Timeline
diff --git a/doc/devel/uml/fig134021.png b/doc/devel/uml/fig134021.png index c3acb3677..edd544530 100644 Binary files a/doc/devel/uml/fig134021.png and b/doc/devel/uml/fig134021.png differ diff --git a/doc/devel/uml/fig135173.png b/doc/devel/uml/fig135173.png new file mode 100644 index 000000000..4097c8a39 Binary files /dev/null and b/doc/devel/uml/fig135173.png differ diff --git a/doc/devel/uml/index.html b/doc/devel/uml/index.html index 2e6e4c680..4cbf83614 100644 --- a/doc/devel/uml/index.html +++ b/doc/devel/uml/index.html @@ -147,7 +147,7 @@ Documentation
Artifact Lumiera

the main executable to be built

Depends on common

Depends on gui

Depends on proc

Depends on backend

Stereotype: executable

-

executable associated with : placement, sessionimpl, builderfacade, aframe, assembler, trafo, allocation, vframe, toolfactory, hub, buildable, abstractmo, exitnode, pathmanager, track, meta, fixedlocation, relativelocation, controllerfacade, rendergraph, pluginadapter, explicitplacement, auto, glrender, arender, renderstate, label, nodecreatertool, projector, interpolator, paramprovider, mask, mobject, source, frame, effect, buildertool, segmentationtool, link, parameter, renderengine, glbuf, procnode, stateproxy, edl, fixture, glpipe, main, conmanager, clip, vrender

+

executable associated with : allocation, vframe, toolfactory, hub, buildable, abstractmo, exitnode, pathmanager, track, meta, fixedlocation, relativelocation, controllerfacade, rendergraph, pluginadapter, explicitplacement, auto, glrender, arender, renderstate, label, nodecreatertool, projector, interpolator, paramprovider, mask, mobject, source, frame, effect, buildertool, segmentationtool, link, parameter, renderengine, glbuf, procnode, stateproxy, edl, fixture, glpipe, main, conmanager, clip, vrender, placement, sessionimpl, builderfacade, aframe, assembler, trafo

Artifact main

Stereotype: source

@@ -844,8 +844,106 @@ reuse exiting Engine

Selection :

Transformation
Class DoAsync
Class UndoSync
Class RedoLast
-
Class Target
+
Class ParamAccessor
Class ProcDispatcher
+
Class Closure
+
Class ArgumentHolder
+ +

2.2.2.1 StateMachine Lifecycle

+

Entry Behavior :

Exit Behavior :

Do activity :

Stereotype: machine

+
+ +

+

Command lifecycle



+ + +
Entry point pseudo state ID
+

Defined in Lifecycle

+
Transition <transition>

From ID To state action

Trigger :

Guard :

Activity :

+ +
State action
+

try to fetch existing definition

+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To choice pseudo state

Trigger :

Guard :

Activity :

+ +

2.2.2.1.1 State scratch

+

Entry Behavior :

Exit Behavior :

Do activity :

+
Transition <transition>

From scratch To state action

Trigger :

Guard :

Activity :

+ +
State action
+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To fork pseudo state

Trigger :

Guard :

Activity :

Transition <transition>

From state action To state action

Trigger :

Guard :

Activity :

Transition <transition>

From state action To state action

Trigger :

Guard :

Activity :

+ +
State action
+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To state action

Trigger :

Guard :

Activity :

+ +
State action
+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To CmdDef

Trigger :

Guard :

Activity :

+ +
State action
+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To state action

Trigger :

Guard :

Activity :

+ +
State action
+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To CmdDef

Trigger :

Guard :

Activity :

+ +

2.2.2.1.2 State CmdDef

+

Entry Behavior :

Exit Behavior :

Do activity :

+
Transition <transition>

From CmdDef To state action

Trigger :

Guard :

Activity :

+ +
State action
+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To Command

Trigger :

Guard :

Activity :

+ +

2.2.2.1.3 State Command

+

Entry Behavior :

Exit Behavior :

Do activity :

+
Transition <transition>

From Command To state action

Trigger :

Guard :

Activity :

+ +
State action send-signal
+

Stereotype: send-signal

+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To undo-able

Trigger :

Guard :

Activity :

+ +

2.2.2.1.4 State undo-able

+

Entry Behavior :

Exit Behavior :

Do activity :

+
Transition <transition>

From undo-able To done

Trigger :

Guard :

Activity :

Transition <transition>

From undo-able To state action

Trigger :

Guard :

Activity :

Transition <transition>

From undo-able To state action

Trigger :

Guard :

Activity :

+ + +
Choice pseudo state
+

Stereotype: try

+

Defined in Lifecycle

+
Transition <transition>

From choice pseudo state To scratch

Trigger :

Guard :

Activity :

Transition <transition>

From choice pseudo state To CmdDef

Trigger :

Guard :

Activity :

+ + +
Fork pseudo state
+

Defined in Lifecycle

+
Transition <transition>

From fork pseudo state To state action

Trigger :

Guard :

Activity :

Transition <transition>

From fork pseudo state To state action

Trigger :

Guard :

Activity :

+ + +
Fork pseudo state
+

Defined in Lifecycle

+ +
Exit point pseudo state done
+

Defined in Lifecycle

+
State action send-signal
+

Stereotype: send-signal

+

Defined in Lifecycle

Expression :

+
Transition <transition>

From state action To undo-able

Trigger :

Guard :

Activity :

+
diff --git a/doc/devel/uml/index_60.html b/doc/devel/uml/index_60.html index 8712d7074..ab6befaf1 100644 --- a/doc/devel/uml/index_60.html +++ b/doc/devel/uml/index_60.html @@ -28,8 +28,8 @@ <flow>transition <flow>transition <flow>transition -<flow>transition <flow>transition +<flow>transition <flow>transition <flow>transition <flow>transition @@ -37,6 +37,28 @@ <flow>transition <flow>transition <flow>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition +<transition>transition diff --git a/doc/devel/uml/index_65.html b/doc/devel/uml/index_65.html index da137cab0..38dfaced6 100644 --- a/doc/devel/uml/index_65.html +++ b/doc/devel/uml/index_65.html @@ -41,6 +41,8 @@ applyoperation Architecturecomponent viewThe various Components comprising the Lumiera Video editing Application arenderartifactRepresentation of a Audio Render process +ArgumentHolderclass +argumentsrelation AssemblerclassThis is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects assemblerartifactbuilding facility (implementation of the build process) AssetclassSuperinterface describing especially the bookeeping properties of Assets @@ -58,8 +60,8 @@ aud_aclass instance aud_Aclass instance audioclass instance -audio1class instance audio1class instance +audio1class instance audio1class instance autoartifactMedia Object holding automation data AutoclassAutomation data for some parameter (i.e. a time varying function) diff --git a/doc/devel/uml/index_66.html b/doc/devel/uml/index_66.html index 5a4df3c38..2788567d7 100644 --- a/doc/devel/uml/index_66.html +++ b/doc/devel/uml/index_66.html @@ -37,8 +37,8 @@ buildableartifactmarker interface denoting any MObject able to be treated by Tools buildEngineoperationMain Operation of the Builder: create a render engine for a given part of the timeline Buildercomponent -Builderpackage builderpackagesourcecode package

The Builder creating the Render Engine,
located within the MObject Subsystem +Builderpackage Builder Entitiesclass diagram Builder Tool (Visitor)class diagram Builder Workingsclass view diff --git a/doc/devel/uml/index_67.html b/doc/devel/uml/index_67.html index 128becdac..a8a98a5d6 100644 --- a/doc/devel/uml/index_67.html +++ b/doc/devel/uml/index_67.html @@ -33,34 +33,35 @@ chainrelationChain of additional Placements further constraining the position of this MObject checked_inrelationchecked_in objects are subject of cache aging and must be not in use checked_outrelationthis list keeps all mappings which are in use, and thus prevents them from Cache aging -class instanceclass instance +choice pseudo statechoice pseudo state +class instanceclass instance class instanceclass instance +class instanceclass instance class instanceclass instance +class instanceclass instance +class instanceclass instance class instanceclass instance class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance clearoperationclear current session contents
without resetting overall session config.
Afterwards, the session will contain only one
empty EDL, while all Assets are retained.
client codecomponent Clipclassbookkeeping (asset) view of a media clip. @@ -69,14 +70,18 @@ Clipclass clipsrelation closureattribute +Closureclass CmdClosureclass +CmdDefstate Codecclassdescription of some media data decoder or encoder facility codecartifactdescription of some media data decoder or encoder facility CodecAdapterclass codecadapterartifactProcessing Node for (de)coding media data codegenpackageThis package is used to organize code generation by BOUML. It is considered useless after having generated the initial code skeleton. CommandclassKey abstraction for all proc/edit operations and UNDO management +Commandstate Command Handlingclass view +Command lifecyclestate diagram Command structureclass diagram commonpackagesourcecode package

Common library and helper classes CommonLibcomponent diff --git a/doc/devel/uml/index_68.html b/doc/devel/uml/index_68.html index 40b7b291d..580695e3a 100644 --- a/doc/devel/uml/index_68.html +++ b/doc/devel/uml/index_68.html @@ -32,14 +32,15 @@ designpackage designpackageAll things concering the big picture.
Not a real code package, rather a container for design drafts, specifications, decisions. detect Channelsuse case -determine Render Paramsexpansion region determine Render Paramsopaque activity action +determine Render Paramsexpansion region devnullclass instance Dispatchercomponent dispatchOpoperation doattribute DoAsyncclass DoAttachclass +doneexit point pseudo state DoRecurseclass DoSyncclass diff --git a/doc/devel/uml/index_69.html b/doc/devel/uml/index_69.html index 0c6f365e7..3c4e4f7af 100644 --- a/doc/devel/uml/index_69.html +++ b/doc/devel/uml/index_69.html @@ -23,8 +23,8 @@ EDL Example2object diagramMore complex example showing the Object graph in the EDL and how it is linked into the Fixture to yield the actual locations. In this example, an HUE Effect is applied on a part of the Clip edlsrelation EffectclassEffect or media processing component -effectartifactEffect or media processing component effectartifactEDL representation of a pluggable and automatable effect. +effectartifactEffect or media processing component Effectclass effective timeline (Fixture)node effectiveTimelinerelation diff --git a/doc/devel/uml/index_70.html b/doc/devel/uml/index_70.html index 777bf389c..93fe59aa1 100644 --- a/doc/devel/uml/index_70.html +++ b/doc/devel/uml/index_70.html @@ -40,6 +40,8 @@ Fixturecomponent Fixtureclass fork activity nodefork activity node +fork pseudo statefork pseudo state +fork pseudo statefork pseudo state FrameclassFrames are just a low level lump of continous memory, most parts are opaque. Frames are memory sensitive, they will be small constant sized structures which can be efficently managed in a pool. Framenode FrameclassTODO: how to relate to Cehteh's Frame entity in the Backend?
The latter is the fundamental Frame entity, wheras this Object rather represents a buffer set containing frame date diff --git a/doc/devel/uml/index_72.html b/doc/devel/uml/index_72.html index 90532e3e5..7356cb17f 100644 --- a/doc/devel/uml/index_72.html +++ b/doc/devel/uml/index_72.html @@ -24,8 +24,8 @@ Hierarchyclass diagramLumiera Exception hierarchy howtoProcoperation@return descriptor how to build a render pipeline corresponding to this media hubartifactspecial ProcNode used to build data distributing connections -HUEclass instance HUEclass instance +HUEclass instance diff --git a/doc/devel/uml/index_73.html b/doc/devel/uml/index_73.html index 8dc64d64b..1e264158e 100644 --- a/doc/devel/uml/index_73.html +++ b/doc/devel/uml/index_73.html @@ -19,12 +19,13 @@ NameKindDescription idattributeAsset primary key. IDattribute +IDentry point pseudo state ImplFacadeclass In Memory Databaseclass diagram inFixtureactivity action pin +inputclass instance inputclass instance inputclass instance -inputclass instance instanceoperation InstanceHandleclass instructionsrelation diff --git a/doc/devel/uml/index_76.html b/doc/devel/uml/index_76.html index 0689ba659..bdd59ab29 100644 --- a/doc/devel/uml/index_76.html +++ b/doc/devel/uml/index_76.html @@ -22,6 +22,7 @@ Layer Separation Interfaceclass diagram lengthattributeTODO: how to represent time intervals? lengthattributeduration (span) of this timeline segment. +Lifecyclestate machine Linkclass linkartifactforwarding, adapting or connecting ProcNode loadoperationreplace the current session by a new
session loaded from serialized state. diff --git a/doc/devel/uml/index_79.html b/doc/devel/uml/index_79.html index d7e2263c6..0f0da521d 100644 --- a/doc/devel/uml/index_79.html +++ b/doc/devel/uml/index_79.html @@ -20,9 +20,9 @@ offsetattributeOffset the actual position by this (time) value relative to the anchor point. TODO: Representation? OperationBaseclass orgattributeorigin or authorship id. Can be a project abbreviation, a package id or just the authors nickname or UID. This allows for the compnent name to be more generic (e.g. "blur"). Default for all assets provided by the core Lumiera codebase is "lumi". +ouputclass instance ouputclass instance ouputclass instance -ouputclass instance outPortrelationthe Port this MObject wants to be conected to Overviewcomponent diagramThis drawing shows the top level compoents and relations Overview Render Enginedeployment diagram diff --git a/doc/devel/uml/index_80.html b/doc/devel/uml/index_80.html index a9a67427a..fc2fcf572 100644 --- a/doc/devel/uml/index_80.html +++ b/doc/devel/uml/index_80.html @@ -18,11 +18,12 @@ + - + diff --git a/doc/devel/uml/index_83.html b/doc/devel/uml/index_83.html index ceab40c4a..fa8dc7579 100644 --- a/doc/devel/uml/index_83.html +++ b/doc/devel/uml/index_83.html @@ -20,6 +20,7 @@ + @@ -36,8 +37,8 @@ - + @@ -51,8 +52,8 @@ - + @@ -62,6 +63,15 @@ + + + + + + + + + diff --git a/doc/devel/uml/index_84.html b/doc/devel/uml/index_84.html index 58b8a6bf5..ea6b9d69e 100644 --- a/doc/devel/uml/index_84.html +++ b/doc/devel/uml/index_84.html @@ -17,8 +17,6 @@
NameKindDescription
paramrelation
ParamAccessorclass
parameterartifactrepresentation of an automatable effect/plugin parameter
ParameterclassDescriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated.
paramproviderartifactinterface denoting a source for actual Parameter values
ParamProviderclassA facility to get the actual value of a plugin/effect parameter
paramsrelation
paramsrelation
paramsrelation
PathManagerclassWhile building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)
pathmanagerartifactManager for deciding the actual render strategy
SAMETIMEattributeplace subject at the sime time as the anchor
saveoperationcreate a complete, serialized representation
of the current session config and contents.
@todo how to serialize, prameters, return value?
Schedulerclass
scratchstate
segmentartifactSegment of the Timeline.
Used at the moment (7/07) for partitioning the timeline/fixture into segments
to be rendered by a specialized render node network for each, without the need
to change any connections within a given segment.
Note this concept may be superfluos alltogether; is a draft and the real
use still needs to be worked out...
Segmentclass
segment Toolactivity object
ServiceImplclass
Sessioncomponent
sessionartifactInterface: the session edited by the user
sessionpackagesourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem
Sessionclass view
sessionpackagesourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem
SessionclassPrimary Interface for all editing tasks.
The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered.
Session structureclass diagram
sessionimplartifactholds the complete session data to be edited by the user
SimpleClipclassElementary clip consisting of only one media stream
SmartPointerclass
SmartPointersclass view
sourcerelationmedia source of this clip
sourcerelationthe media source this clip referes to
sourcerelationmedia source of this clip
SourceclassSource Node: represents a media source to pull data from.
sourceartifactRepresentation of a Media source
Source Overviewdeployment diagram
Statenode
Stateclass
staterelation
state actionstate action
state actionstate action
state actionstate action
state actionstate action
state actionstate actiontry to fetch existing definition
state actionstate action
state actionstate action
state actionstate action
state actionstate action
StateAdapterclass
StateAdapter compositionclass diagram
StateProxyclass
- - @@ -46,12 +44,12 @@ - + - - + + diff --git a/doc/devel/uml/index_85.html b/doc/devel/uml/index_85.html index ce1f36dc0..982764b59 100644 --- a/doc/devel/uml/index_85.html +++ b/doc/devel/uml/index_85.html @@ -18,6 +18,7 @@
NameKindDescription
Targetclass
targetsrelation
the render configuration flowactivity diagram
theApp_attributeholds the single instance and triggers initialization
theFixturerelation
trafoartifacttransforming processing Node
treatoperation
treatoperationThis operation is to be overloaded for the specific MObject subclasses to be treated.
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
treatoperation
TypeHandlerclass
TypeHandler<Pipe>class
+ diff --git a/doc/devel/uml/index_86.html b/doc/devel/uml/index_86.html index 1ab403ad8..85cc3a896 100644 --- a/doc/devel/uml/index_86.html +++ b/doc/devel/uml/index_86.html @@ -21,21 +21,21 @@ - - - - - - + + + + + + - - - + + + diff --git a/doc/devel/uml/navig.html b/doc/devel/uml/navig.html index fd08b1b7d..a9391da5f 100644 --- a/doc/devel/uml/navig.html +++ b/doc/devel/uml/navig.html @@ -9,7 +9,7 @@

-

-Top- -Classes- -Public Operations- -Public properties- -Packages- -Use Cases- -Activities- -Class Diagrams- -Object Diagrams- -Activity Diagrams- -Use Case Diagrams- -Collaboration Diagrams- -Component Diagrams- -Deployment Diagrams-

+

-Top- -Classes- -Public Operations- -Public properties- -Packages- -Use Cases- -Activities- -States- -Class Diagrams- -Object Diagrams- -Activity Diagrams- -State Diagrams- -Use Case Diagrams- -Collaboration Diagrams- -Component Diagrams- -Deployment Diagrams-

" < A B C D E F G H I K L M N O P Q R S T U V W Y ~

diff --git a/doc/devel/uml/statediagrams.html b/doc/devel/uml/statediagrams.html new file mode 100644 index 000000000..db5a38a93 --- /dev/null +++ b/doc/devel/uml/statediagrams.html @@ -0,0 +1,22 @@ + + + + + + +State Diagram Index + + + + + +
State Diagram Index
+

+ + + +
NameKindDescription
undoattribute
undo-ablestate
UndoMutationclass
undoOprelation
UndoSyncclass
VFrameclass
vframeartifacta buffer and render process holding a Video frame
vid1class instance
vid_Aclass instance
vid_aclass instance
vid_Aclass instance
vid_aclass instance
vid_Aclass instance
videoclass instance
videoclass instance
videoclass instance
vid_aclass instance
vid_aclass instance
vid_Aclass instance
videoclass instance
videoclass instance
videoclass instance
videoclass instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
video1class instance
Visitableclass
visitorpackagesub-namespace for visitor library implementation
visitorartifactAcyclic Visitor library
+ +
Command lifecycle
+ + diff --git a/doc/devel/uml/states.html b/doc/devel/uml/states.html new file mode 100644 index 000000000..bfb3aa192 --- /dev/null +++ b/doc/devel/uml/states.html @@ -0,0 +1,26 @@ + + + + + + +States Index + + + + + +
States Index
+

+ + + + + + + + + +
CmdDef
Command
Lifecyclemachine
scratch
undo-able
+ + diff --git a/uml/lumiera/128261 b/uml/lumiera/128261 index a6af8fb25..87b5544e9 100644 --- a/uml/lumiera/128261 +++ b/uml/lumiera/128261 @@ -1,6 +1,6 @@ format 58 "MObject" // ProcessingLayer::MObject - revision 36 + revision 37 modified_by 5 "hiv" // class settings //class diagram settings diff --git a/uml/lumiera/129029 b/uml/lumiera/129029 index ffbb809fb..aca9b3dd3 100644 --- a/uml/lumiera/129029 +++ b/uml/lumiera/129029 @@ -1,6 +1,6 @@ format 58 "Control" // ProcessingLayer::Control - revision 8 + revision 9 modified_by 5 "hiv" // class settings //class diagram settings @@ -452,25 +452,6 @@ ${inlines} idl_decl "" explicit_switch_type "" - classrelation 172549 // targets () - relation 162565 *--> - stereotype "list" - a role_name "targets" protected - cpp default " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; -" - classrelation_ref 172549 // targets () - b multiplicity "*" parent class_ref 149637 // Target - end - - classrelation 172677 // params () - relation 162693 *--> - stereotype "list" - a role_name "params" protected - cpp default " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; -" - classrelation_ref 172677 // params () - b multiplicity "*" parent class_ref 134533 // Parameter - end end class 149125 "DoSync" @@ -561,8 +542,11 @@ ${inlines} end end - class 149637 "Target" + class 149637 "ParamAccessor" visibility package + nformals 1 + formal name "TY" type "class" explicit_default_value "" + explicit_extends "" cpp_decl "${comment}${template}class ${name}${inherit} { ${members} }; @@ -590,5 +574,247 @@ ${inlines} explicit_switch_type "" end + + class 150789 "Closure" + visibility package + nformals 1 + formal name "SIG" type "class" explicit_default_value "" + explicit_extends "" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 174853 // + relation 164869 ---|> + a public + cpp default "${type}" + classrelation_ref 174853 // + b parent class_ref 148997 // CmdClosure + end + + classrelation 175109 // params () + relation 165125 *--> + stereotype "tuple" + a role_name "params" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + classrelation_ref 175109 // params () + b multiplicity "*" parent class_ref 149637 // ParamAccessor + end + end + + class 150917 "ArgumentHolder" + visibility package + nformals 1 + formal name "SIG" type "class" explicit_default_value "" + explicit_extends "" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 175237 // + relation 165253 ---|> + a public + cpp default "${type}" + classrelation_ref 175237 // + b parent class_ref 148997 // CmdClosure + end + + classrelation 175493 // arguments () + relation 165509 ---> + stereotype "manages" + a role_name "arguments" multiplicity "1" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type}* ${name}${value}; +" + classrelation_ref 175493 // arguments () + b multiplicity "1" parent class_ref 150789 // Closure + end + end + + state 128005 "Lifecycle" + stereotype "machine" + statediagram 135173 "Command lifecycle" + package_name_in_tab default show_context default auto_label_position default write_trans_label_horizontally default show_trans_definition yes draw_all_relations default shadow default + show_activities default region_horizontally default drawing_language default show_stereotype_properties default + size A4 + end + + pseudostate 128005 entry_point "ID" + transition 128901 "" + on stateaction_ref 128005 + external + end + end + + stateaction 128005 + uml "fetch def" + comment "try to fetch existing definition" + transition 128773 "" + on pseudostate_ref 128133 // choice + external + end + end + + state 128133 "scratch" + transition 128261 "" + on stateaction_ref 128133 + external + end + end + + stateaction 128133 + uml "def DO" + transition 128389 "" + on pseudostate_ref 128261 // fork + external + end + + transition 129029 "" + on stateaction_ref 128261 + external + end + + transition 129157 "" + on stateaction_ref 128517 + external + end + end + + stateaction 128261 + uml "def CAP" + transition 129285 "" + on stateaction_ref 128389 + external + end + end + + stateaction 128389 + uml "def UNDO" + transition 129541 "" + on state_ref 128261 // CmdDef + external + end + end + + stateaction 128517 + uml "def UNDO" + transition 129413 "" + on stateaction_ref 128645 + external + end + end + + stateaction 128645 + uml "def CAP" + transition 129669 "" + on state_ref 128261 // CmdDef + external + end + end + + state 128261 "CmdDef" + transition 129797 "" + on stateaction_ref 128773 + external + end + end + + stateaction 128773 + uml "bind" + transition 129925 "" + on state_ref 128389 // Command + external + end + end + + state 128389 "Command" + transition 130053 "" + on stateaction_ref 129029 + external + end + end + + stateaction 129029 + stereotype "send-signal" + uml "exec pattern" + transition 130181 "" + on state_ref 128517 // undo-able + external + end + end + + state 128517 "undo-able" + transition 130309 "" + on pseudostate_ref 128517 // exit_point + external + end + + transition 130437 "" + on stateaction_ref 129157 + external + end + + transition 130693 "" + on stateaction_ref 129029 + external + end + end + + pseudostate 128133 choice + stereotype "try" + transition 128005 "" + on state_ref 128133 // scratch + uml_expr "not found" + external + end + + transition 128133 "" + on state_ref 128261 // CmdDef + uml_expr "found" + external + end + end + + pseudostate 128261 fork + transition 128517 "" + on stateaction_ref 128261 + external + end + + transition 128645 "" + on stateaction_ref 128517 + external + end + end + + pseudostate 128389 fork + end + + pseudostate 128517 exit_point "done" + end + + stateaction 129157 + stereotype "send-signal" + uml "undo" + transition 130565 "" + on state_ref 128517 // undo-able + external + end + end + end end end diff --git a/uml/lumiera/134021.diagram b/uml/lumiera/134021.diagram index 47e68f995..fdf19d33b 100644 --- a/uml/lumiera/134021.diagram +++ b/uml/lumiera/134021.diagram @@ -7,7 +7,7 @@ classcanvas 128005 class_ref 148485 // Command end classcanvas 128133 class_ref 148613 // HandlingPattern draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default - xyz 424 293 2000 + xyz 421 307 2000 end classcanvas 128261 class_ref 148741 // Mutation draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default @@ -19,7 +19,7 @@ classcanvas 128389 class_ref 148869 // UndoMutation end classcanvas 128517 class_ref 148997 // CmdClosure draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default - xyz 25 178 2000 + xyz 14 178 2000 end classcanvas 128773 class_ref 149125 // DoSync draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default @@ -37,18 +37,22 @@ classcanvas 129157 class_ref 149509 // RedoLast draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default xyz 488 507 2000 end -classcanvas 130565 class_ref 134533 // Parameter +classcanvas 130693 class_ref 149637 // ParamAccessor draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default - xyz 112 298 2005 -end -classcanvas 130693 class_ref 149637 // Target - draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default - xyz 112 249 2010 + xyz 64 329 2010 end classcanvas 133765 class_ref 141957 // ProcDispatcher draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default color lightred - xyz 279 401 2000 + xyz 281 411 2000 +end +classcanvas 134021 class_ref 150789 // Closure + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 26 374 2015 +end +classcanvas 134789 class_ref 150917 // ArgumentHolder + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 64 260 2000 end relationcanvas 128645 relation_ref 161925 // from ref 128389 z 1999 to ref 128261 @@ -57,58 +61,44 @@ relationcanvas 128645 relation_ref 161925 // end relationcanvas 129285 relation_ref 162053 // geometry VHr - from ref 128773 z 1999 to point 467 388 + from ref 128773 z 1999 to point 464 388 line 130309 z 1999 to ref 128133 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 129669 relation_ref 162181 // geometry VHr - from ref 128901 z 1999 to point 467 433 + from ref 128901 z 1999 to point 464 433 line 129797 z 1999 to ref 128133 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 129925 relation_ref 162309 // geometry VHr - from ref 129029 z 1999 to point 467 479 + from ref 129029 z 1999 to point 464 479 line 130053 z 1999 to ref 128133 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 130181 relation_ref 162437 // geometry VHr - from ref 129157 z 1999 to point 467 524 + from ref 129157 z 1999 to point 464 524 line 130437 z 1999 to ref 128133 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end -relationcanvas 130821 relation_ref 162565 // - geometry VH - from ref 128517 z 1999 stereotype "<>" xyz 67 239 3000 to point 59 266 - line 130949 z 1999 to ref 130693 - role_a_pos 69 251 3000 no_role_b - no_multiplicity_a multiplicity_b_pos 47 222 3000 -end -relationcanvas 131077 relation_ref 162693 // - geometry VH - from ref 128517 z 1999 stereotype "<>" xyz 66 300 3000 to point 59 327 - line 131205 z 1999 to ref 130565 - role_a_pos 67 312 3000 no_role_b - no_multiplicity_a multiplicity_b_pos 47 222 3000 -end relationcanvas 131333 relation_ref 162821 // decenter_begin 780 - from ref 128005 z 1999 stereotype "<>" xyz 110 184 3000 to ref 128517 + from ref 128005 z 1999 stereotype "<>" xyz 104 184 3000 to ref 128517 no_role_a no_role_b - multiplicity_a_pos 107 202 3000 multiplicity_b_pos 160 202 3000 + multiplicity_a_pos 96 202 3000 multiplicity_b_pos 160 202 3000 end relationcanvas 131461 relation_ref 162949 // decenter_begin 543 from ref 128389 z 1999 to point 453 201 line 132229 z 1999 to point 453 128 line 131717 z 1999 to ref 128261 - role_a_pos 410 174 3000 no_role_b + role_a_pos 411 174 3000 no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 131845 relation_ref 163077 // @@ -116,7 +106,7 @@ relationcanvas 131845 relation_ref 163077 // from ref 128389 z 1999 to point 453 186 line 131973 z 1999 to point 453 128 line 132101 z 1999 to ref 128261 - role_a_pos 409 203 3000 no_role_b + role_a_pos 410 207 3000 no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 132613 relation_ref 163205 // @@ -132,15 +122,44 @@ relationcanvas 132869 relation_ref 163333 // no_multiplicity_a no_multiplicity_b end relationcanvas 133509 relation_ref 163589 // - from ref 128005 z 1993 stereotype "<>" xyz 263 248 3000 to point 245 214 + from ref 128005 z 1993 stereotype "<>" xyz 265 250 3000 to point 245 214 line 133637 z 1993 to ref 128133 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 133893 relation_ref 163717 // - from ref 128133 z 1999 stereotype "<>" xyz 314 370 3000 to ref 133765 + from ref 128133 z 1999 stereotype "<>" xyz 314 382 3000 to ref 133765 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end +relationcanvas 134149 relation_ref 164869 // + from ref 134021 z 1999 to ref 128517 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 134405 relation_ref 165125 // + geometry HV + from ref 134021 z 2009 stereotype "<>" xyz 98 400 3000 to point 107 398 + line 134661 z 2009 to ref 130693 + role_a_pos 114 390 3000 no_role_b + no_multiplicity_a multiplicity_b_pos 86 406 3000 +end +relationcanvas 134917 relation_ref 165253 // + geometry VHV unfixed + from ref 134789 z 1999 to point 107 240 + line 135045 z 1999 to point 48 240 + line 135173 z 1999 to ref 128517 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 135685 relation_ref 165509 // + decenter_begin 490 + from ref 134789 z 1999 stereotype "<>" xyz 103 418 3000 to point 174 298 + line 135941 z 1999 to point 174 429 + line 136069 z 1999 to point 92 429 + line 135813 z 1999 to ref 134021 + role_a_pos 110 430 3000 no_role_b + multiplicity_a_pos 86 431 3000 multiplicity_b_pos 164 297 3000 +end preferred_whz 575 622 1 end diff --git a/uml/lumiera/135173.diagram b/uml/lumiera/135173.diagram new file mode 100644 index 000000000..e02ebcc50 --- /dev/null +++ b/uml/lumiera/135173.diagram @@ -0,0 +1,161 @@ +format 58 + +pseudostatecanvas 128005 pseudostate_ref 128005 // entry_point + xyz 180 12 3005 label_xy 184 31 +end +stateactioncanvas 128133 stateaction_ref 128005 + xyzwh 225 41 2000 53 26 +end +statecanvas 128261 state_ref 128133 // scratch + show_activities default region_horizontally default drawing_language default show_stereotype_properties default + xyzwh 74 82 2000 57 33 +end +stateactioncanvas 128389 stateaction_ref 128133 + xyzwh 80 133 2000 44 26 +end +stateactioncanvas 128517 stateaction_ref 128261 + xyzwh 53 175 2000 50 26 +end +stateactioncanvas 128645 stateaction_ref 128389 + xyzwh 49 213 2000 58 26 +end +stateactioncanvas 128773 stateaction_ref 128517 + xyzwh 110 175 2000 58 26 +end +stateactioncanvas 128901 stateaction_ref 128645 + xyzwh 114 213 2000 50 26 +end +statecanvas 129029 state_ref 128261 // CmdDef + show_activities default region_horizontally default drawing_language default show_stereotype_properties default + xyzwh 73 276 2000 59 33 +end +stateactioncanvas 129157 stateaction_ref 128773 + xyzwh 112 337 2000 32 26 +end +statecanvas 129413 state_ref 128389 // Command + show_activities default region_horizontally default drawing_language default show_stereotype_properties default + xyzwh 127 388 2000 69 33 +end +stateactioncanvas 129541 stateaction_ref 129029 + xyzwh 160 445 2000 84 30 +end +statecanvas 129669 state_ref 128517 // undo-able + show_activities default region_horizontally default drawing_language default show_stereotype_properties default + xyzwh 162 501 2000 81 36 +end +pseudostatecanvas 129797 pseudostate_ref 128133 // choice + xyz 238 81 2000 +end +pseudostatecanvas 132997 pseudostate_ref 128517 // exit_point + xyz 288 510 3005 label_xy 286 529 +end +stateactioncanvas 133125 stateaction_ref 129157 + xyzwh 161 565 2000 85 30 +end +transitioncanvas 129925 transition_ref 128005 // + + from ref 129797 z 1999 label "/ not found" xyz 155 100 1999 to ref 128261 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 130053 transition_ref 128133 // + geometry HVr + + from ref 129797 z 1999 label "/ found" xyz 215 129 1999 to point 248 290 + line 130309 z 1999 to ref 129029 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 130437 transition_ref 128261 // + + from ref 128261 z 1999 to ref 128389 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 131205 transition_ref 128773 // + + from ref 128133 z 1999 to ref 129797 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 131589 transition_ref 128901 // + geometry HV + + from ref 128005 z 1999 to point 249 19 + line 134661 z 1999 to ref 128133 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 131717 transition_ref 129029 // + + from ref 128389 z 1999 to ref 128517 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 131845 transition_ref 129157 // + + from ref 128389 z 1999 to ref 128773 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 131973 transition_ref 129285 // + + from ref 128517 z 1999 to ref 128645 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132101 transition_ref 129413 // + + from ref 128773 z 1999 to ref 128901 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132229 transition_ref 129541 // + + from ref 128645 z 1999 to ref 129029 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132357 transition_ref 129669 // + + from ref 128901 z 1999 to ref 129029 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132485 transition_ref 129797 // + + from ref 129029 z 1999 to ref 129157 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132613 transition_ref 129925 // + + from ref 129157 z 1999 to ref 129413 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132741 transition_ref 130053 // + + from ref 129413 z 1999 to ref 129541 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 132869 transition_ref 130181 // + + from ref 129541 z 1999 to ref 129669 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 133253 transition_ref 130309 // + + from ref 129669 z 1999 to ref 132997 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 133381 transition_ref 130437 // + + from ref 129669 z 1999 to ref 133125 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 133509 transition_ref 130565 // + decenter_end 702 + + from ref 133125 z 1999 to point 138 576 + line 133765 z 1999 to point 138 540 + line 133637 z 1999 to ref 129669 + write_horizontally default show_definition default drawing_language default +end +transitioncanvas 133893 transition_ref 130693 // + decenter_begin 324 + + from ref 129669 z 1999 to point 137 496 + line 134149 z 1999 to point 137 456 + line 134533 z 1999 to ref 129541 + write_horizontally default show_definition default drawing_language default +end +preferred_whz 349 682 1 +end diff --git a/uml/lumiera/5.session b/uml/lumiera/5.session index 05da50f1a..9d1a80e06 100644 --- a/uml/lumiera/5.session +++ b/uml/lumiera/5.session @@ -1,16 +1,23 @@ window_sizes 1302 1004 270 1022 856 71 +diagrams + active classdiagram_ref 134021 // Command structure + 575 622 100 4 0 0 + statediagram_ref 135173 // Command lifecycle + 349 682 100 4 0 0 +end show_stereotypes selected package_ref 129 // lumiera open - componentview_ref 128005 // Architecture classview_ref 129413 // Project Entities package_ref 128645 // codegen package_ref 128133 // Asset - - package_ref 129029 // Control + classview_ref 128389 // Controller Workings + class_ref 148997 // CmdClosure + class_ref 150789 // Closure + pseudostate_ref 128133 // choice package_ref 128261 // MObject classview_ref 128133 // Engine Workings diff --git a/uml/lumiera/lumiera.prj b/uml/lumiera/lumiera.prj index c978054a5..66d76596f 100644 --- a/uml/lumiera/lumiera.prj +++ b/uml/lumiera/lumiera.prj @@ -1,6 +1,6 @@ format 58 "lumiera" - revision 52 + revision 53 modified_by 5 "hiv" cpp_root_dir "../../src/" diff --git a/wiki/renderengine.html b/wiki/renderengine.html index 426e40087..4645ae74b 100644 --- a/wiki/renderengine.html +++ b/wiki/renderengine.html @@ -951,7 +951,7 @@ TertiaryMid: #99a TertiaryDark: #667 Error: #f88 -
+
Within Proc-Layer, a Command is the abstract representation of a single operation or a compound of operations mutating the HighLevelModel.
 Thus, each command is a ''Functor'' and a ''Closure'' ([[command pattern|http://en.wikipedia.org/wiki/Command_pattern]]), allowing commands to be treated uniformly, enqueued in a [[dispatcher|ProcDispatcher]], logged to the SessionStorage and registered with the UndoManager.
 
@@ -959,6 +959,7 @@ Commands are //defined// using a [[fluent API|http://en.wikipedia.org/wiki/Fluen
 
 &rarr; see CommandDefinition
 &rarr; see CommandHandling
+&rarr; see CommandLifecycle
@@ -989,7 +990,7 @@ While generally there is //no limitation// on the number and type of parameters, Usually, parameters should be passed //by value// &mdash; with the exception of target object(s), which are typically bound as MObjectRef, causing them to be resolved at commad execution time (late binding).
-
+
Organising any ''mutating'' operations executable by the user (via GUI) by means of the [[command pattern|http://en.wikipedia.org/wiki/Command_pattern]] can be considered //state of the art//&nbsp; today. First of all, it allows to discern the specific implementation operations to be called on one or several objects within the HighLevelModel from the operation requested by the user, the latter being rather a concept. A command can be labeled clearly, executed under controlled circumstances, allowing transactional behaviour.
 
 
@@ -1005,9 +1006,22 @@ While obviously the first solution is much simpler to implement on behalf of the
 While the usual »Memento« implementation might automatically capture the whole model (resulting in a lot of data to be stored and some uncertainty about the scope of the model to be captured), in Lumiera we rely instead on the client code to provide a ''capture function''&nbsp;and a ''playback function'' alongside with the actual operation. To help with this task, we provide a set of standard handlers for common situations. This way, operations might capture very specific information, might provide an "intelligent undo" to restore a given semantic instead of just a fixed value &mdash; and moreover the client code is free actually to employ the "inverse operation" model in special cases where it just makes more sense than capturing state.
 
 !Handling of commands
-A command may be [[defined|CommandDefinition]] completely from scratch, or it might just instantiate a CommandPrototype with specific targets and parameters. The command could then be serialised and later be recovered and re-bound with the parameters, but usually it will be handed over to the ProcDispatcher, pending execution. When ''invoking'', the handling sequence is to [[log the command|SessionStorage]], then call the ''undo capture function'', followed from calling the actual ''operation function''. After success, the logging and [[undo registration|UndoManager]] is completed. In any case, finally the ''result signal'' (a functor previously stored within the command) is emitted.
+A command may be [[defined|CommandDefinition]] completely from scratch, or it might just serve as a CommandPrototype with specific targets and parameters. The command could then be serialised and later be recovered and re-bound with the parameters, but usually it will be handed over to the ProcDispatcher, pending execution. When ''invoking'', the handling sequence is to [[log the command|SessionStorage]], then call the ''undo capture function'', followed from calling the actual ''operation function''. After success, the logging and [[undo registration|UndoManager]] is completed. In any case, finally the ''result signal'' (a functor previously stored within the command) is emitted.
 
-By design, commands are single-serving value objects; executing an operation repeatedly requires creating a collection of command objects, one for each invocation.
+By design, commands are single-serving value objects; executing an operation repeatedly requires creating a collection of command objects, one for each invocation. While nothing prevents you from invoking the command operation functor several times, each invocation will overwrite the undo state captrued by the previous invocation. Thus, each command instance should bes seen as the promise (or later the trace) of a single operation execution. In a similar vein, the undo capturing should be defined as to be self sufficient, so that invoking just the undo functor of a single command performes any necessary steps to restore the situation found before invoking the corresponding mutation functor &mdash; of course only //with respect to the topic covered by this command.// So, while commands provide a lot of flexibility and allow to do a multitude of things, certainly there is an intended CommandLifecycle.
+
+
+
+
[<img[Structure of Commands|uml/fig135173.png]]
+While generally the command framework was designed to be flexible and allow a lot of different use cases, execution paths and to serve various goals, there is an ''intended lifecycle'' &mdash; commands are expected to go through several distinct states.
+
+The handling of a command starts out with a ''command ID'' provided by the client code. Command IDs are unique (human readable) identifiers and should be organised in a hierarchical fashion. When provided with an ID, the CommandRegistry tries to fetch an existing command definition. In case this fails, we enter the [[command definition stage|CommandDefinition]], which includes specifying functions to implement the operation, state capturing and UNDO. When all these informations are available, the entity is called a ''command definition''. It is comparable to a //class// or //meta object.//
+
+By ''binding'' to specific operation arguments, the definition is //armed// and becomes a real ''command''. This is similar to creating an instance from a class
+
+A command is operated or executed by passing it to an ''execution pattern'' &mdash; there is a multitude of possible execution patterns to choose from, depending on the situation. 
+{{red{WIP}}}
+When a command has been executed (and maybe undone), it's best to leave it alone, because the UndoManager might hold a reference. At any time, c ''clone of the command'' could be created, maybe bound with different arguments and treated separately from the original command.