MDG Technology for DDS User Guide
Contents
1. 7 DDS MDG Technology m Y MDG Technology for DDS User Guide Welcome to the MDG Technology for DDS User Guide The MDG Technology for DDS enables you to work simultaneously with both Enterprise Architect and DDS and merge the changes with minimal effort Si SYSTEMS Copyright 2007 2008 Sparx Systems Pty Ltd MDG Technology for DDS User Guide Introduction by Simon Zhang MDG Technology for DDS provides a lightweight bridge between Enterprise Architect and DDS MDG Technology for DDS User Guide O 2007 2008 Sparx Systems Pty Ltd All rights reserved No parts of this work may be reproduced in any form or by any means graphic electronic or mechanical including photocopying recording taping or information storage and retrieval systems without the written permission of the publisher Products that are referred to in this document may be either trademarks and or registered trademarks of the respective owners The publisher and the author make no claim to these trademarks While every precaution has been taken in the preparation of this document the publisher and the author assume no responsibility for errors or omissions or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged t2. UWS Technology for DUS Options RTIDDS Options Project Root RTI src Test Enable RTIDDS PSM Y NDDSHOME CARTINDDSindds 4 0g Autoname Source Files Autogenerate IDL Autogenerate Source Run NDDSGen on completion Generate Listener for DDS Reader Generate Listener for DDS Writer 1 Project Files Choice Generate Workspace and Project Files Workspace Name DDSWorkSpace1 DDS General Qos Property Behavior _ Show Toolbox Always V Show as Entity Compartments O rll ies Create Automatically for new Entities _ Ignore validation warnings Set Specifications RTIDDS Options Panel The options in the RTIDDS Options panel are used to specify the behavior of the PIM to PSM transformation 297 for RTIDDS implementations Note The version of RTIDDS used is specified by the NDDSHOME environment variable Field Description S Project Root Root directory in which all the PSM output should be created Enable RTIDDS PSM Select the checkbox to enable the transformer deselect to disable the transformer Autoname Source Files Select the checkbox to enable the RTIDDS transformer to automatically allocate filenames to the generated source code recommended Autogenerate Source Select the checkbox to enable the RTIDDS transformer to automatically invoke the code generation process to the PSM after it has been successfully generated Generate Listener for DDS Select the checkbox to enabl
3. Options About Load DDS e Loads the MDG Technology for DDS into the Resources window Technology e Displays the MDG Technology for DDS in the Toolbox Unload DDS e Removes the MDG Technology for DDS from the Toolbox Technology e Unloads the MDG Technology for DDS from the Resources browser New Application Creates a new DDS Application diagram in the currently selected package The Diagram diagram is an extended UML Deployment diagram New Domain Creates a new DDS Domain diagram in the currently selected package The diagram Diagram is an extended UML Component diagram New Qos Policy Creates a new DDS Qos policy library package in the model Library New Topic Diagram Creates a new DDS Topic diagram in the currently selected package The diagram is an extended UML Class diagram New Type Diagram Creates a new DDS Type diagram in the currently selected package The diagram is an extended UML Class diagram Open DDS Example Opens the example DDS model Model Options Opens the Options Dialog 13 gt Heip Opens this help file About Displays the version information for the MDG Technology for DDS Tip If the Add Ins menu or the DDS Technology sub menu are not visible after installing the DDS Add In try to reset Enterprise Architect s menus with the View Visual Layouts Default Layout menu option 2007 2008 Sparx Systems Pty Ltd DDS Technology Menu 13 3 1 1 Options Dialog
4. To open the example model select the Add Ins DDS Technology Open DDS Example Model menu option from the Enterprise Architect main menu O 2007 2008 Sparx Systems Pty Ltd 34 MDG Technology for DDS User Guide 3 8 DDS Diagram Types The MDG Technology for DDS introduces five new diagram types into Enterprise Architect These are e Domain Diagrams e Topic Diagrams e Application Diagrams e Type Diagrams e Qos Policy Create a DDS Diagram DDS s specialized diagrams can be created in the same way as any other diagram in Enterprise Architect see the Enterprise Architect documentation for further details Loading the DDS add in adds a DDS category of diagrams to the New Diagram dialog New Didenan Data Distribution Service Select From Diagram Types UML Structural 28 Domain UML Behavioral TE Topic Extended Application pps TE Type amp QoS Policy DDS Domain diagrams describe the DDS topology using of DDS Entities bound with Domains Topics and Participants An alternative method for creating a DDS diagram is to use the DDS Technology Menu 12 gt 2007 2008 Sparx Systems Pty Ltd Index 35 Index a Classifier Default 15 Code C Generation 29 C Generation 29 Generate 29 Java Generation 29 Compiled April 30 2008 2 Copyright Notice 3 Create DDS Project 26 D DDA Technology Menu 12 DDS Options Dialog 13 DDS Perspective Customize 16 Switc
5. Architect to perform DDS model validation select the Project Model Validation Configure menu option from the Enterprise Architect main menu The Model Validation Configuration dialog displays model Validation Contieuration Enabled Validation Rules C Element Well Formedness C Element Composition C Element Property Validity C Element OCL Conformance C Relationship Well Formedness C Relationship Property Validity C Relationship OCL Conformance C Feature Well Formedness C Feature Property Validity O Feature OCL Conformance C Diagram Well Formedness C Requirements Management Data Distribution Service DDS Rules If you are only performing DDS validation click on the Select None button select the Data Distribution Service DDS Rules checkbox and click on the OK button This is the default setting of the DDS Perspective Note that DDS is strongly based on UML so it might be a useful exercise to perform the UML validation too Validate a DDS Model To validate an element and any connectors attached to it a diagram and all its elements or a package and all its diagrams and elements against the DDS rules select the Project Model Validation Validate Selected menu option Model Yalidation Cancel Validation Validatina lifespan ddsLifespanQosPolicy For an explanation of the error and warning messages that might be returned when validating a DDS model see the Model Valida
6. Project From Scratch To create a new DDS project without reference to a template follow the steps below 1 Select the File New Project menu option In the Name field type an appropriate name for the DDS project Click on the Save button 2 Inthe Project Browser add two packages to the project Give these packages names appropriate to the project and purpose e A Platform Independent Model PIM package e An OMG IDL Platform Specific Model PSM package 3 To the PIM package add the following five child packages again give them names appropriate to the project and purpose e ADDS Qos library package e ADDS Type package for the DL type items e ADDS Topic package A DDS Domain package for the Domain DomainParticipant and related items e ADDS Application package for the application components The project tree should at this point resemble the following 2007 2008 Sparx Systems Pty Ltd Create a DDS Project 27 ay G ces wm Ay a E Model S m PIM 4 Application D 2 C Qos 4 Topic C Type ma PSM TProject Br Right click on the PIM package and select the Add In DDS Technology Load DDS Technology menu option After the DDS Technology has loaded successfully the context menu should now appear as follows Add Ins New DDS Project Manage Add Ins Unload DDS Technology New Application Diagram New Domain Diagram New T
7. U Using DDS 11 Validation Of Model 24 Rules For Elements 24 W Welcome 2 2007 2008 Sparx Systems Pty Ltd 37 O 2007 2008 Sparx Systems Pty Ltd MDG Technology for DDS User Guide www sparxsystems com
8. max_blocking_time duration in nanoseconds default 1 A stereotyped Class element that specifies the Resource Limits Qos Policy It applies the following Tagged Values e max_instances Integer maximum value default 1 to keep all instances e max_samples Integer maximum samples default 1 to keep all samples e max_samples per_ instance Integer maximum samples per instance default 1 to keep all samples per instance A stereotyped Class element that specifies the Time Based Filter Qos Policy It applies the following Tagged Values e minimum_separation duration in nanoseconds default 0 A stereotyped Class element that specifies the Topic Data Qos Policy It applies the following Tagged Values e value String A stereotyped Class element that specifies the Transport Priority Qos Policy It applies the following Tagged Values e value Integer default 0 A stereotyped Class element that specifies the User Data Qos Policy It applies the following Tagged Values e value String A stereotyped Class element that specifies the WriterData Lifecycle Qos Policy It applies the following Tagged Values e autodispose_unregistered_instances Boolean default true 2007 2008 Sparx Systems Pty Ltd 24 MDG Technology for DDS User Guide 3 4 Model Validation The MDG Technology for DDS registers with Enterprise Architect to receive model validation requests from users To configure Enterprise
9. package in the Project Browser into the diagram and create connectors between the Topic element and the Data Writer and Data Reader items Select the Application package and then select the Add Ins DDS Technology New Application Diagram menu option to create a DDS Application diagram Drag the DomainParticipant elements from the DDS Domain package in the Project Browser onto the diagram Create Application Component elements and then create Usage connectors between these and the DomainParticipant elements When you have saved these diagrams you have created a basic DDS Platform Independent Model PIM having the following structure in the Project Browser Project Browser OS cana camada E Model PIM Application 2g Application ddsComponent DDSComponent1 ddsComponent DDSComponent2 a Domain 28 Domain domainParticipant DomainParticipant1 domainParticipant DomainParticipant2 Ea domain Domain 1 Qos gosPolicyLibrary QoS Policies a Topic TE Topic Em topic Topic 5 Type TE Type a lt diStruct IDLStruct1 la PSM E E a ja Project Browser You can validate the newly created PIM by clicking on it and selecting the Project Model Validation Validate Selected menu option You can now go on to generate the PSM and code 297 O 2007 2008 Sparx Systems Pty Ltd Generate PSM and Code 29 3 6 Generate PSM and Code This process follows on from Creat
10. CT must be removed from the computer Unregistered use of MDG Technology for DDS after the 30 day evaluation period is in violation of Australian U S and international copyright laws SPARX may extend the evaluation period on request and at their discretion If YOU choose to use this software after the 30 day evaluation period a license must be purchased as described at_http Awww sparxsystems com ea_purchase htm Upon payment of the license fee YOU will be sent details of where to download the registered edition of MDG Technology for DDS and will be provided with a suitable software key by email ADDITIONAL RIGHTS AND LIMITATIONS YOU hereby undertake not to sell rent lease translate adapt vary modify decompile disassemble reverse engineer create derivative works of modify sub license loan or distribute the SOFTWARE PRODUCT other than as expressly authorized by this EULA O 2007 2008 Sparx Systems Pty Ltd Software Product License Agreement 5 YOU further undertake not to reproduce or distribute license key codes except under the express and written permission of SPARX If the SOFTWARE PRODUCT purchased is an Academic Edition YOU ACKNOWLEDGE THAT the license is limited to use in an educational context either for self education or use in a registered teaching institution The Academic Edition may not be used to produce commercial software products or be used in a commercial environment without the exp
11. DS Topic It applies the Topic following Tagged Values e filter_expression a string expression used as the filter to be applied to this topic e type a DDS typel 20 element used to describe the data structure for this topic the type element is an IDL class Multi Topic A stereotyped Part element that represents a DDS MultiTopic It applies the following Tagged Values e subscription_expression a string expression used as the subscription query to be applied to this topic e type a DDS type 204 element used to describe the data structure for this topic the type element is an IDL class Note Connector is redefined from the standard Enterprise Architect toolset and described in full in the Enterprise Architect User Guide 2007 2008 Sparx Systems Pty Ltd 20 MDG Technology for DDS User Guide 3 3 3 DDS Application The DDS Application toolbox provides elements and connectors for use on a DDS Application diagram Application Component use Element Description IICA Application A stereotyped Component element that represents a DDS application It is used to Component represent a compilable software artifact that represents a single DomainParticipant using the Use relationship Application Component is the DDS application used by the transformation process to specify the DDS implementation PSM generated by the transformation It applies the following Tagged Values e language An enumeratio
12. E PRODUCT e the repair of such SOFTWARE PRODUCT or the payment of the cost of replacing the SOFTWARE PRODUCT or of acquiring an equivalent SOFTWARE PRODUCT or e the payment of the cost of having the SOFTWARE PRODUCT repaired e Ifthe breach relates to services in relation to the SOFTWARE PRODUCT e the supplying of the services again or e the payment of the cost of having the services supplied again TRADEMARKS All names of products and companies used in this EULA the SOFTWARE PRODUCT or the enclosed 2007 2008 Sparx Systems Pty Ltd 6 MDG Technology for DDS User Guide documentation may be trademarks of their corresponding owners Their use in this EULA is intended to be in compliance with the respective guidelines and licenses Windows Windows 98 Windows NT Windows ME Windows Vista Windows XP and Windows 2000 are trademarks of Microsoft GOVERNING LAW This agreement shall be construed in accordance with the laws of the Commonwealth of AUSTRALIA O 2007 2008 Sparx Systems Pty Ltd Acknowledgement of Trademarks 7 1 3 Acknowledgement of Trademarks Trademarks of Microsoft Microsoft Windows Trademarks of the OMG OMG Object Management Group UML Unified Modeling Language 2007 2008 Sparx Systems Pty Ltd 8 MDG Technology for DDS User Guide 1 4 Support Technical support for the MDG Technology for DDS is available to registered users o
13. ODUCT or SOFTWARE means MDG Technology for DDS which includes computer software and associated media and printed materials and may include online or electronic documentation e Trial edition of MDG Technology for DDS means the edition of the SOFTWARE PRODUCT which is available free of charge for evaluation purposes for a period of 30 days GRANT OF LICENSE In accordance with the terms of this EULA YOU are granted the following rights a To install and use ONE copy of the SOFTWARE PRODUCT or in its place any prior version for the same operating system on a single computer As the primary user of the computer on which the SOFTWARE PRODUCT is installed YOU may make a second copy for your exclusive use on either a home or portable computer b To store or install a copy of the SOFTWARE PRODUCT on a storage device such as a network server used only to install or run the SOFTWARE PRODUCT over an internal network If YOU wish to increase the number of users entitled to concurrently access the SOFTWARE PRODUCT YOU must notify SPARX and agree to pay an additional fee c To make copies of the SOFTWARE PRODUCT for backup archival and instructional purposes EVALUATION LICENSE The Trial Version of MDG Technology for DDS is not free software Subject to the terms of this agreement YOU are hereby licensed to use this software for evaluation purposes without charge for a period of 30 days Upon expiration of the 30 days the SOFTWARE PRODU
14. Policy DurabilityQosPolicy ddsDurabilityOosPolicy PresentationGosPolicy ddsPresentationGasPolicy DeadlineQosPolicy ddsDeadlineQosPolicy LatencyBudgetQosPolicy ddsLatencyBudget osPolicy OwnershipQosPolicy ddsOwnershipQosPolicy OwnershipStrengthQosPolicy ddsOwnershipStrengthGosPolicy LivelinessQosPolicy ddsLivelinessQosPolicy TimeB asedFilterQ osPolicy ddsTimeBasedFilterQosPolicy Element desp urabilityS erviceQosPolicy This dialog is used to specify which Qos Policy Specifications are to be used as the default classifiers for QosProperty elements when new DDS Entities are created Each of the policies can be specified by any one Qos Policy Specification defined for that Policy The Defaults button can be used to automatically enable the MDG Technology to allocate the specifications for this project 2007 2008 Sparx Systems Pty Ltd 16 MDG Technology for DDS User Guide 3 2 Perspectives Perspectives enable Enterprise Architect users to alter the contents of the UML Toolbox to suit their particular modeling role The MDG Technology for DDS provides all the toolboxes necessary to create DDS models and the perspective performs the useful task of removing clutter by hiding everything else Switching Perspectives On loading the MDG Technology for DDS the DDS perspective is imported and activated automatically To switch to a different perspective or to switch back to DDS from a different perspective
15. R use or misuse of the SOFTWARE PRODUCT e YOUR inability to use or obtain access to the SOFTWARE PRODUCT e Negligence of SPARX or its employees contractors or agents or of any supplier of software incorporated in the SOFTWARE PRODUCT in connection with the performance of SPARX S obligations under this EULA or e Termination of this EULA by either party for any reason LIMITATION The SOFTWARE PRODUCT and any documentation are provided AS IS and all warranties whether express implied statutory or otherwise relating in any way to the subject matter of this EULA or to this EULA generally including without limitation warranties as to quality fitness merchantability correctness accuracy reliability correspondence with any description or sample meeting your or any other requirements uninterrupted use compliance with any relevant legislation and being error or virus free are excluded Where any legislation implies in this EULA any term and that legislation avoids or prohibits provisions in a contract excluding or modifying such a term such term shall be deemed to be included in this EULA However the liability of SPARX for any breach of such term shall if permitted by legislation be limited at SPARX S option to any one or more of the following upon return of the SOFTWARE PRODUCT and a copy of the receipt e If the breach relates to the SOFTWARE PRODUCT e the replacement of the SOFTWARE PRODUCT or the supply of an equivalent SOFTWAR
16. e a DDS Project 261 Ensure that you have validated the PIM before starting to generate the PSM There are two Tagged Values for an Application Component Language and Platform e The value of the Language Tagged Value defines the coding language to generate For RTI NDDS there are three possible values C C and Java e The value of the Platform Tagged Value depends on the language defined For e Cand C the value must be RTI_i86Win32VS2003 e Java the value must be RTI_i86Win32j2sdk13 Before you generate the PSM and code you might want to check and if necessary change the language and platform To generate the PSM and code follow the steps below 1 Open the DDS project and the PIM package and then open the Application diagram in the Application package 2 Inthe Application diagram select the Application Components from which to generate the PSM and code 3 Select the Project Model Transformations Transform Selected Elements menu option E DDS Projecti EA File Edit View Project Diagram Element Tools Add Ins Settings Window Help Da Bed Ba Gi Add Packace Ctri w a Zo A FE E a Add Diagram Ctrl y Add Element Ctrl M Spplication created 25 06 2007 10 36 03 AM modified 25 06 x CN A use Model Validation Transform Current Package Ctri Shift H Web Services y A es XML Schema gt fac tags i domain Security qos z tity_fa A Versio
17. e the RTIDDS transformer to automatically Reader generate a Listener for each DDS Reader Autogenerate IDL Select the checkbox to enable the DDS Topic Type elements to automatically be generated to IDL code during the transformation process Run NDDSGen on completion Select the checkbox to enable the RTIDDS transformer to automatically invoke the NDDSGEN command to the generated IDL to automatically 2007 2008 Sparx Systems Pty Ltd 14 MDG Technology for DDS User Guide Field Description OOOO Po generate the type specific DDS code for the implementation Generate Listener for DDS Select the checkbox to enable the RTIDDS transformer to automatically Writer generate a Listener for the DDS Writer Generate Shared Files to Select the checkbox to enable the RTIDDS transformer to generate the Folder common shared files to a specific folder The specific folder is a relative path to the Project Root folder Project Files Choice Click on the drop down arrow and select the type of project files for the RTIDDS transformer to generate For Visual Studio NET the workspace file is the Solution file Workspace Name The name of the workspace For Visual Studio Net this is the name of the solution DDS General Panel The options in the DDS General panel are used to specify the general behavior of the MDG Technology for DDS Fia Description S Show Toolbox Always Select the checkbox to always enable the DDS toolb
18. eating packages Adding Class Adding Class Adding Class Adding Class Adding Class Adding Class Adding Class Adding Class Adding Class Adding Class Adding Class DurationT ype DurabilityQosPolicy Durability_ServiceQosPolicy DeadlineQosPolicy Latency_BudgetGosPolicy LivelinessQosPolicy LifespanQosPolicy ReliabilityQosPolicy DestinationOrderQosPolicy History i Close Cancel Transform 6 When the transformation is complete the Generate Package Source Code dialog displays 2007 2008 Sparx Systems Pty Ltd Generate PSM and Code 31 Generate Package sonnce Gode Root Package PSM Synchronize Overwrite code Cancel Generate C Auto Generate Files Root Directory r Retain Existing File Paths Select Objects to Generate Include all Child Packages DataReaderlnformation s Bhl st DDSComponent2 EntityInfor DataReaderlnformation EIN DDSComponent1 Entityinfor DataReaderListener EN DDSComponent2 Commonc DataReaderListene ES srci Testi DDS Component Common Dos DDSComponent1 Qos C ATI sre T est DDSComponent2 Entitylnfor DataWriter nformation lass C NRTI lt sre T esti DDS Component SEntityInfor DataWriterListener las CARTIAsicATestiDDS Component2CommonL In the Synchronize field select Overwrite code then select the Include all Child Packages checkbox Click on the Generate button The system starts to generate the sou
19. f Enterprise Architect Responses to support queries are sent by email Sparx Systems endeavors to provide a rapid response to all product related questions or concerns Registered users can lodge a support request by visiting http www sparxsystems com registered reg support html Trial users can contact Sparx Systems with questions regarding their evaluation at support sparxsystems com An online user forum is also available for your questions and perusal at http www sparxsystems com cgi bin yabb YaBB cgi 2007 2008 Sparx Systems Pty Ltd System Requirements 9 1 5 System Requirements MDG Technology for DDS runs under the following environments Windows Operating Systems e Windows ME e Windows NT SP5 or later e Windows XP Professional e Windows XP Home e Windows XP Media Edition e Windows XP Tablet Edition e Windows 2000 Professional SP3 or later Enterprise Architect e Enterprise Architect Professional Version 6 5 or later e Enterprise Architect Corporate Version 6 5 or later Microsoft NET Framework Version 2 0 RTI Data Distribution Service NDDS 4 0g or later Notes e While the MDG Technology for DDS isn t specifically blocked from executing with the Enterprise Architect Desktop Edition be aware that the Desktop Edition cannot make use of some of the capabilities of the product such as Model Validation e There is a known limitation with the OpenEdge repository that
20. h 16 DDS Project Create From a Template 26 Create From Scratch 26 DDS Toolbox Application 20 Domain 18 Introduction 18 QoS Policies 21 Topic 19 Types 20 DDS Type 34 Default Classifiers 15 Diagram Application Elements And Connectors 20 DDS Application 34 DDS Domain 34 DDS Policy Library 34 DDS Topics 34 Domain Elements And Connectors 18 Qos Policies Library 21 Topic Elements And Connectors 19 Types 34 Types Elements And Connectors 20 Fe Element Model Validation Rules 24 Qos Policies 21 End User Licensing Agreement 4 Example Model Open 33 Generate C 29 C 29 Code 29 Java 29 PSM 29 Getting Started 10 L License Agreement 4 MDG Technology For DDS Acknowledgement of Trademarks 7 Copyright Notice 3 DDS Technology Menu 12 Getting Started 10 License Agreement 4 Support 8 System Requirements 9 Using DDS 11 Welcome 2 Model Validation Configuration 24 Perform 24 Rules for Elements 24 N NDDS Generator 29 O Options Set General 13 Set QoS Property Behavior 13 2007 2008 Sparx Systems Pty Ltd 36 MDG Technology for DDS User Guide Options Set RTIDDS 13 P PIM Create 26 Platform Independent Model Create 26 Platform Specific Model Generate 29 PSM Generate 29 Q Qos Policies Elements 21 Library Diagram 21 Toolbox 21 QoS Policy Specifications Dialog 15 R RTINDDS 29 O Support 8 System Requirements 9 Ta Trademarks 7
21. in 187 e DDS Topic 195 e DDS Application 20 e DDS Types 20 e DDS Qos Policies 2 3 3 1 DDS Domain The DDS Domain toolbox provides elements and connectors for use on a DDS Domain diagram Package Domain Domain Participant Subscriber Data Writer Publisher Data Reader QoS Property NG amp EG oL Connector Element Description OOOO Domain A stereotyped Part element that represents a DDS Domain Domain A stereotyped Component element that represents a DDS Domain Participant It applies Participant the following Tagged Value e domain the DDS Domain that this DomainParticipant participates in A stereotyped Part element that represents a DDS Subscriber It is modeled as a child of a DomainParticipant and can contain one or more DataReader elements as its children Data Writer A stereotyped Port element that represents a DDS DataWriter It is modeled as a child of a Publisher and can be connected to the DDS Topic that it writes A stereotyped Part element that represents a DDS Publisher It is modeled as a child of a DomainParticipant and can contain one or more DataWriter elements as its children Data Reader A stereotyped Port element that represents a DDS DataReader It is modeled as a child of a Subscriber and can be connected to the DDS Topic that it reads Qos Property A stereotyped Part element that represents a DDS Qos Policy for a DDS Entity It can be modeled as a child element for any of the foll
22. itect MDG Add In Copyright C 2007 2008 Sparx Systems Pty Ltd All Rights Reserved IMPORTANT READ CAREFULLY This End User License Agreement EULA is a legal agreement between YOU as Licensee and SPARX for the SOFTWARE PRODUCT identified above By installing copying or otherwise using the SOFTWARE PRODUCT YOU agree to be bound by the terms of this EULA If YOU do not agree to the terms of this EULA promptly delete the unused SOFTWARE PRODUCT The copyright in the SOFTWARE PRODUCT and its documentation is owned by Sparx Systems Pty Ltd A C N 085 034 546 Subject to the terms of this EULA YOU are granted a non exclusive right for the duration of the EULA to use and modify the SOFTWARE PRODUCT YOU do not acquire ownership of copyright or other intellectual property rights in any part of the SOFTWARE PRODUCT by virtue of this EULA Your use of this software indicates your acceptance of this EULA and warranty DEFINITIONS In this End User License Agreement unless the contrary intention appears e EULA means this End User License Agreement e SPARX means Sparx Systems Pty Ltd A C N 085 034 546 e Licensee means YOU or the organization if any on whose behalf YOU are taking the EULA e Registered Edition of MDG Technology for DDS means the edition of the SOFTWARE PRODUCT which is available for purchase from the web site htip www sparxsystems com ea_purchase htm Following the thirty day free evaluation period e SOFTWARE PR
23. l for each attribute in Union 3 3 5 DDS Qos Policies The DDS Qos Policies toolbox provides elements for use on a DDS Qos Policies Library diagram QosPolicy Library Deadline Destination Order Durability Service Durability Entity Factory Group Data History Latency Budget Lifespan Liveliness Ownership Strength Ownership Partition Presentation ReaderData Lifecycle Reliability Resource Limits Time Based Filter Topic Data Transport Priority User Data 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 E L WriterData Lifecycle 2007 2008 Sparx Systems Pty Ltd 22 MDG Technology for DDS User Guide Element Description S QosPolicy A stereotyped Package element that represents a collection of Qos Policy Specifications Library Deadline A stereotyped Class element that specifies the Deadline Qos Policy It applies the following Tagged Values e period duration in nanoseconds default 1 Destination A stereotyped Class element that specifies the Destination Order Qos Policy It applies the Order following Tagged Values e kind Enumeration BY_RECEPTION_TIMESTAMP default BY_SOURCE_TIMESTAMP Durability A stereotyped Class element that specifies the Durability Service Qos Policy It applies the Service following Tagged Values e history_depth Integer depth value default 1 history_kind Enumeration KEEP_LAST default KEEP_ALL max_instances Integer maximum value defa
24. lues e kind Enumeration AUTOMATIC default MANUAL_BY_PARTICIPANT MANUAL_BY_TOPIC e lease_duration duration in nanoseconds default 1 Ownership A stereotyped Class element that specifies the Ownership Strength Qos Policy It applies Strength the following Tagged Values e value Integer default 0 2007 2008 Sparx Systems Pty Ltd DDS Toolboxes 23 ReaderData Lifecycle Reliability Resource Limits Time Based Filter Topic Data Transport Priority User Data WriterData Lifecycle A stereotyped Class element that specifies the Ownership Qos Policy It applies the following Tagged Values e kind Enumeration SHARED default EXCLUSIVE A stereotyped Class element that specifies the Partition Qos Policy It applies the following Tagged Values e name String A stereotyped Class element that specifies the Presentation Qos Policy It applies the following Tagged Values e access_scope Enumeration INSTANCE default TOPIC GROUP e coherent_access Boolean default false e ordered_access Boolean default false A stereotyped Class element that specifies the ReaderData Lifecycle Qos Policy It applies the following Tagged Values e autopurge_nowriter_samples_delay duration in nanoseconds default 1 A stereotyped Class element that specifies the Reliability Qos Policy It applies the following Tagged Values e kind Enumeration BEST_EFFORT default RELIABLE e
25. n Control aa ly oA Import Export gt Manage Baselines Ctrl Alt B iA Use Case Metrics Das all View Project Statistics a xddsComponent DDSComponent1 DDS Types S El The Model Transformation dialog displays O 2007 2008 Sparx Systems Pty Ltd 30 MDG Technology for DDS User Guide Model Iranstormation Elements Transformations Name F ce M DDL T EJB Entity FT EJB Session T Java F JUnit T NUnit M ATIDDS M WSDL FT xSD Target Package DDS Component DDS Component DDSComponentl DDSComponent2 C Perform Transformations on result Close C Generate Code on result Intermediary File optional for debugging only CARTINTempitemplate_debug CJ CO Vi as 4 Select the RTIDDS checkbox If the target package is not listed against the checkbox the Browse Project dialog displays Select the PSM package as the target for the generated PSM and click on the OK button 5 On the Model Transformation dialog click on the Do Transform button If you have not specified a project root folder in the DDS Options 13 the system prompts you for the folder at this point The system starts to generate the PSM based on the selected DDS components the progress of the transformation is shown in the Transformation Progress window Transformation Progress Current Action Generating intermediary representation Parsing intermediary representation Cr
26. n Rules for Elements onnnnnnccnnnonnnicnnncncnccnnnnnanacn cnn cnn rn nn 24 Create alDDS Project inician iii 26 Generate PSM and Code immmcccnccccnnonnnncrncannrnnnrn rr 29 DDS Example Model iooioiia oa 33 DDS Diagram Types enanos 34 Index 35 2007 2008 Sparx Systems Pty Ltd Foreword 1 Foreword MDG Technology for DDS provides a light weight bridge between Enterprise Architect and DDS O 2007 2008 Sparx Systems Pty Ltd 2 MDG Technology for DDS User Guide 1 Welcome DDS MDG Technology m Welcome to the MDG Technology for DDS Enterprise Architect MDG Add In Version 1 0 The Add In extends the capability of Enterprise Architect to enable you to create Data Distribution Service DDS models The language specification for DDS is available from the Object Management Group OMG website Data Distribution Service for Real time Systems Specification Getting Started For instructions on how to install the MDG Technology for DDS see Getting Started 1 See Also e Copyright Notice 34 e Trademarks 74 e Support 84 e License Agreement 44 e System Requirements 941 2007 2008 Sparx Systems Pty Ltd Copyright Notice 3 1 1 Copyright Notice Copyright O 2007 2008 Sparx Systems Pty Ltd All rights reserved The MDG Technology For DDS software contains proprietary information of Sparx Systems Pty Ltd It is provided under a license agreeme
27. n attempts to use more than one DomainParticipant Missing or invalid association The given DDS topic is not associated with any DataReaders or lt other information gt DataWriters or a DataReaderDataWriter is not associated with any topics Duplicated DDS Entity Name The given DDS entity has the same name as another DDS entity lt Any DDS Entity name gt Unsupported type found in lt DDS Type gt The type of attribute in the given DDS Type entity is neither an IDL lt attribute gt lt attribute type gt primitive type nor a user defined DDS type Missing DDS parent The given DDS entity does not belong to the specified parent type lt Any DDS Entity type gt Invalid DDS parent The given DDS entity belongs to the wrong parent type lt Any DDS Entity type gt Note A DDS model might trigger additional UML validation messages but these are outside the scope of this document See the Enterprise Architect User Guide O 2007 2008 Sparx Systems Pty Ltd 26 MDG Technology for DDS User Guide 3 5 Create a DDS Project There are two ways in which you can create a new DDS project e From a template e From scratch Create a DDS Project From a Template Select the Add Ins DDS Technology New DDS Project menu option Add Ins Settings Window Help Manage Add Ins Open DDS Example Project Help About The new DDS project is generated from a DDS template project Create a New DDS
28. n representing the target software language for this application implementation C C Java e platform An enumeration representing the target implementation platform for this application implementation RTI_i86Win32VS2003 RTI_i86Win32j2sdk13 A stereotyped Dependency relationship that represents a use of a DDS DomainParticipant by an Application Many Applications can use the same DomainParticipant as required to create a heterogeneous DDS design 3 3 4 DDS Types The DDS Types Toolbox provides elements and connectors for use on a DDS Types diagram a E oo o o o Mmmm S S Element Deseription S Enumeration A stereotyped Class element that represents an IDL Enumeration Struct A stereotyped Class element that represents an IDL Struct TypeDef A stereotyped Class element that represents an IDL TypeDef Union o A stereotyped Class element that represents an IDL Union O 2007 2008 Sparx Systems Pty Ltd DDS Toolboxes 21 Element Description S A stereotyped Attribute feature that represents an IDL Array A stereotyped Attribute feature that represents an IDL Sequence constant A sreoypea Atribute otro al represents an DL Corsia Comen A treoypea Atrato otr at represents ar OL Swen DDS Types Conventions The following conventions are used on a DDS Types diagram Tagged Value Applies to Corresponds To switchType Switch type of an IDL Union case o unionAttribute Case Labe
29. nt containing restrictions on use and disclosure and is also protected by copyright law Reverse engineering of the software is prohibited Please read the license agreement 4 for full details Due to continued product development this information could change without notice The information and intellectual property contained herein is confidential between Sparx Systems and the client and remains the exclusive property of Sparx Systems If you find any problems in the documentation please report them to us in writing Sparx Systems does not warrant that this document is error free No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means electronic mechanical photocopying recording or otherwise without the prior written permission of Sparx Systems Licensed users are granted the right to print a single hardcopy of the user manual per licensed copy of the software but may not sell distribute or otherwise dispose of the hardcopy without written consent of Sparx Systems Sparx Systems Pty Lid 7 Curtis St Creswick Victoria 3363 AUSTRALIA Phone 61 3 5345 1140 Fax 61 3 5345 1104 Support Email support sparxsystems com Sales Email sales sparxsystems com Website http www sparxsystems com 2007 2008 Sparx Systems Pty Ltd 4 MDG Technology for DDS User Guide 1 2 Software Product License Agreement MDG Technology for DDS Enterprise Arch
30. o have been caused directly or indirectly by this document Printed May 2008 Special thanks to Publisher All the people who have contributed suggestions examples bug Sparx Systems reports and assistance in the development of MDG Technology for k DDS The task of developing and maintaining this tool has been Managing Editor greatly enhanced by their contribution Geoffrey Sparks Technical Editor Simon Zhang l MDG Technology for DDS User Guide Table of Contents Foreword 1 Welcome 2 Copyright Notice iii araa r aea a e ei rapa aeaea Eaa aeaaea an 3 Software Product License Agreement ssssssssnsesunsuunnunnnnunnnunnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn nnmnnn 4 Acknowledgement of Trademarks o nccmmncccccnnnnccncnnnncccrnnnrnnnn rre 7 eS o oo a eae EE ENA A E E neescuscnnves 8 System Requirements cnnmcccccncnnnnnnnnncccanrnc rr 9 Getting Started 10 Using the MDG Technology for DDS 11 DDS Technology Menu mncccicccnninccnninnnnnnc rr 12 DAS DU a 13 Qos Policy Specifications Dialog ooconnnonnmsnsrr enn reee 15 A jieiticc cassie fice eeraa ae AEAEE EREE ASAE by ce cege cased AEAEE AEE 16 DDS TOO NO A 000 cece ae ar ra ei a ac e aea dele A eNe ened aaa Teao Shannen Kaeaea aea a onoaiiae 18 DDS Domains onra AAA orara ii iii 18 DDS TOP iG sts aaa 19 DDS AppliGatin sriain a a daaa A aaret da aaa aeaa 20 DDS TS E E A E A E 20 DDS Qos Policies ia dias 21 Model ValldatiOnN c ii ee ee eo 24 Model Validatio
31. opic Diagram New Type Diagram Open DDS Example Project Select the Add Ins DDS Technology New Qos Policy Library menu option The Browse Project dialog displays Select the DDS Qos Library package as the location of the Qos Library The Qos Policy Specifications dialog displays Click on the Defaults button and the Yes button to assign a default value to all of the Qos Policy Specifications then click on the OK button Select the Type package and then select the Add Ins DDS Technology New Type Diagram menu option to create a DDS Type diagram In the diagram create some DDS Type elements and add attributes to the elements Select the Topic package and then select the Add Ins DDS Technology New Topic Diagram menu option to create a DDS Topic diagram In the diagram create some DDS Topic elements and assign 2007 2008 Sparx Systems Pty Ltd 28 MDG Technology for DDS User Guide 10 11 12 the Tagged Value Type to the elements Select the Domain package and then select the Add Ins DDS Technology New Domain Diagram menu option to create a DDS Domain diagram In the diagram create a domain and some DomainParticipant elements and assign the Tagged Value of Domain to the elements Within the DomainParticipant elements create some Publisher Subscriber items Create Data Writer items for each Publisher item and Data Readeritems for each Subscriber Drag a Topic element from the Topic
32. owing Entities that can have Qos policies defined for it DomainParticipant Subscriber Publisher DataReader DataWriter Topic Content Filtered Topic Multi Topic 2007 2008 Sparx Systems Pty Ltd DDS Toolboxes 19 Element Description III The name of the property specifies the Qos Policy defined by the property It is also typed by a Qos policy specification which defines the specific data for that policy Note A Qos Property must be typed by a Qos Policy Specification in order to have the correct Tagged Values for the Qos Policy For more information about Qos Policy Specifications refer to DDS Qos Policies 2 Note Package and Connector are redefined from the standard Enterprise Architect toolset and are described in full in the Enterprise Architect User Guide 3 3 2 DDS Topic The DDS Topic toolbox provides elements and connectors for use on a DDS Topic diagram Topic Content Filtered Topic Multi Topic NEHE Connector Element Description S O A stereotyped Part element that represents a basic DDS Topic DDS Topics can be connected to one or more DataReader and DataWriter elements that perform the role of reading or writing data to this topic It applies the following Tagged Values e type a DDS typel 20 element used to describe the data structure for this topic The type element is an IDL class Content Filtered A stereotyped Part element that represents a Content Filtered D
33. oxes regardless of the selected toolbox perspective Note When this option is enabled the Only Show Toolbox with DDS Perspective checkbox is unchecked automatically Only Show Toolbox with DDS Select the checkbox to enable the DDS toolboxes only when the DDS Perspective perspective is activated Note When this option is enabled the Show Toolbox Always checkbox is unchecked automatically Ignore validation warnings Select the checkbox to ignore any DDS warning messages during the model validation process Qos Property Behavior Panel The options in the Qos Property Behavior panel are used to specify the behavior of Qos properties in the DDS model Show as Entity Select the checkbox to enable the Qos Policies to be displayed on DDS Compartments entities using the compartment notation Create Automatically for new Select the checkbox to enable the Qos Policy properties to be automatically Entities created when new DDS Entities are created in the model Enabling this option requires the Qos Policy specifications to be defined using the Qos Policy Specifications 157 dialog is Set Specifications Click on this button to open the Qos Policy Specifications 137 dialog 15 2007 2008 Sparx Systems Pty Ltd DDS Technology Menu 15 3 1 2 Qos Policy Specifications Dialog Gos Volley Speciications DurabilityS erviceQosPolicy ddsDurabilityS erviceQosPolicy UserDataQosPolicy ddsUserD ataQos
34. prevents loading data fields larger than 30 000 bytes This means that the MDG Technology for DDS which is larger than 30 000 bytes cannot be loaded into a model that is stored in an OpenEdge repository OpenEdge users are asked to use EAP files for their DDS modeling 2007 2008 Sparx Systems Pty Ltd 10 MDG Technology for DDS User Guide 2 Getting Started The MDG Technology for DDS is available for download from the Products page on the Sparx Systems website Once it has been downloaded the program is in exe format To install the MDG Technology for DDS follow the steps below 1 2 3 Download the EADDS exe file from the Sparx Systems website Ensure that you meet the System Requirements 9 and have Enterprise Architect version 6 5 or higher To install the MDG Technology for DDS component double click on the EADDS exe Installer executable The MDG Technology for DDS Installation Wizard screen displays SMOG Technology tor DOS SETUP Welcome to the MDG Technology for DDS Installation Wizard It is strongly recommended that you exit all Windows programs before running this setup program Click Cancel to quit the setup program then close any programs you have running Click Next to continue the installation WARNING This program is protected by copyright law and international treaties O Q o Q gt 10 3 O D 5 o Y Unauthorized reproduction or distribution of this
35. program or any portion of it may result in severe civil and criminal penalties and will be prosecuted to the maximum extent possible under law S 9 JOSHUYdI Y esiudiejuy Copyright Spars Systems 1998 2006 Read the licensing agreement and if you accept the terms click on the Next button Read the Readme information and then click on the Next button In the User name and Organization fields type your user and company names Click on the Next button Optionally define the users who have access to this program by either choosing the All users option or registering specific users Choose an installation path for the program and then click the Next button When installation is complete click on the Finish button O 2007 2008 Sparx Systems Pty Ltd 11 3 Using the MDG Technology for DDS A DDS tutorial is outside the scope of this document Rather this document describes the following features of the MDG Technology for DDS e DDS Diagram Types 345 e DDS Technology Menu 1A e DDS Toolboxes 18 e Model Validation 244 e DDS Example Model 33 O 2007 2008 Sparx Systems Pty Ltd 12 MDG Technology for DDS User Guide 3 1 DDS Technology Menu The DDS Technology sub menu is available from the Add Ins menu on the main menu bar Unload DDS Technology New Application Diagram New Domain Diagram New Qos Policy Library New Topic Diagram New Type Diagram Open DDS Example Model
36. rce code for the specified language in the project root file The progress of the code generation is shown in the Batch Generation window Batch generation Current Action Generate selected objects generating C RATI src T est DDSComponent2 Entitylnformation h generating C RTI sre T est ODSComponent1 SEntitylnformation h generating C RATI src T est ODSComponent2 CommonListener h generating C ATI src T est DDS Component CommonListener h generating C ATI src T est DDSComponent2 GosE ntityDictionary h generating C ATI sre T est DDSComponent GosEntityDictionary h generating CARTIAsrckTestDDSComponent14DDSComponentl h generating C ATI src T est DDSComponent DDSComponent1 DataDictionary h generating CARTIAsickTestDDSComponent11DDSComponentl Factory h generating C ATI stc T est DDSComponent2 DDSComponent2 h ing CARTIAsrcATestDDSComponent24DDS Component2D ataDictionary h CARTA sic TestDDS Component24DDSComponent2Factory h Cancel Generation Close When code generation is complete the system runs the NDDS generator to generate code from the IDL type O 2007 2008 Sparx Systems Pty Ltd 32 MDG Technology for DDS User Guide UWS Technology for DDS DDS esr NDDSGen Execution Completed When the NDDS generator has completed you have finished generating the PSM and code 2007 2008 Sparx Systems Pty Ltd DDS Example Model 33 3 7 DDS Example Model
37. ress written permission of SPARX ASSIGNMENT YOU may only assign all your rights and obligations under this EULA to another party if YOU supply to the transferee a copy of this EULA and all other documentation including proof of ownership Your License is then terminated TERMINATION Without prejudice to any other rights SPARX may terminate this EULA if YOU fail to comply with the terms and conditions Upon termination YOU or YOUR representative shall destroy all copies of the SOFTWARE PRODUCT and all of its component parts or otherwise return or dispose of such material in the manner directed by SPARX WARRANTIES AND LIABILITY WARRANTIES SPARX warrants that the SOFTWARE PRODUCT will perform substantially in accordance with the accompanying written materials for a period of ninety 90 days from the date of receipt and any Support Services provided by SPARX shall be substantially as described in applicable written materials provided to YOU by SPARX and SPARX support engineers will make commercially reasonable efforts to solve any problems associated with the SOFTWARE PRODUCT EXCLUSIONS To the maximum extent permitted by law SPARX excludes for itself and for any supplier of software incorporated in the SOFTWARE PRODUCT all liability for all claims expenses losses damages and costs made against or incurred or suffered by YOU directly or indirectly including without limitation lost costs profits and data arising out of e YOU
38. simply select the perspective name from the drop down list at the top of the Toolbox DDS DDS Domain 4 C Package E Domain Domain Participant E Subscriber Data Reader E Publisher Data Writer E QoS Property Z Connector DDS Topic v DDS Application DDS Types DDS QoS Policies Customizing the DDS Perspective The DDS perspective by default hides all non DDS toolboxes To make any of these non DDS toolboxes available while the DDS perspective is active select the View Perspectives menu option the Configure Perspectives dialog displays Further help on using this dialog is available from the Enterprise Architect User Guide by pressing the Help button on the dialog 2007 2008 Sparx Systems Pty Ltd Perspectives 17 EJJA Haani Defined Perspectives Perspective Detail Toolbox Folders Folder Buttons All UML 2 1 Business Analyst Domain Analyst Requirements Analyst System Architect Data Architect 504 Architect Developer Real Time Engineer Tester Deployment Architect Project Manager Meta Modeler ICONIX None FJ xmL Schema JwspL Requirements Language IDL Y Active Assign Layout to Perspective lt None gt Model Yalidation O 2007 2008 Sparx Systems Pty Ltd 18 MDG Technology for DDS User Guide 3 3 DDS Toolboxes This section describes the toolboxes provided with the MDG Technology for DDS e DDS Doma
39. tion Rules for Elements 24 topic 3 4 1 Model Validation Rules for Elements The following messages might be output by the validation of a DDS element Message DDS Entity missing data for Tagged A DDS DomainParticipant Topic or Application is missing the Value Tagged Value specified by the message lt domain type language platform gt 2007 2008 Sparx Systems Pty Ltd Model Validation 25 Message DDS Entity contains invalid data for The DDS DomainParticipant or Topic refers to an invalid element Tagged Value in the specified Tagged Value lt domain type gt Missing QosPolicy The DDS DomainParticipant Topic Subscriber Publisher lt QOS property gt DataReader or DataWriter is missing the specified Qos Policy PSM Transform will use system default specified by a QosProperty element The PSM transformation values for this policy process assumes the system default value for this Qos Policy Missing child entity The DDS DomainParticipant Publisher or Subscriber are missing lt Publisher or Subscriber DataReader any of their required children entities DataWriter gt Invalid children entities found of type The given DDS entity contains other DDS entities as children lt Any DDS Entity gt which it is not supposed to have Missing or invalid usage relationship The given DDS application is not bound to any DomainParticipant lt other information gt or vice versa or if an applicatio
40. ult 1 to keep all instances max_samples Integer maximum samples default 1 to keep all samples max_samples_per_instance Integer maximum samples per instance default 1 to keep all samples per instance service_cleanup_delay duration in nanoseconds default 0 Durability A stereotyped Class element that specifies the Durability Qos Policy It applies the following Tagged Values e kind Enumeration TRANSIENT TRANSIENT_LOCAL VOLATILE default PERSISTENT Entity Factory A stereotyped Class element that specifies the EntityFactory Qos Policy It applies the following Tagged Values e autoenable_created_entities Boolean default true Group Data A stereotyped Class element that specifies the Groupdata Qos Policy It applies the following Tagged Values e datavalue String History A stereotyped Class element that specifies the History Qos Policy It applies the following Tagged Values e depth Integer default 1 e kind Enumeration KEEP_LAST default KEEP_ALL Latency A stereotyped Class element that specifies the LatencyBudget Qos Policy It applies the Budget following Tagged Values e duration duration in nanoseconds default 0 Lifespan A stereotyped Class element that specifies the Liveliness Qos Policy It applies the following Tagged Values e duration duration in nanoseconds default 0 Liveliness A stereotyped Class element that specifies the Deadline Qos Policy It applies the following Tagged Va
Download Pdf Manuals
Related Search