fixedWingState

Define fixed-wing aircraft state

Since R2021b

Syntax

state = fixedWingState(aircraft)

state = fixedWingState(aircraft,environment)

state = fixedWingState(___,Name=Value)

Description

state = fixedWingState(aircraft) returns a fixed-wing state object created from a fixed-wing aircraft, aircraft, using a default environment.

state = fixedWingState(aircraft,environment) returns a fixed-wing state object using a specified environment, environment.

state = fixedWingState(___,Name=Value) returns a fixed-wing state object with an environment defined by Name=Value arguments.

Examples

Create Fixed-Wing Aircraft State Object and Default Environment

Create a fixed-wing aircraft state object from a fixed-wing aircraft object

aircraft = astC182();
state = fixedWingState(aircraft)

state = 
  State with properties:

                    Alpha: 0
                     Beta: 0
                 AlphaDot: 0
                  BetaDot: 0
                     Mass: 0
                  Inertia: [3×3 table]
          CenterOfGravity: [0 0 0]
         CenterOfPressure: [0 0 0]
              AltitudeMSL: 0
             GroundHeight: 0
                       XN: 0
                       XE: 0
                       XD: 0
                        U: 50
                        V: 0
                        W: 0
                      Phi: 0
                    Theta: 0
                      Psi: 0
                        P: 0
                        Q: 0
                        R: 0
                   Weight: 0
              AltitudeAGL: 0
                 Airspeed: 50
              GroundSpeed: 50
               MachNumber: 0.0448
             BodyVelocity: [50 0 0]
           GroundVelocity: [50 0 0]
                       Ur: 50
                       Vr: 0
                       Wr: 0
          FlightPathAngle: 0
              CourseAngle: 0
     InertialToBodyMatrix: [3×3 double]
     BodyToInertialMatrix: [3×3 double]
         BodyToWindMatrix: [3×3 double]
         WindToBodyMatrix: [3×3 double]
    BodyToStabilityMatrix: [3×3 double]
    StabilityToBodyMatrix: [3×3 double]
          DynamicPressure: 2.9711
              Environment: [1×1 Aero.Aircraft.Environment]
            ControlStates: [1×4 Aero.Aircraft.ControlState]
         OutOfRangeAction: "Limit"
         DiagnosticAction: "Warning"
               Properties: [1×1 Aero.Aircraft.Properties]
               UnitSystem: "English (ft/s)"
        TemperatureSystem: "Fahrenheit"
              AngleSystem: "Radians"

Create Fixed-Wing Aircraft State Object from Fixed-Wing Aircraft Object and Mass

Create a fixed-wing aircraft state object from a fixed-wing aircraft object and specify the mass using positional arguments.

aircraft = astC182();
state = fixedWingState(aircraft,"Mass",500)

state = 
  State with properties:

                    Alpha: 0
                     Beta: 0
                 AlphaDot: 0
                  BetaDot: 0
                     Mass: 500
                  Inertia: [3×3 table]
          CenterOfGravity: [0 0 0]
         CenterOfPressure: [0 0 0]
              AltitudeMSL: 0
             GroundHeight: 0
                       XN: 0
                       XE: 0
                       XD: 0
                        U: 50
                        V: 0
                        W: 0
                      Phi: 0
                    Theta: 0
                      Psi: 0
                        P: 0
                        Q: 0
                        R: 0
                   Weight: 1.6093e+04
              AltitudeAGL: 0
                 Airspeed: 50
              GroundSpeed: 50
               MachNumber: 0.0448
             BodyVelocity: [50 0 0]
           GroundVelocity: [50 0 0]
                       Ur: 50
                       Vr: 0
                       Wr: 0
          FlightPathAngle: 0
              CourseAngle: 0
     InertialToBodyMatrix: [3×3 double]
     BodyToInertialMatrix: [3×3 double]
         BodyToWindMatrix: [3×3 double]
         WindToBodyMatrix: [3×3 double]
    BodyToStabilityMatrix: [3×3 double]
    StabilityToBodyMatrix: [3×3 double]
          DynamicPressure: 2.9711
              Environment: [1×1 Aero.Aircraft.Environment]
            ControlStates: [1×4 Aero.Aircraft.ControlState]
         OutOfRangeAction: "Limit"
         DiagnosticAction: "Warning"
               Properties: [1×1 Aero.Aircraft.Properties]
               UnitSystem: "English (ft/s)"
        TemperatureSystem: "Fahrenheit"
              AngleSystem: "Radians"

