Difference between revisions of "XCSG:ModelElement"

From AtlasWiki
Jump to: navigation, search
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The ModelElement kind, represent an abstraction drawn from the system being modeled.  Model elements have names and may be associated with a [[namespace]]
+
An XCSG ModelElement is either a [[Node]] or [[Edge]] in an XCSG graph.
A distinct id identifies the element in the graph.  It may be composed of the element’s name and a number, or take any other form that ensures the id is unique within the definition of the overall graph that contains the element.
+
  
Documentation may optionally be associated with model elements, representing comments or other descriptions.
+
XCSG model elements have an <code>id</code> attribute, which uniquely identifies that element; the <code>id</code> attribute should enable those familiar with the analyzer which produced that node or edge to determine whether the graph already contains a node or edge representing a particular entity or relationship. No two model elements with equal IDs can exist in the same graph, to ensure each modeled element or relationship has a single representation in the graph.
  
Model elements may also be stereotyped.
 
 
== Specification ==
 
== Specification ==
{| class="wikitable" style="width:100%"
+
{{Metaclass
! width="160" align="left"|Metaclass
+
| description = An abstraction drawn from the system being modeled.
| ModelElement
+
}}
|-
+
! Description
+
| An abstraction drawn from the system being modeled.
+
|}
+
  
{| class="wikitable"  style="width:100%"
+
{{Attribute
! width="160"|Attribute
+
| name = name
| name
+
| description = The name of the element within its [[Namespace]], or a brief, human-readable label.
|-
+
| type = String
! Description
+
}}
| The name of the element within its [[Namespace]]
+
|-
+
! Type
+
| String
+
|}
+
  
{| class="wikitable"  style="width:100%"
+
{{Attribute
! width="160"|Attribute
+
| name = sourceCorrespondence
| id
+
| description = The location or locations in source code corresponding to the element.
|-
+
| type = A SourceCorrespondence object or list of SourceCorrespondence objects.
! Description
+
| required = On nodes originating from source code. Edges (such as [[Call]] edges) that summarize multiple locations in source code contain lists of SourceCorrespondence objects indicating each location summarized.
| The id that uniquely identifies the model element  
+
}}
|-
+
[[Category:XCSG Tags]]
! Type
+
| [[Opaque]]
+
|}
+
 
+
[[Category:XCSG]]
+
[[Category:XCSG Kind]]
+
[[Category:XCSG Tag]]
+

Latest revision as of 15:29, 15 October 2015

An XCSG ModelElement is either a Node or Edge in an XCSG graph.

XCSG model elements have an id attribute, which uniquely identifies that element; the id attribute should enable those familiar with the analyzer which produced that node or edge to determine whether the graph already contains a node or edge representing a particular entity or relationship. No two model elements with equal IDs can exist in the same graph, to ensure each modeled element or relationship has a single representation in the graph.

Specification

Metaclass ModelElement
Description An abstraction drawn from the system being modeled.
Direct Subkinds Edge, Node
Attribute name
Description The name of the element within its Namespace, or a brief, human-readable label.
Type String
Required Yes
Attribute sourceCorrespondence
Description The location or locations in source code corresponding to the element.
Type A SourceCorrespondence object or list of SourceCorrespondence objects.
Required On nodes originating from source code. Edges (such as Call edges) that summarize multiple locations in source code contain lists of SourceCorrespondence objects indicating each location summarized.