aes70 1.3.8 → 1.4.0

package/src/types/OcaPositionCoordinateSystem.d.ts

@@ -2,7 +2,8 @@
  * This file has been generated.
  */
 /**
- * Enumeration that designates the type of position coordinate system used. For details, see the AES70-1 description of the  **OcaPhysicalPosition** class.
+ * Enumeration that designates the type of position coordinate system used. For
+ * details, see the AES70-1 description of the **OcaPhysicalPosition** class.
  * @class OcaPositionCoordinateSystem
  */
 export class OcaPositionCoordinateSystem {

package/src/types/OcaPositionCoordinateSystem.js

@@ -4,7 +4,8 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration that designates the type of position coordinate system used. For details, see the AES70-1 description of the  **OcaPhysicalPosition** class.
+ * Enumeration that designates the type of position coordinate system used. For
+ * details, see the AES70-1 description of the **OcaPhysicalPosition** class.
  * @class OcaPositionCoordinateSystem
  */
 export class OcaPositionCoordinateSystem extends Enum({

package/src/types/OcaPositionDescriptor.d.ts

@@ -1,11 +1,14 @@
 /*
  * This file has been generated.
  */
-
 import {
-  OcaPositionCoordinateSystem,
   IOcaPositionCoordinateSystem,
+  OcaPositionCoordinateSystem,
 } from './OcaPositionCoordinateSystem';
+import {
+  IOcaPositionDescriptorFieldFlags,
+  OcaPositionDescriptorFieldFlags,
+} from './OcaPositionDescriptorFieldFlags';
 
 export declare interface IOcaPositionDescriptor {
   /**
@@ -16,9 +19,9 @@ export declare interface IOcaPositionDescriptor {
 
   /**
    * Which fields of the Values[] array contain valid values.
-   * @type number
+   * @type OcaPositionDescriptorFieldFlags
    */
-  FieldFlags: number;
+  FieldFlags: IOcaPositionDescriptorFieldFlags;
 
   /**
    * The coordinates
@@ -29,48 +32,46 @@ export declare interface IOcaPositionDescriptor {
 
 export declare class OcaPositionDescriptor implements IOcaPositionDescriptor {
   /**
-   * A six-axis c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these axes shall be interpreted as follows:
+   * A six-axis c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these
+   * axes shall be interpreted as follows:
    *
    *  - c1 = X; axial (fore-and-aft) position
    *
-   *
    *  - c2 = Y; lateral (side-to-side) position
    *
-   *
    *  - c3 = Z; vertical position
    *
+   *  - c4 = rX; rotation around the X-axis, also known as *Roll*
    *
-   *  - c4 = rX; rotation around the X-axis, also known as  *Roll*
-   *
+   *  - c5 = rY; rotation around the Y-axis, also known as *Pitch*
    *
-   *  - c5 = rY; rotation around the Y-axis, also known as  *Pitch*
+   *  - c6 = rZ; rotation around the Z-axis. also known as *Yaw*
    *
    *
-   *  - c6 = rZ; rotation around the Z-axis. also known as  *Yaw*
-   *   Rotation angles are measured according to the  *right-hand rule:*  if the right hand "holds" an axis with the thumb pointing in the direction of ascending coordinate values, then the fingers point in the direction of ascending angle values. For GPS systems, these axes shall be interpreted as follows:
+   * Rotation angles are measured according to the *right-hand rule:* if the
+   * right hand "holds" an axis with the thumb pointing in the direction of
+   * ascending coordinate values, then the fingers point in the direction of
+   * ascending angle values. For GPS systems, these axes shall be interpreted as
+   * follows:
    *
    *  - c1 = longitude
    *
-   *
    *  - c2 = latitude
    *
-   *
    *  - c3 = altitude
    *
-   *
    *  - c4 : not used
    *
-   *
    *  - c5 : not used
    *
-   *
    *  - c6 : not used
    *
+   *
    * @class OcaPositionDescriptor
    */
   constructor(
     CoordinateSystem: OcaPositionCoordinateSystem,
-    FieldFlags: number,
+    FieldFlags: OcaPositionDescriptorFieldFlags,
     Values: number
   );
 
@@ -82,9 +83,9 @@ export declare class OcaPositionDescriptor implements IOcaPositionDescriptor {
 
   /**
    * Which fields of the Values[] array contain valid values.
-   * @type number
+   * @type OcaPositionDescriptorFieldFlags
    */
-  FieldFlags: number;
+  FieldFlags: OcaPositionDescriptorFieldFlags;
 
   /**
    * The coordinates

package/src/types/OcaPositionDescriptor.js

@@ -4,43 +4,41 @@
 
 export class OcaPositionDescriptor {
   /**
-   * A six-axis c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these axes shall be interpreted as follows:
+   * A six-axis c1,c2,c3,c4,c5,c6) coordinate. For mechanical systems, these
+   * axes shall be interpreted as follows:
    *
    *  - c1 = X; axial (fore-and-aft) position
    *
-   *
    *  - c2 = Y; lateral (side-to-side) position
    *
-   *
    *  - c3 = Z; vertical position
    *
+   *  - c4 = rX; rotation around the X-axis, also known as *Roll*
    *
-   *  - c4 = rX; rotation around the X-axis, also known as  *Roll*
-   *
+   *  - c5 = rY; rotation around the Y-axis, also known as *Pitch*
    *
-   *  - c5 = rY; rotation around the Y-axis, also known as  *Pitch*
+   *  - c6 = rZ; rotation around the Z-axis. also known as *Yaw*
    *
    *
-   *  - c6 = rZ; rotation around the Z-axis. also known as  *Yaw*
-   *   Rotation angles are measured according to the  *right-hand rule:*  if the right hand "holds" an axis with the thumb pointing in the direction of ascending coordinate values, then the fingers point in the direction of ascending angle values. For GPS systems, these axes shall be interpreted as follows:
+   * Rotation angles are measured according to the *right-hand rule:* if the
+   * right hand "holds" an axis with the thumb pointing in the direction of
+   * ascending coordinate values, then the fingers point in the direction of
+   * ascending angle values. For GPS systems, these axes shall be interpreted as
+   * follows:
    *
    *  - c1 = longitude
    *
-   *
    *  - c2 = latitude
    *
-   *
    *  - c3 = altitude
    *
-   *
    *  - c4 : not used
    *
-   *
    *  - c5 : not used
    *
-   *
    *  - c6 : not used
    *
+   *
    * @class OcaPositionDescriptor
    */
   constructor(CoordinateSystem, FieldFlags, Values) {
@@ -51,7 +49,7 @@ export class OcaPositionDescriptor {
     this.CoordinateSystem = CoordinateSystem;
     /**
      * Which fields of the Values[] array contain valid values.
-     * @type number
+     * @type OcaPositionDescriptorFieldFlags
      */
     this.FieldFlags = FieldFlags;
     /**

package/src/types/OcaPositionDescriptorFieldFlags.d.ts

@@ -0,0 +1,13 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * BItset that specifies which fields in **OcaPositionAndOrientation** are used.
+ * A "1" value signifies that the corresponding **OcaPositionAndOrientation**
+ * field is used.
+ * @enum {number}
+ * @readonly
+ */
+export declare const OcaPositionDescriptorFieldFlags: {};
+
+export declare type IOcaPositionDescriptorFieldFlags = number;

package/src/types/OcaPositionDescriptorFieldFlags.js

@@ -0,0 +1,11 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * BItset that specifies which fields in **OcaPositionAndOrientation** are used.
+ * A "1" value signifies that the corresponding **OcaPositionAndOrientation**
+ * field is used.
+ * @enum {number}
+ * @readonly
+ */
+export const OcaPositionDescriptorFieldFlags = {};

package/src/types/OcaPowerState.d.ts

@@ -2,7 +2,8 @@
  * This file has been generated.
  */
 /**
- * Enumeration defining the power states that OCA devices can be in. The state is returned by the device's Power Manager on request.
+ * Enumeration defining the power states that OCA devices can be in. The state
+ * is returned by the device's Power Manager on request.
  * @class OcaPowerState
  */
 export class OcaPowerState {

package/src/types/OcaPowerState.js

@@ -4,7 +4,8 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration defining the power states that OCA devices can be in. The state is returned by the device's Power Manager on request.
+ * Enumeration defining the power states that OCA devices can be in. The state
+ * is returned by the device's Power Manager on request.
  * @class OcaPowerState
  */
 export class OcaPowerState extends Enum({

package/src/types/OcaPresentationUnit.d.ts

@@ -2,7 +2,14 @@
  * This file has been generated.
  */
 /**
- * Enumeration of presentation units that can be used in OCA classes. Property values of OCA objects are always in SI units (unless explicitly documented otherwise), but the presentation unit can also be stored to indicate in which unit the value was presented in a user interface. This way another controller can also present it in that unit (i.e. doing a conversion on the controller before presenting it) to keep the user presentation uniform. Note that the presentation unit may be equal to the unit of the property (in which case of course no conversion is needed).
+ * Enumeration of presentation units that can be used in OCA classes. Property
+ * values of OCA objects are always in SI units (unless explicitly documented
+ * otherwise), but the presentation unit can also be stored to indicate in which
+ * unit the value was presented in a user interface. This way another controller
+ * can also present it in that unit (i.e. doing a conversion on the controller
+ * before presenting it) to keep the user presentation uniform. Note that the
+ * presentation unit may be equal to the unit of the property (in which case of
+ * course no conversion is needed).
  * @class OcaPresentationUnit
  */
 export class OcaPresentationUnit {

package/src/types/OcaPresentationUnit.js

@@ -4,7 +4,14 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration of presentation units that can be used in OCA classes. Property values of OCA objects are always in SI units (unless explicitly documented otherwise), but the presentation unit can also be stored to indicate in which unit the value was presented in a user interface. This way another controller can also present it in that unit (i.e. doing a conversion on the controller before presenting it) to keep the user presentation uniform. Note that the presentation unit may be equal to the unit of the property (in which case of course no conversion is needed).
+ * Enumeration of presentation units that can be used in OCA classes. Property
+ * values of OCA objects are always in SI units (unless explicitly documented
+ * otherwise), but the presentation unit can also be stored to indicate in which
+ * unit the value was presented in a user interface. This way another controller
+ * can also present it in that unit (i.e. doing a conversion on the controller
+ * before presenting it) to keep the user presentation uniform. Note that the
+ * presentation unit may be equal to the unit of the property (in which case of
+ * course no conversion is needed).
  * @class OcaPresentationUnit
  */
 export class OcaPresentationUnit extends Enum({

package/src/types/OcaProperty.d.ts

@@ -1,10 +1,9 @@
 /*
  * This file has been generated.
  */
-
 import {
-  OcaPropertyDescriptor,
   IOcaPropertyDescriptor,
+  OcaPropertyDescriptor,
 } from './OcaPropertyDescriptor';
 
 export declare interface IOcaProperty {
@@ -23,7 +22,8 @@ export declare interface IOcaProperty {
 
 export declare class OcaProperty implements IOcaProperty {
   /**
-   * Template for complete identification of an OCA property instance, including object number, property ID, Get and Set method IDs, and datatype.
+   * Template for complete identification of an OCA property instance, including
+   * object number, property ID, Get and Set method IDs, and datatype.
    * @class OcaProperty
    */
   constructor(ONo: number, Descriptor: OcaPropertyDescriptor);

package/src/types/OcaProperty.js

@@ -4,7 +4,8 @@
 
 export class OcaProperty {
   /**
-   * Template for complete identification of an OCA property instance, including object number, property ID, Get and Set method IDs, and datatype.
+   * Template for complete identification of an OCA property instance, including
+   * object number, property ID, Get and Set method IDs, and datatype.
    * @class OcaProperty
    */
   constructor(ONo, Descriptor) {

package/src/types/OcaPropertyDescriptor.d.ts

@@ -1,20 +1,19 @@
 /*
  * This file has been generated.
  */
-
-import { OcaBaseDataType, IOcaBaseDataType } from './OcaBaseDataType';
-import { OcaMethodID, IOcaMethodID } from './OcaMethodID';
-import { OcaPropertyID, IOcaPropertyID } from './OcaPropertyID';
+import { IOcaBaseDataType, OcaBaseDataType } from './OcaBaseDataType';
+import { IOcaMethodID, OcaMethodID } from './OcaMethodID';
+import { IOcaPropertyID, OcaPropertyID } from './OcaPropertyID';
 
 export declare interface IOcaPropertyDescriptor {
   /**
-   * This was not documented in the OCA standard.
    * @type OcaPropertyID
    */
   PropertyID: IOcaPropertyID;
 
   /**
-   * The base datatype of the property. Chosen from an enum datatype that represents the available set of basedatatypes **.**
+   * The base datatype of the property. Chosen from an enum datatype that
+   * represents the available set of basedatatypes**.**
    * @type OcaBaseDataType
    */
   BaseDataType: IOcaBaseDataType;
@@ -34,7 +33,8 @@ export declare interface IOcaPropertyDescriptor {
 
 export declare class OcaPropertyDescriptor implements IOcaPropertyDescriptor {
   /**
-   * Description of an OCA property, including property ID, Get and Set method IDs, and datatype.
+   * Description of an OCA property, including property ID, Get and Set method
+   * IDs, and datatype.
    * @class OcaPropertyDescriptor
    */
   constructor(
@@ -45,13 +45,13 @@ export declare class OcaPropertyDescriptor implements IOcaPropertyDescriptor {
   );
 
   /**
-   * This was not documented in the OCA standard.
    * @type OcaPropertyID
    */
   PropertyID: OcaPropertyID;
 
   /**
-   * The base datatype of the property. Chosen from an enum datatype that represents the available set of basedatatypes **.**
+   * The base datatype of the property. Chosen from an enum datatype that
+   * represents the available set of basedatatypes**.**
    * @type OcaBaseDataType
    */
   BaseDataType: OcaBaseDataType;

package/src/types/OcaPropertyDescriptor.js

@@ -4,17 +4,18 @@
 
 export class OcaPropertyDescriptor {
   /**
-   * Description of an OCA property, including property ID, Get and Set method IDs, and datatype.
+   * Description of an OCA property, including property ID, Get and Set method
+   * IDs, and datatype.
    * @class OcaPropertyDescriptor
    */
   constructor(PropertyID, BaseDataType, GetterMethodID, SetterMethodID) {
     /**
-     * This was not documented in the OCA standard.
      * @type OcaPropertyID
      */
     this.PropertyID = PropertyID;
     /**
-     * The base datatype of the property. Chosen from an enum datatype that represents the available set of basedatatypes **.**
+     * The base datatype of the property. Chosen from an enum datatype that
+     * represents the available set of basedatatypes**.**
      * @type OcaBaseDataType
      */
     this.BaseDataType = BaseDataType;

package/src/types/OcaPropertyID.d.ts

@@ -18,7 +18,9 @@ export declare interface IOcaPropertyID {
 
 export declare class OcaPropertyID implements IOcaPropertyID {
   /**
-   * Representation of an OCA property ID. A class may define at most 255 properties of its own. Additional properties may be inherited, so the total number may exceed 255.
+   * Representation of an OCA property ID. A class may define at most 255
+   * properties of its own. Additional properties may be inherited, so the total
+   * number may exceed 255.
    * @class OcaPropertyID
    */
   constructor(DefLevel: number, PropertyIndex: number);

package/src/types/OcaPropertyID.js

@@ -4,7 +4,9 @@
 
 export class OcaPropertyID {
   /**
-   * Representation of an OCA property ID. A class may define at most 255 properties of its own. Additional properties may be inherited, so the total number may exceed 255.
+   * Representation of an OCA property ID. A class may define at most 255
+   * properties of its own. Additional properties may be inherited, so the total
+   * number may exceed 255.
    * @class OcaPropertyID
    */
   constructor(DefLevel, PropertyIndex) {

package/src/types/OcaProtoObjectIdentification.d.ts

@@ -1,10 +1,9 @@
 /*
  * This file has been generated.
  */
-
 import {
-  OcaClassIdentification,
   IOcaClassIdentification,
+  OcaClassIdentification,
 } from './OcaClassIdentification';
 
 export declare interface IOcaProtoObjectIdentification {
@@ -24,7 +23,8 @@ export declare interface IOcaProtoObjectIdentification {
 export declare class OcaProtoObjectIdentification
   implements IOcaProtoObjectIdentification {
   /**
-   * Prototype object identification. Composite of prototype object number and prototype object's class identification. Used in  **OcaBlockFactory** .
+   * Prototype object identification. Composite of prototype object number and
+   * prototype object's class identification. Used in **OcaBlockFactory**.
    * @class OcaProtoObjectIdentification
    */
   constructor(POno: number, ClassIdentification: OcaClassIdentification);

package/src/types/OcaProtoObjectIdentification.js

@@ -4,7 +4,8 @@
 
 export class OcaProtoObjectIdentification {
   /**
-   * Prototype object identification. Composite of prototype object number and prototype object's class identification. Used in  **OcaBlockFactory** .
+   * Prototype object identification. Composite of prototype object number and
+   * prototype object's class identification. Used in **OcaBlockFactory**.
    * @class OcaProtoObjectIdentification
    */
   constructor(POno, ClassIdentification) {

package/src/types/OcaProtoPort.d.ts

@@ -1,12 +1,13 @@
 /*
  * This file has been generated.
  */
-
-import { OcaProtoPortID, IOcaProtoPortID } from './OcaProtoPortID';
+import { IOcaProtoPortID, OcaProtoPortID } from './OcaProtoPortID';
 
 export declare interface IOcaProtoPort {
   /**
-   * Proto-object number of the proto-member that owns the proto-port.  **The value of 0 (zero) is special, and refers to the block itself, rather than to any of its members.**
+   * Proto-object number of the proto-member that owns the proto-port. **The
+   * value of 0 (zero) is special, and refers to the block itself, rather than
+   * to any of its members.**
    * @type number
    */
   Owner: number;
@@ -26,13 +27,16 @@ export declare interface IOcaProtoPort {
 
 export declare class OcaProtoPort implements IOcaProtoPort {
   /**
-   * Representation of an OCA (input or output) proto-port that is used in the proto-signal path representation of an OCA device.
+   * Representation of an OCA (input or output) proto-port that is used in the
+   * proto-signal path representation of an OCA device.
    * @class OcaProtoPort
    */
   constructor(Owner: number, ProtoID: OcaProtoPortID, Name: string);
 
   /**
-   * Proto-object number of the proto-member that owns the proto-port.  **The value of 0 (zero) is special, and refers to the block itself, rather than to any of its members.**
+   * Proto-object number of the proto-member that owns the proto-port. **The
+   * value of 0 (zero) is special, and refers to the block itself, rather than
+   * to any of its members.**
    * @type number
    */
   Owner: number;

package/src/types/OcaProtoPort.js

@@ -4,12 +4,15 @@
 
 export class OcaProtoPort {
   /**
-   * Representation of an OCA (input or output) proto-port that is used in the proto-signal path representation of an OCA device.
+   * Representation of an OCA (input or output) proto-port that is used in the
+   * proto-signal path representation of an OCA device.
    * @class OcaProtoPort
    */
   constructor(Owner, ProtoID, Name) {
     /**
-     * Proto-object number of the proto-member that owns the proto-port.  **The value of 0 (zero) is special, and refers to the block itself, rather than to any of its members.**
+     * Proto-object number of the proto-member that owns the proto-port. **The
+     * value of 0 (zero) is special, and refers to the block itself, rather than
+     * to any of its members.**
      * @type number
      */
     this.Owner = Owner;

package/src/types/OcaProtoPortID.d.ts

@@ -1,8 +1,7 @@
 /*
  * This file has been generated.
  */
-
-import { OcaPortMode, IOcaPortMode } from './OcaPortMode';
+import { IOcaPortMode, OcaPortMode } from './OcaPortMode';
 
 export declare interface IOcaProtoPortID {
   /**
@@ -20,7 +19,9 @@ export declare interface IOcaProtoPortID {
 
 export declare class OcaProtoPortID implements IOcaProtoPortID {
   /**
-   * Unique identifier of prototype input or output port within a block factory. Prototype port numbers are ordinals starting at 1, and there are separate numbering spaces for input and output ports.
+   * Unique identifier of prototype input or output port within a block factory.
+   * Prototype port numbers are ordinals starting at 1, and there are separate
+   * numbering spaces for input and output ports.
    * @class OcaProtoPortID
    */
   constructor(Mode: OcaPortMode, Index: number);

package/src/types/OcaProtoPortID.js

@@ -4,7 +4,9 @@
 
 export class OcaProtoPortID {
   /**
-   * Unique identifier of prototype input or output port within a block factory. Prototype port numbers are ordinals starting at 1, and there are separate numbering spaces for input and output ports.
+   * Unique identifier of prototype input or output port within a block factory.
+   * Prototype port numbers are ordinals starting at 1, and there are separate
+   * numbering spaces for input and output ports.
    * @class OcaProtoPortID
    */
   constructor(Mode, Index) {

package/src/types/OcaProtoSignalPath.d.ts

@@ -1,8 +1,7 @@
 /*
  * This file has been generated.
  */
-
-import { OcaProtoPort, IOcaProtoPort } from './OcaProtoPort';
+import { IOcaProtoPort, OcaProtoPort } from './OcaProtoPort';
 
 export declare interface IOcaProtoSignalPath {
   /**

package/src/types/OcaRamperCommand.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Command repertoire of OcaRamper's  **Control** method.
+ * Command repertoire of OcaRamper's **Control** method.
  * @class OcaRamperCommand
  */
 export class OcaRamperCommand {

package/src/types/OcaRamperCommand.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * Command repertoire of OcaRamper's  **Control** method.
+ * Command repertoire of OcaRamper's **Control** method.
  * @class OcaRamperCommand
  */
 export class OcaRamperCommand extends Enum({

package/src/types/OcaRamperState.d.ts

@@ -4,22 +4,27 @@
 /**
  * States of the ramper. Here are the rules for ramper state change:
  *
- *  - A freshly-constructed ramper's state is  **NotInitialized** .
+ *  - A freshly-constructed ramper's state is **NotInitialized**.
  *
+ *  - A ramper becomes **Initialized** when : The ramper is **NotInitialized**;
+ *    AND ** TargetProperty** has been set to a valid value; AND ** Goal** has
+ *    been set; AND ** Duration** has been set.
  *
- *  - A ramper becomes  **Initialized**  when : The ramper is  **NotInitialized** ; AND  **TargetProperty**  has been set to a valid value; AND  **Goal**  has been set; AND  **Duration**  has been set.
+ *  - A ramper becomes **Scheduled** when It is **Initialized**; AND
+ *    **T****start** and **TimeMode** have been set; AND (T :sub:`start` +
+ *    **Duration**) is in the future.
  *
+ *  - A ramper becomes **Enabled** when it is **Scheduled** AND receives an
+ *    *Enable* command.
  *
- *  - A ramper becomes  **Scheduled**  when It is  **Initialized** ; AND  **T**  **start**  and  **TimeMode**  have been set; AND (Tstart +  **Duration** ) is in the future.
+ *  - A ramper becomes **Ramping** when: It is **Enabled** and the ramp start
+ *    time is reached; OR It is **Initialized**, **Scheduled**, or **Enabled**
+ *    and a *Start* command is received.
  *
+ *  - Completion of a ramp or Receipt of a *Halt* command causes the state to
+ *    become: **Scheduled**, if T :sub:`start`, Time Mode have been set; AND (T
+ *    :sub:`start` + Duration) is in the future. Otherwise, **Initialized.**
  *
- *  - A ramper becomes  **Enabled**  when it is  **Scheduled**  AND receives an  *Enable* command.
- *
- *
- *  - A ramper becomes  **Ramping**  when: It is  **Enabled**  and the ramp start time is reached; OR It is  **Initialized** ,  **Scheduled** , or  **Enabled**  and a  *Start*  command is received.
- *
- *
- *  - Completion of a ramp or Receipt of a  *Halt*  command causes the state to become:  **Scheduled** , if Tstart, Time Mode have been set; AND (Tstart + Duration) is in the future. Otherwise,  **Initialized.**
  *
  * @class OcaRamperState
  */

package/src/types/OcaRamperState.js

@@ -6,22 +6,27 @@ import { Enum } from './Enum.js';
 /**
  * States of the ramper. Here are the rules for ramper state change:
  *
- *  - A freshly-constructed ramper's state is  **NotInitialized** .
+ *  - A freshly-constructed ramper's state is **NotInitialized**.
  *
+ *  - A ramper becomes **Initialized** when : The ramper is **NotInitialized**;
+ *    AND ** TargetProperty** has been set to a valid value; AND ** Goal** has
+ *    been set; AND ** Duration** has been set.
  *
- *  - A ramper becomes  **Initialized**  when : The ramper is  **NotInitialized** ; AND  **TargetProperty**  has been set to a valid value; AND  **Goal**  has been set; AND  **Duration**  has been set.
+ *  - A ramper becomes **Scheduled** when It is **Initialized**; AND
+ *    **T****start** and **TimeMode** have been set; AND (T :sub:`start` +
+ *    **Duration**) is in the future.
  *
+ *  - A ramper becomes **Enabled** when it is **Scheduled** AND receives an
+ *    *Enable* command.
  *
- *  - A ramper becomes  **Scheduled**  when It is  **Initialized** ; AND  **T**  **start**  and  **TimeMode**  have been set; AND (Tstart +  **Duration** ) is in the future.
+ *  - A ramper becomes **Ramping** when: It is **Enabled** and the ramp start
+ *    time is reached; OR It is **Initialized**, **Scheduled**, or **Enabled**
+ *    and a *Start* command is received.
  *
+ *  - Completion of a ramp or Receipt of a *Halt* command causes the state to
+ *    become: **Scheduled**, if T :sub:`start`, Time Mode have been set; AND (T
+ *    :sub:`start` + Duration) is in the future. Otherwise, **Initialized.**
  *
- *  - A ramper becomes  **Enabled**  when it is  **Scheduled**  AND receives an  *Enable* command.
- *
- *
- *  - A ramper becomes  **Ramping**  when: It is  **Enabled**  and the ramp start time is reached; OR It is  **Initialized** ,  **Scheduled** , or  **Enabled**  and a  *Start*  command is received.
- *
- *
- *  - Completion of a ramp or Receipt of a  *Halt*  command causes the state to become:  **Scheduled** , if Tstart, Time Mode have been set; AND (Tstart + Duration) is in the future. Otherwise,  **Initialized.**
  *
  * @class OcaRamperState
  */

package/src/types/OcaSensorReadingState.d.ts

@@ -2,7 +2,8 @@
  * This file has been generated.
  */
 /**
- * Enum that describes whether an  **OcaSensor** 's current reading value can be trusted, and if not, why not.
+ * Enum that describes whether an **OcaSensor**'s current reading value can be
+ * trusted, and if not, why not.
  * @class OcaSensorReadingState
  */
 export class OcaSensorReadingState {