Create Fixed-Wing Aircraft State Object and Custom Environment

Create a fixed-wing aircraft state object from a fixed-wing aircraft object using a custom environment and Name=Value arguments.

aircraft = astC182();
state = fixedWingState(aircraft,aircraftEnvironment(aircraft,"COESA",1000))

state = 
  State with properties:

                    Alpha: 0
                     Beta: 0
                 AlphaDot: 0
                  BetaDot: 0
                     Mass: 0
                  Inertia: [3×3 table]
          CenterOfGravity: [0 0 0]
         CenterOfPressure: [0 0 0]
              AltitudeMSL: 0
             GroundHeight: 0
                       XN: 0
                       XE: 0
                       XD: 0
                        U: 50
                        V: 0
                        W: 0
                      Phi: 0
                    Theta: 0
                      Psi: 0
                        P: 0
                        Q: 0
                        R: 0
                   Weight: 0
              AltitudeAGL: 0
                 Airspeed: 50
              GroundSpeed: 50
               MachNumber: 0.0449
             BodyVelocity: [50 0 0]
           GroundVelocity: [50 0 0]
                       Ur: 50
                       Vr: 0
                       Wr: 0
          FlightPathAngle: 0
              CourseAngle: 0
     InertialToBodyMatrix: [3×3 double]
     BodyToInertialMatrix: [3×3 double]
         BodyToWindMatrix: [3×3 double]
         WindToBodyMatrix: [3×3 double]
    BodyToStabilityMatrix: [3×3 double]
    StabilityToBodyMatrix: [3×3 double]
          DynamicPressure: 2.8851
              Environment: [1×1 Aero.Aircraft.Environment]
            ControlStates: [1×4 Aero.Aircraft.ControlState]
         OutOfRangeAction: "Limit"
         DiagnosticAction: "Warning"
               Properties: [1×1 Aero.Aircraft.Properties]
               UnitSystem: "English (ft/s)"
        TemperatureSystem: "Fahrenheit"
              AngleSystem: "Radians"

Input Arguments

aircraft — Fixed-wing aircraft object

scalar

Fixed-wing aircraft object, specified as a scalar.

environment — Fixed-wing aircraft environment name

aircraftEnvironment(aircraft, "ISA", 0) (default) | scalar string

Fixed-wing aircraft environment name, specified as a scalar string.

Tip

This argument also exists as the name-value argument Environment. If you specify the Environment name-value argument, its value supersedes the environment positional argument.

Data Types: string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: "Mass",500

UnitSystem — Unit system

'Metric' (default) | 'English (kts)' | 'English (ft/s)'

Unit system, specified as 'Metric', 'English (kts)', 'English (ft/s)'.

AngleSystem — Angle system

'Radians' (default) | 'Degrees'

Angle system, specified as 'Radians' or 'Degrees'.

TemperatureSystem — Temperature system

'Kelvin' (default) | 'Celsius' | 'Rankine' | 'Fahrenheit'

Temperature system, specified as 'Kelvin', 'Celsius', 'Rankine', or 'Fahrenheit'.

Mass — Fixed-wing aircraft mass

0 (default) | scalar numeric

Fixed-wing aircraft mass, specified as a scalar numeric in these units.

Unit	Unit System
newtons (N)	'Metric'
slugs (slug)	'English (kts)' and 'English (ft/s)'

Data Types: double

Inertia — Inertial matrix of aircraft

3-by-3 table of numeric values (default) | scalar numeric

Inertial matrix of aircraft, specified as a 3-by-3 table of numeric values specifying the body in this matrix form.

	X	Y	Z
X	Ixx	Ixy	Ixz
Y	Iyx	Iyy	Iyz
Z	Izx	Izy	Izz

The matrix has these units.

Unit	Unit System
kilogram meters squared (kg m^2)	'Metric'
slug feet squared (slug ft^2)	'English (kts)' and 'English (ft/s)'

Data Types: double

CenterOfGravity — Location of center of gravity

[0, 0, 0] (default) | three-element vector

Location of center of gravity on fixed-wing aircraft in body frame, specified as a three-element vector in these units.

Unit	Unit System
Meters (m)	'Metric'
Feet (ft)	'English (kts)' and 'English (ft/s)'

Data Types: double

CenterOfPressure — Location of center of pressure

[0, 0, 0] (default) | three-element vector

Location of center of pressure on fixed-wing aircraft in body frame, specified as a three-element vector in these units.

