This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
sysml-autoview:usecases [2013-03-12 12:34] araher |
sysml-autoview:usecases [2013-03-12 15:12] (current) araher |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ---- | ||
| + | \\ | ||
| + | |||
| + | [[auto-view_generation_working_group|Auto-View Generation Working Group home page]] - [[requirements|Requirements]] - [[se_material|Notes on Architecture, etc]] | ||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
| ====== Use Cases and Scenarios ====== | ====== Use Cases and Scenarios ====== | ||
| - | ====Categories of Use Cases==== | + | The five categories of use cases we have identified are defined in the table below. In the rest of the page, each category is documented in detail in its own table. |
| - | ^Category^Definition^ | + | ^Category^Use case pertains to^ |
| - | |Method| The usecases pertaining to how a Viewpoint uses a model to create a View.| | + | |Analysis| How Viewpoint(s) and View(s) can be interrogated for completeness and correctness| |
| - | |Analysis| The usecases pertaining to how Viewpoint(s) and View(s) can be interrogated for completeness and correctness| | + | |Method| How a Viewpoint uses a model to create a View| |
| - | |Presentation| The usecases pertaining to the rules a Viewpoint has in order to transform the given model(s) into a presentation artifact and the features that presentation artifact (e.g., composite views) should have. | | + | |Organization| Libraries| |
| - | |Viewpoint Instance | The usecases pertaining to inheritance among Viewpoints and using Viewpoints in a composite structure| | + | |Presentation| The rules a Viewpoint has in order to transform the given model(s) into a presentation artifact and the features that presentation artifact (e.g., composite views) should have| |
| - | |Organization| The usescases pertaining to libraries.| | + | |Viewpoint Instance | Inheritance among Viewpoints and using Viewpoints in a composite structure| |
| - | ====Analysis Use Cases==== | + | |
| + | ======Analysis Use Cases====== | ||
| ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ | ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ | ||
| Line 19: | Line 28: | ||
| |21|I have a broken view|I want to debug an error in the view model|TBD|TBD| | |21|I have a broken view|I want to debug an error in the view model|TBD|TBD| | ||
| - | + | ======Method Use Cases====== | |
| - | + | ||
| - | ====Method Use Cases==== | + | |
| ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ | ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ | ||
| Line 40: | Line 47: | ||
| |33|I have several Viewpoints|I want Viewpoint A to be composed of Viewpoint B such that when I instance Viewpoint A, Viewpoint B is instanced as well.|TBD|TBD| | |33|I have several Viewpoints|I want Viewpoint A to be composed of Viewpoint B such that when I instance Viewpoint A, Viewpoint B is instanced as well.|TBD|TBD| | ||
| - | ====Organization Use Cases==== | + | ======Organization Use Cases====== |
| - | ^ID^Category^Usecase family^Usecase qualifier^Scenarios^Notes^ | + | ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ |
| - | |32|Organization|I have viewpoints, methods, and analyses.|I want to organize these into reusable libraries.|TBD|TBD| | + | |32|I have viewpoints, methods, and analyses.|I want to organize these into reusable libraries.|TBD|TBD| |
| - | ====Presentation Use Cases==== | ||
| - | ^ID^Category^Usecase family^Usecase qualifier^Scenarios^Notes^ | + | ======Presentation Use Cases====== |
| - | |13|Presentation|I have a view tree that conforms to a viewpoint tree where order is asserted|I want to generate documents based on the view tree.|TBD|TBD| | + | |
| - | |14|Presentation|I have a view tree that conforms to a viewpoint tree where order is asserted |I want to generate web pages. Each view can be on its own page, or all views could be on a single page with styles delineating the different views.|TBD|TBD| | + | |
| - | |15|Presentation|I have a view tree that conforms to a viewpoint tree where order is asserted.|I want to generate slides. Each view should be on its own slide.|TBD|TBD| | + | |
| - | |16|Presentation|I have a viewpoint whose definition is one or more mathematical equations. |Given a model that provides the correct value properties I want to generate a view that is a plot of the equation defined in the viewpoint.|Specify which VPs are bound to which variables of the equation|TBD| | + | |
| - | |18|Presentation|I have a viewpoint whose definition is one or more mathematical equations. | Given a model that provides the correct value properties I want to generate a view that is the mathematical equation(s) of the viewpoint with corresponding model values filled in.|TBD|TBD| | + | |
| - | |19|Presentation|I have one viewpoint that renders an image and another that renders a table.| I want to create a new viewpoint the combines the previous two such that the generated view is an image followed a table.|Define a combine operator for VPs.|TBD| | + | |
| - | |17|Presentation|I have a viewpoint. |I want to generate views that are tables.|TBD|TBD| | + | |
| - | |20|Presentation|I have a viewpoint that renders product specs.|I want the view to import a Maple (not SysML) file of product specs and render them as a table.|TBD|TBD| | + | |
| - | |28|Presentation|I have a view (or set of views). |I want to query the view (or set of views) to filter and retain a specified subset of the elements used in the view (e.g., all «block»s).| TBD| TBD| | + | |
| - | |29|Presentation|I have a view (or set of views). |I want to query the view (or set of views) in a basic search manner.| provide a free-text search within Views|TBD| | + | |
| - | |31|Presentation|I have a SysML model.|I want to transform my SysML model into a movie, html animation, narrative that unfolds e.g. in time, 3D with audio|TBD|TBD| | + | |
| - | |34|Presentation|I have an ordered collection of composed views.|I want to view and edit the collection of views. This includes editing properties of the model or adding narrative to the view tree. All changes made online should be ingested back into the model.|TBD|TBD| | + | |
| - | ====Viewpoint Instance Use Cases==== | + | ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ |
| + | |13|I have a view tree that conforms to a viewpoint tree where order is asserted|I want to generate documents based on the view tree.|TBD|TBD| | ||
| + | |14|I have a view tree that conforms to a viewpoint tree where order is asserted |I want to generate web pages. Each view can be on its own page, or all views could be on a single page with styles delineating the different views.|TBD|TBD| | ||
| + | |15|I have a view tree that conforms to a viewpoint tree where order is asserted.|I want to generate slides. Each view should be on its own slide.|TBD|TBD| | ||
| + | |16|I have a viewpoint whose definition is one or more mathematical equations. |Given a model that provides the correct value properties I want to generate a view that is a plot of the equation defined in the viewpoint.|Specify which VPs are bound to which variables of the equation|TBD| | ||
| + | |18|I have a viewpoint whose definition is one or more mathematical equations. | Given a model that provides the correct value properties I want to generate a view that is the mathematical equation(s) of the viewpoint with corresponding model values filled in.|TBD|TBD| | ||
| + | |19|I have one viewpoint that renders an image and another that renders a table.| I want to create a new viewpoint the combines the previous two such that the generated view is an image followed a table.|Define a combine operator for VPs.|TBD| | ||
| + | |17|I have a viewpoint. |I want to generate views that are tables.|TBD|TBD| | ||
| + | |20|I have a viewpoint that renders product specs.|I want the view to import a Maple (not SysML) file of product specs and render them as a table.|TBD|TBD| | ||
| + | |28|I have a view (or set of views). |I want to query the view (or set of views) to filter and retain a specified subset of the elements used in the view (e.g., all «block»s).| TBD| TBD| | ||
| + | |29|I have a view (or set of views). |I want to query the view (or set of views) in a basic search manner.| provide a free-text search within Views|TBD| | ||
| + | |31|I have a SysML model.|I want to transform my SysML model into a movie, html animation, narrative that unfolds e.g. in time, 3D with audio|TBD|TBD| | ||
| + | |34|I have an ordered collection of composed views.|I want to view and edit the collection of views. This includes editing properties of the model or adding narrative to the view tree. All changes made online should be ingested back into the model.|TBD|TBD| | ||
| - | ^ID^Category^Usecase family^Usecase qualifier^Scenarios^Notes^ | + | ======Viewpoint Instance Use Cases====== |
| - | |1|Viewpoint Instance| I have a viewpoint that renders a table whose first column is the name of the blocks within scope and the second column is the documentation of each block. |I want to conform two views (which may be in separate documents) to this viewpoint. The only difference between the views is that for one view I want the header of the table columns to be “Block, Definition” and the other view I want the header of the table columns to be “Service, Description.”|Viewpoint describes certain parameters like recursion depth or header names or font colors. need to be able to set them in the view when they are view specific. this is BST for Viewpoints and Views.|TBD| | + | |
| - | |2|Viewpoint Instance|I have a viewpoint that renders a table whose first column is the name of all Operation elements within scope and the second column is their corresponding parameters. |I want to specialize this viewpoint such that the table renders only Operation elements that additionally have a stereotype applied from another profile e.g., «function». The only thing I want to specify about the new viewpoint is the additional stereotype filter.|How do we specialize methods and rules etc. example Definition table with additional languages. everything else should inherit directly.|TBD| | + | ^ID^Usecase family^Usecase qualifier^Scenarios^Notes^ |
| - | |4|Viewpoint Instance|I have a set of viewpoints. |I want to render the viewpoints in a particular read order, including section (e.g., a viewpoint composed into another viewpoint) I want to be able to assert the composition and order at the viewpoint level such that when “first” viewpoint is instanced the subsequent compositioned views are also created with their read order intact.| define a template for a view tree such that the views and the read order are the same for multiple view trees.|TBD| | + | |1| I have a viewpoint that renders a table whose first column is the name of the blocks within scope and the second column is the documentation of each block. |I want to conform two views (which may be in separate documents) to this viewpoint. The only difference between the views is that for one view I want the header of the table columns to be “Block, Definition” and the other view I want the header of the table columns to be “Service, Description.”|Viewpoint describes certain parameters like recursion depth or header names or font colors. need to be able to set them in the view when they are view specific. this is BST for Viewpoints and Views.|TBD| |
| - | |6|Viewpoint Instance|I have a view. |I want to include the same view in two different documents.|Allow x-references to existing views|TBD| | + | |2|I have a viewpoint that renders a table whose first column is the name of all Operation elements within scope and the second column is their corresponding parameters. |I want to specialize this viewpoint such that the table renders only Operation elements that additionally have a stereotype applied from another profile e.g., «function». The only thing I want to specify about the new viewpoint is the additional stereotype filter.|How do we specialize methods and rules etc. example Definition table with additional languages. everything else should inherit directly.|TBD| |
| - | |9|Viewpoint Instance|I have a set of views|I want to model how those views are presented in a document, i.e. a document outline|TBD|TBD| | + | |4|I have a set of viewpoints. |I want to render the viewpoints in a particular read order, including section (e.g., a viewpoint composed into another viewpoint) I want to be able to assert the composition and order at the viewpoint level such that when “first” viewpoint is instanced the subsequent compositioned views are also created with their read order intact.| define a template for a view tree such that the views and the read order are the same for multiple view trees.|TBD| |
| + | |6|I have a view. |I want to include the same view in two different documents.|Allow x-references to existing views|TBD| | ||
| + | |9|I have a set of views|I want to model how those views are presented in a document, i.e. a document outline|TBD|TBD| | ||