Main Content

fixedWingState

Define fixed-wing aircraft state at time instant

    Description

    example

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

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

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

    Examples

    collapse all

    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]
             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)"
                 AngleSystem: "Radians"
           TemperatureSystem: "Fahrenheit"

    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]
             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)"
                 AngleSystem: "Radians"
           TemperatureSystem: "Fahrenheit"

    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]
             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)"
                 AngleSystem: "Radians"
           TemperatureSystem: "Fahrenheit"

    Input Arguments

    collapse all

    Fixed-wing aircraft object, specified as a scalar.

    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 comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

    Example: "Mass",500

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

    Data Types: string | char

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

    Data Types: string | char

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

    Data Types: string | char

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

    UnitUnit System

    newtons (N)

    'Metric'

    slugs (slug)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

     XYZ
    XIxxIxyIxz
    YIyxIyyIyz
    ZIzxIzyIzz

    The matrix has these units.

    UnitUnit System

    kilogram meters squared (kg m^2)

    'Metric'

    slug feet squared (slug ft^2)

    'English (kts)' and 'English (ft/s)'

    Data Types: string | char

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

    UnitUnit System

    Meters (m)

    'Metric'

    Feet (ft)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters (m)

    'Metric'

    Feet (ft)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters (m)

    'Metric'

    Feet (ft)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters (m)

    'Metric'

    Feet (ft)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters (m)

    'Metric'

    Feet (ft)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters (m)

    'Metric'

    Feet (ft)

    'English (kts)' and 'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters per second (m/s)

    'Metric'

    Feet per second (ft/s)

    'English (kts)'

    Knots (kts)

    'English (ft/s)'

    Data Types: double

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

    UnitUnit System

    Meters per second (m/s)

    'Metric'

    Feet per second (ft/s)

    'English (kts)'

    Knots (kts)

    'English (ft/s)'

    Data Types: string | char

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

    UnitUnit System

    Meters per second (m/s)

    'Metric'

    Feet per second (ft/s)

    'English (kts)'

    Knots (kts)

    'English (ft/s)'

    Data Types: double

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

    Data Types: double

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

    Data Types: double

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

    Data Types: double

    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

    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

    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

    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

    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

    Current control state values, specified as a vector.

    Data Types: double

    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

    collapse all

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

    Introduced in R2021b