Unit	Unit System
Meters (m)	'Metric'
Feet (ft)	'English (kts)' and 'English (ft/s)'

Data Types: double

AltitudeMSL — Altitude above sea level

0 (default) | scalar numeric

Altitude above sea level, specified as a scalar numeric in these units.

Unit	Unit System
Meters (m)	'Metric'
Feet (ft)	'English (kts)' and 'English (ft/s)'

Data Types: double

GroundHeight — Ground height above sea level

0 (default) | scalar numeric

Ground height above sea level, specified as a scalar numeric in these units.

Unit	Unit System
Meters (m)	'Metric'
Feet (ft)	'English (kts)' and 'English (ft/s)'

Data Types: double

XN — North position of fixed-wing aircraft

0 (default) | scalar numeric

North position of fixed-wing aircraft, specified as a scalar numeric in these units.

Unit	Unit System
Meters (m)	'Metric'
Feet (ft)	'English (kts)' and 'English (ft/s)'

Data Types: double

XE — East position of fixed-wing aircraft

0 (default) | scalar numeric

East position of fixed-wing aircraft, specified as a scalar numeric in these units.

Unit	Unit System
Meters (m)	'Metric'
Feet (ft)	'English (kts)' and 'English (ft/s)'

Data Types: double

U — Forward component of ground velocity

50 (default) | scalar numeric

Forward component of ground velocity, specified as a scalar numeric in these units.

Unit	Unit System
Meters per second (m/s)	'Metric'
Feet per second (ft/s)	'English (kts)'
Knots (kts)	'English (ft/s)'

Data Types: double

V — Side component of ground velocity

0 (default) | scalar numeric

Side component of ground velocity, specified as a scalar numeric in these units.

Unit	Unit System
Meters per second (m/s)	'Metric'
Feet per second (ft/s)	'English (kts)'
Knots (kts)	'English (ft/s)'

Data Types: double

W — Downward component of ground velocity

0 (default) | scalar numeric

Downward component of ground velocity, specified as a scalar numeric in these units.

Unit	Unit System
Meters per second (m/s)	'Metric'
Feet per second (ft/s)	'English (kts)'
Knots (kts)	'English (ft/s)'

Data Types: double

Phi — Euler roll angle

0 (default) | scalar numeric

Euler roll angle, specified as a scalar numeric in units of radians or degrees, depending on the AngleSystem property.

Data Types: double

Theta — Euler pitch angle

0 (default) | scalar numeric

Euler pitch angle, specified as a scalar numeric in units of radians or degrees, depending on the AngleSystem property.

Data Types: double

Psi — Euler yaw angle

0 (default) | scalar numeric

Euler yaw angle, specified as a scalar numeric in units of radians or degrees, depending on the AngleSystem property.

Data Types: double

P — Body roll rate

0 (default) | scalar numeric

Body roll rate, specified as a scalar numeric in units of radians per second or degrees per second, depending on the AngleSystem property.

Data Types: double

Q — Body pitch rate

0 (default) | scalar numeric

Body pitch rate, specified as a scalar numeric in units of radians per second or degrees per second, depending on the AngleSystem property.

Data Types: double

R — Body yaw rate

0 (default) | scalar numeric

Body yaw rate, specified as a scalar numeric in units of radians per second or degrees per second, depending on the AngleSystem property.

Data Types: double

AlphaDot — Angle of attack rate on fixed-wing aircraft

0 (default) | scalar numeric

Angle of attack rate on fixed-wing aircraft, specified as a scalar numeric in units of radians per second or degrees per second, depending on the AngleSystem property.

Data Types: double

BetaDot — Angle of sideslip rate on fixed-wing aircraft

0 (default) | scalar numeric

Angle of sideslip rate on the fixed-wing aircraft, specified as a scalar numeric in units of radians per second or degrees per second, depending on the AngleSystem property.

Data Types: double

ControlStates — Current control state values

vector

Current control state values, specified as a vector.

• To set up control states, use setupControlStates.

• To set the control state positions, use setState.

• To get the control state positions, use getState.

Data Types: double

Environment — Definition of current environment

scalar

Definition of current environment, contained in an Aero.Aircraft.Environment object, specified as a scalar.

Tip

This argument also exists as the environment positional argument. If you specify the Environment name-value argument, its value supersedes the environment positional argument.

Output Arguments

state — Aero.FixedWing.State objects

matrix

Aero.FixedWing.State objects, returned as a matrix the same size as environment.

Version History

Introduced in R2021b