Using the Guide

Using the Guide
Prev	Chapter 1. Users Guide	Next

This section describes the general structure of this guide and provides suggestions for its usage in different situations.

Guide Organization

The guide is assembled with the more frequently accessed chapters toward the front. These chapters are in roughly chronological order according to how they will be used. General Shlaer-Mellor development background is provided toward the end.

Here is a short description of each chapter and appendix.

Chapter 1, Users Guide	This chapter describes the purpose and use of this guide, lists other related documents, and presents the conventions used within.
Chapter 2, Features and Components	This chapter provides a concise overview of many of the capabilities built into MC-3020. The basic gist of translation strategy for model components is given in an outline format.
Chapter 3, Eclipse Integration	The MC-3020 build process has been integrated with Eclipse. The use of MC-3020 in this environment is described in this section.
Chapter 4, Marking	MC-3020 provides a rich set of ``knobs and dials'' that can be spun to optimize and customize the code generation process. This chapter gives instructions on the use of these marking parameters.
Chapter 5, Enumerated Types	BridgePoint Builder allows users to define types derived from its set of core data types. Support for the BridgePoint Builder interface for defining enumerated types is fully supported.
Chapter 6, Interface Call-outs	Interface call-outs allow the user to capture execution control of the generated system running on a target.
Chapter 8, Initialization and Preexisting Instances	This chapter explains how to initialize and start the system. Initialization must deal with bringing up the architecture system code as well as initialization for preexisting instances.
Chapter 9, MC-3020 Collections	Lists are used by MC-3020 to keep track of collections of instances in the system. Collections of instances appear in several contexts including pools of instances of classes, sets of instances participating in an association and sets of instances resulting from SELECT MANY statements.
Chapter 10, Persistence	This chapter describes persistence services for MC-3020. The persistence support in MC-3020 allows instances of classes marked as persistent to survive across power cycles.
Chapter 11, Tasking/Threading	MC-3020 supports running the xtUML application within multiple tasks or threads. The tasking uses the underlying OS/RTOS when one exists. MC-3020 can still run without an OS/RTOS, but if preemptive multi-tasking is desired in the application, it is available. The tasking/threading capabilities for MC-3020 are outlined here.

Additional Information

Appendices have been provided.

Appendix A, Analysis Guide	MC-3020 levies certain restrictions upon the analyst. These restrictions and advice for capitalizing upon MC-3020 features are provided.
Appendix B, Background	This appendix begins by providing a general overview of model compilers (sometimes referred to as the software architecture) followed by a brief description of the major components of MC-3020. Next, a more detailed look is taken at the two types of tasks found in the MC-3020 architecture and how they interact. Finally, the general operational nature of each task type is described. The intent is to provide the reader with a complete, high level view of the MC-3020 architecture, sufficient to provide a context for the rest of this manual.
Appendix C, PEI Test Case Setup	The PEI test case setup domain function is listed here in it entirety.
Appendix E, Legal Notice	MC-3020 is commercial software and its use is restricted and limited by license.