ST6RI-520 Edited comments in SpatialFrames and SpatialItems.

Author: seidewitz

sysml.library/Domain Libraries/Geometry/SpatialItems.sysml

@@ -14,20 +14,20 @@ package SpatialItems {
 	private import ControlFunctions::forAll;
 
 	/**
-	 * A SpatialItem is an Item with a three dimensional spatial extent that also acts as a SpatialFrame of reference.
+	 * A SpatialItem is an Item with a three-dimensional spatial extent that also acts as a SpatialFrame of reference.
 	 */
 	item def SpatialItem :> SpatialFrame {
 		item :>> self : SpatialItem;
 
 		/**
-		 * A local Clock to be used as the corresponding time reference within this SpatialItem
-		 * and any componentItems. By default this is the global defaultClock.
+		 * A local Clock to be used as the corresponding time reference within this SpatialItem. 
+		 * By default this is the global defaultClock.
 		 */
 		item localClock : Clock[1] default Time::defaultClock;
 
 		/**
-		 * The VectorMeasurementReference to be used as the measurement reference for position and displacement
-		 * vector values relative to this SpatialItem.
+		 * The three-dimensional VectorMeasurementReference to be used as the measurement reference for position 
+		 * and displacement vector values relative to this SpatialItem.
 		 */
 		attribute coordinateFrame : VectorMeasurementReference[1] default Cartesian3dSpatialCoordinateSystem() {
 			attribute :>> dimensions = 3;
@@ -36,7 +36,7 @@ package SpatialItems {
 		/**
 		 * The Point at the origin of the coordinateFrame of this SpatialItem.
 		 */
-		item originPoint : Point :> spaceShots;
+		item originPoint : Point[1] :> spaceShots;
 
 		/**
 		 * The CurrentPositionOf the originPoint must always be a zero vector.
@@ -47,12 +47,14 @@ package SpatialItems {
 	}
 
 	/**
-	 * A CompoundSpatialItem is a SpatialItem that is a union of a collection of component SpatialItems.
+	 * A CompoundSpatialItem is a SpatialItem that is a spacial union of a collection of component SpatialItems.
 	 */
 	item def CompoundSpatialItem :> SpatialItem {
 
 		/**
-		 * The composite SpatialItems that together make up this CompoundSpatialItem.
+		 * The composite SpatialItems that together make up this CompoundSpatialItem. 
+		 * The coordinateFrames of the compositeItems are nested in the coordinateFrame of the CompoundSpatialItem, 
+		 * and, by default, they have the same localClock as the CompoundSpacialItem.
 		 */
 		item componentItems : SpatialItem[0..*] ordered :> subitems {
 			item nestedLocalClock :>> localClock default localClock;

sysml.library/Kernel Library/SpatialFrames.kerml

@@ -27,7 +27,7 @@ package SpatialFrames {
 
 	/**
 	 * The PositionOf a Point relative to a SpatialFrame, at a specific time relative to a given
-	 * clock, as a positionVector that is a ThreeVectorValue.
+	 * Clock, as a positionVector that is a ThreeVectorValue.
 	 */
 	abstract function PositionOf {
 		in point : Point[1];
@@ -46,7 +46,7 @@ package SpatialFrames {
 
 		/**
 		 * The result positionVector is equal to the PositionOf the Point spaceShot of the
-		 * frame that encloses the given point, at the current time.
+		 * frame that encloses the given point, at the given time.
 		 */
 		inv spacePositionConstraint {
 			(frame.spaceShots as Point)->forAll{in p : Point;
@@ -70,8 +70,8 @@ package SpatialFrames {
 
 	/**
 	 * The DisplacementOf two Points relative to a SpatialFrame, at a specific time relative to a
-	 * given clock, is the displacementVector computed as the difference between the PositionOf the 
-	 * first point and PositionOf the second point, relative to that SpatialFrame, at that time.
+	 * given Clock, is the displacementVector computed as the difference between the PositionOf the 
+	 * first Point and PositionOf the second Point, relative to that SpatialFrame, at that time.
 	 */
 	function DisplacementOf {
 		in point1 : Point[1];
@@ -94,8 +94,8 @@ package SpatialFrames {
 	}
 
 	/**
-	 * The CurrentDisplacementOf two points relative to a SpatialFrame and Clock is the DisplacementOf
-	 * the Points realtive to the SpacialFrame at the currentTime of the Clock.
+	 * The CurrentDisplacementOf two Points relative to a SpatialFrame and Clock is the DisplacementOf
+	 * the Points relative to the SpacialFrame at the currentTime of the Clock.
 	 */
 	function CurrentDisplacementOf {
 		in point1 : Point[1];
@@ -134,7 +134,7 @@ package SpatialFrames {
 	}
 
 	/**
-	 * The DisplacementOf two points relative to a CartesianSpatialFrame is a CartesianThreeVectorValue.
+	 * The DisplacementOf two Points relative to a CartesianSpatialFrame is a CartesianThreeVectorValue.
 	 */
 	function CartesianDisplacementOf :> DisplacementOf {
 		in point1 : Point[1];
@@ -146,7 +146,7 @@ package SpatialFrames {
 	}
 
 	/**
-	 * The CurrentDisplacementOf two points relative to a CartesianSpatialFrame is a CartesianThreeVectorValue.
+	 * The CurrentDisplacementOf two Points relative to a CartesianSpatialFrame is a CartesianThreeVectorValue.
 	 */
 	function CartesianCurrentDisplacementOf :> CurrentDisplacementOf {
 		in point1 : Point[1];