SDMetrics User Manual V2.5 May 2, 2021 SDMetrics ® User Manual www.sdmetrics.com For product support and latest product news and updates, visit www.sdmetrics.com e-mail: [email protected] Jürgen Wüst In der Lache 17 67308 Zellertal Germany All rights reserved. No part of this manual may be reproduced, in any form or by any means, without permission in writing from the author. Oracle, Java, and OpenJDK are registered trademarks of Oracle and/or its affiliates. Linux is a trademark of Linus Torvalds. UNIX is a registered trademark of X/Open Company Limited. Windows, Excel are registered trademarks of Microsoft, Inc. MOF, UML and XMI are either registered trademarks or trademarks of the Object Management Group, Inc. MagicDraw is a trademark or registered trademark of No Magic, Inc. XML is a trademark of the World-Wide Web Consortium. SDMetrics is a registered trademark of Jürgen Wüst. All other product names and company names mentioned herein are the property of their respective owners. © 2002-2021. All rights reserved. ii SDMetrics ® User Manual www.sdmetrics.com Table of Contents 1 Introduction.......................................................................................................................................1 2 Installation.........................................................................................................................................2 2.1 System Requirements................................................................................................................2 2.2 Quick Installation and Start.......................................................................................................2 2.3 Installing SDMetrics..................................................................................................................2 2.3.1 Single User Installation......................................................................................................2 2.3.2 Multiple Users Installation.................................................................................................3 2.4 Updating SDMetrics from an Older Version.............................................................................3 2.5 Invoking SDMetrics...................................................................................................................4 2.6 Uninstalling SDMetrics.............................................................................................................4 3 Getting Started...................................................................................................................................5 4 The SDMetrics User Interface...........................................................................................................9 4.1 Getting Help...............................................................................................................................9 4.2 Specifying Project Settings........................................................................................................9 4.2.1 Specifying Project Files.....................................................................................................9 4.2.2 Specifying Filters.............................................................................................................12 4.2.3 Saving Project Settings....................................................................................................14 4.2.4 Loading Project Settings..................................................................................................14 4.3 Calculating and Viewing Metric Data.....................................................................................14 4.3.1 Common controls in views..............................................................................................15 4.4 The View 'Metric Data Tables'................................................................................................17 4.4.1 Highlighting Outliers.......................................................................................................18 4.5 The View 'Histograms'.............................................................................................................18 4.6 The View 'Kiviat Diagrams'.....................................................................................................20 4.7 The View 'Rule Checker'.........................................................................................................21 4.7.1 Filtering Design Rules.....................................................................................................23 4.7.2 Accepting Design Rule Violations...................................................................................24 4.8 The View 'Descriptive Statistics'.............................................................................................25 4.9 The View 'Design Comparison'...............................................................................................26 4.9.1 Calculating and Viewing Metric Deltas...........................................................................27 4.9.2 Metric Deltas Table..........................................................................................................27 4.9.3 Comparative Descriptive Statistics Table........................................................................28 4.9.4 Mapping Design Elements...............................................................................................29 4.9.5 Exporting Metric Deltas...................................................................................................30 4.10 The View 'Relation Matrices'.................................................................................................30 4.11 The View 'Graph Structures'..................................................................................................32 4.11.1 Viewing Cycles..............................................................................................................32 4.11.2 Viewing Connected Components...................................................................................33 4.12 The View 'Model'...................................................................................................................34 4.13 The View 'Catalog'.................................................................................................................35 4.14 The View 'Log'.......................................................................................................................36 4.15 Exporting Data.......................................................................................................................37 4.15.1 Exporting Data Tables....................................................................................................37 4.15.2 Exporting Graphs...........................................................................................................39 4.16 Setting Preferences.................................................................................................................40 © 2002-2021. All rights reserved. iii SDMetrics ® User Manual www.sdmetrics.com 4.16.1 Project File Sets.............................................................................................................40 4.16.2 Percentiles......................................................................................................................44 4.16.3 Output.............................................................................................................................45 4.16.4 Appearance.....................................................................................................................46 4.16.5 Behavior.........................................................................................................................47 5 Running SDMetrics from the Command Line................................................................................49 6 Design Measurement.......................................................................................................................53 6.1 Design Metrics and System Quality........................................................................................53 6.2 Structural Design Properties....................................................................................................54 6.2.1 Size...................................................................................................................................54 6.2.2 Coupling...........................................................................................................................55 6.2.3 Inheritance........................................................................................................................56 6.2.4 Complexity.......................................................................................................................57 6.2.5 Cohesion...........................................................................................................................57 6.3 Data Analysis Techniques........................................................................................................58 6.3.1 Descriptive Statistics........................................................................................................59 6.3.2 Dimensional Analysis......................................................................................................59 6.3.3 Rankings...........................................................................................................................60