Constants Object

 Top  Previous  Next

Description

The Constants object type has a number of static properties and methods on it to make it easier to access standard mathematical and physical constants used in space-based mission design. This object is not creatable in script.

 

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

 

Inheritance Hierarchy: Object->Constants

 

Available In Editions:

Engineer

Mission

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Properties

 

Name

Description

Attributes

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

DisplayName

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

 
 

 

Methods

 

Name

Description

ClearSavedStates

Clears previous saved states for this object.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

PutToFile

Convert the object state to FreeFlyer object xml and write to a file.

PutToString

Convert the object state to FreeFlyer object xml and return as a string.

ReferenceEquals

Returns 1 if the argument refers to the calling object and 0 otherwise.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

 
 

 

Static Properties

 

Name

Description

Attributes

AU

Astronomical unit.

Type:   Variable

Access: Read-Only

Units:   km

Boltzmann

Boltzmann constant.

Type:   Variable

Access: Read-Only

Units:   km^2 kg/(s^2 Deg K)

c

Speed of light.

Type:   Variable

Access: Read-Only

Units:   km/s

e

Euler's number.

Type:   Variable

Access: Read-Only

G

Universal gravitational constant.

Type:   Variable

Access: Read-Only

Units:   km^3/(kg s^2)

GoldenRatio

Golden ratio.

Type:   Variable

Access: Read-Only

GravitationalConstant

Universal gravitational constant.

Type:   Variable

Access: Read-Only

Units:   km^3/(kg s^2)

h

Planck constant.

Type:   Variable

Access: Read-Only

Units:   km^2 kg/s

k

Boltzmann constant.

Type:   Variable

Access: Read-Only

Units:   km^2 kg/(s^2 Deg K)

Pi

Mathematical constant.

Type:   Variable

Access: Read-Only

Planck

Planck constant.

Type:   Variable

Access: Read-Only

Units:   km^2 kg/s

SolarConstant

The Solar Constant, also known as Mean Solar Flux, is the mean Total Solar Irradiance (TSI) at one AU (astronomical unit). Sometimes denoted as 'S' or 'Gsc', this parameter is used in Solar Radiation Pressure (SRP) force modeling.

Type:   Variable

Access: Read-Only

Units:   W/m^2

SpeedOfLight

Speed of light.

Type:   Variable

Access: Read-Only

Units:   km/s

StefanBoltzmann

Stefan-Boltzmann constant.

Type:   Variable

Access: Read-Only

Units:   W/(km^2 Deg K^4)

 
 

 

Static Methods

 

Name

Description

SetAU

Overrides the constant Astronomical Unit value.

SetSolarConstant

Overrides the constant Solar Constant value.

 
 

 

 

See also

Mathematical and Physical Constants Guide