Tank Object

 Top  Previous  Next

Description

The Tank object is a base type that provides center of gravity, moment of inertia, orientation, and reference point properties to the objects that derive from it.  See the Maneuvering Guide for more information.

 

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->Hardware->Tank

Derived Types: ChemicalTank, InterpolatedTank, SphericalTank, ElectricalTank

 

Available In Editions:

Engineer

Mission

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode.

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

 

Properties

 

Name

Description

Attributes

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

MOI

The tank moment of inertia tensor.

Type:   Matrix

Access: Read-Only

Units:   kg m^2

Name

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

TankCenterOfGravity

The center of gravity associated with the fuel mass in the tank. This location is determined based on the tank's reference location, fill line orientation, tank volume, fuel mass, and fuel density. The location is referenced from the origin of the Spacecraft BCS and is measured in meters.

Type:   Array

Access: Read-Only

Units:   m

TankOrientation

The unit vector in the Spacecraft body coordinate system that defines the primary axis (or z-axis) of the tank. The tank's fill line is oriented perpendicular to this axis. The tank's center of gravity is determined based on this fill line orientation, the tank reference location, tank volume, fuel mass, and fuel density.

Type:   Array

Access: Read/Write

TankReference

The geometric center of the tank. This location is referenced from the origin of the Spacecraft BCS. The tank's center of gravity is determined based on this reference location, the fill line orientation, tank volume, fuel mass, and fuel density.

Type:   Array

Access: Read/Write

Units:   m

 
 

 

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.

 
 

 

Deprecated Properties

 

Name

Description

Attributes

TankCOGX

The X-component of the center of gravity associated with the fuel mass in the tank. This location is determined based on the tank's reference location, fill line orientation, tank volume, fuel mass, and fuel density. The location is referenced from the origin of the Spacecraft BCS and is measured in meters.

 

This property has been Deprecated. Please use TankCenterOfGravity instead.

Type:   Variable

Access: Read/Write

Units:   m

TankCOGY

The Y-component of the center of gravity associated with the fuel mass in the tank. This location is determined based on the tank's reference location, fill line orientation, tank volume, fuel mass, and fuel density. The location is referenced from the origin of the Spacecraft BCS and is measured in meters.

 

This property has been Deprecated. Please use TankCenterOfGravity instead.

Type:   Variable

Access: Read/Write

Units:   m

TankCOGZ

The Z-component of the center of gravity associated with the fuel mass in the tank. This location is determined based on the tank's reference location, fill line orientation, tank volume, fuel mass, and fuel density. The location is referenced from the origin of the Spacecraft BCS and is measured in meters.

 

This property has been Deprecated. Please use TankCenterOfGravity instead.

Type:   Variable

Access: Read/Write

Units:   m

TankIXX

The IXX-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIXY

The IXY-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIXZ

The IXZ-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIYX

The IYX-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIYY

The IYY-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIYZ

The IYZ-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIZX

The IZX-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIZY

The IZY-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankIZZ

The IZZ-component of the moment of inertia matrix associated with the fuel mass in the Tank. The MOI is referenced from the origin of the Spacecraft BCS.

 

This property has been Deprecated. Please use Tank.MOI instead, using indices to access elements of the matrix.

Type:   Variable

Access: Read-Only

Units:   kg m^2

TankOrientX

The X-component of the unit vector in the Spacecraft body coordinate system that defines the primary axis (or z-axis) of the tank. The tank's fill line is oriented perpendicular to this axis. The tank's center of gravity is determined based on this fill line orientation, the tank reference location, tank volume, fuel mass, and fuel density.

 

This property has been Deprecated. Please use TankOrientation instead.

Type:   Variable

Access: Read/Write

TankOrientY

The Y-component of the unit vector in the Spacecraft body coordinate system that defines the primary axis (or z-axis) of the tank. The tank's fill line is oriented perpendicular to this axis. The tank's center of gravity is determined based on this fill line orientation, the tank reference location, tank volume, fuel mass, and fuel density.

 

This property has been Deprecated. Please use TankOrientation instead.

Type:   Variable

Access: Read/Write

TankOrientZ

The Z-component of the unit vector in the Spacecraft body coordinate system that defines the primary axis (or z-axis) of the tank. The tank's fill line is oriented perpendicular to this axis. The tank's center of gravity is determined based on this fill line orientation, the tank reference location, tank volume, fuel mass, and fuel density.

 

This property has been Deprecated. Please use TankOrientation instead.

Type:   Variable

Access: Read/Write

TankRefX

The X-component of the geometric center of the SphericalTank. This location is referenced from the origin of the Spacecraft BCS. The tank's center of gravity is determined based on this reference location, the fill line orientation, tank volume, fuel mass, and fuel density.

 

This property has been Deprecated. Please use TankReference instead.

Type:   Variable

Access: Read/Write

Units:   m

TankRefY

The Y-component of the geometric center of the SphericalTank. This location is referenced from the origin of the Spacecraft BCS. The tank's center of gravity is determined based on this reference location, the fill line orientation, tank volume, fuel mass, and fuel density.

 

This property has been Deprecated. Please use TankReference instead.

Type:   Variable

Access: Read/Write

Units:   m

TankRefZ

The Z-component of the geometric center of the SphericalTank. This location is referenced from the origin of the Spacecraft BCS. The tank's center of gravity is determined based on this reference location, the fill line orientation, tank volume, fuel mass, and fuel density.

 

This property has been Deprecated. Please use TankReference instead.

Type:   Variable

Access: Read/Write

Units:   m

 
 

 

 

See also

Tanks Guide