Interface SimDomain

Radial simulation domain [inner, outer].

interface SimDomain {
    inner: number;
    outer: number;
    clear(): void;
    isEmpty(): boolean;
    isValid(): boolean;
    middle(): number;
    range(): number;
}

Index

Methods

clear isEmpty isValid middle range

Properties

Methods

clear

clear(): void
Sets inner and outer to zero.

Returns void
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:7689

isEmpty

isEmpty(): boolean
True if inner and outer are equal.

Returns boolean
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:7677

isValid

isValid(): boolean
True if inner is less than outer.

Returns boolean
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:7683

middle

middle(): number
Domain midpoint: (inner + outer) / 2.

Returns number
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:7701

range

range(): number
Domain width: outer - inner.

Returns number
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:7695

Properties

inner

inner: number

Inner radius of the domain.

Access

Read/Write

outer

outer: number

Outer radius of the domain.

Access

Read/Write