Description
The PlateModel object holds all the settings for the plate model and contains a list of Plates called Spacecraft.PlateModel.Plates[].Users have the ability to add Plates or a box of Plates to a PlateModel to easily model a Spacecraft's geometry. Users can query values such as a PlateModel's SRP force, torque, or incident area throughout the duration of the Spacecraft's propagation. Once the PlateModel is defined, users can visualize their flat plate model in Mission Views to visually confirm the plate configuration, including the plates' size, location, and normal direction. See the Flat Plate Model 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->PlateModel
Parent Object: Spacecraft
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DrawMethod
|
The method by which the PlateModel will be drawn in views.
|
Type: Variable
Access: Read/Write
|
DrawNormals
|
Determines whether Plate normals should be drawn in views.
|
Type: Variable
Access: Read/Write
|
DrawRotationAxes
|
Determines whether to draw the rotation axes of the plates in this PlateModel in views. This axes will only be shown if the Plate.ArticulationModel for a given Plate is set to single-axis sun tracking or two-axis sun tracking.
|
Type: Variable
Access: Read/Write
|
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
|
Plates
|
An Array containing the Plates owned by this PlateModel.
|
Type: Array of Plate
Access: Read-Only
|
SRPIncidentArea
|
The total sun-incident area of this PlateModel.
|
Type: Variable
Access: Read-Only
Units: m^2
|
Visible
|
Determines whether to draw the PlateModel in views.
|
Type: Variable
Access: Read/Write
|
VisualScale
|
The visual scale used when drawing the PlateModel in views. The dimensions of the PlateModel are specified in meters, and this property will scale the visualization up or down.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
AddBoxOfPlates
|
Adds six plates to the Spacecraft in a cube or rectangular prism shape. The box is defined by x, y, and z dimensions in the Spacecraft body coordinate system, and centered at centerPosition. The plates will be automatically named using boxName as the prefix, and the face orientation as the suffix.
You must set the Spacecraft's ForceModel.SRPForceGeometry to "PlateModel" for this to have an effect.
|
AddPlate
|
Adds a new plate to the PlateModel.
You must set the Spacecraft's ForceModel.SRPForceGeometry to "PlateModel" for this to have an effect.
|
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.
|
GetIncidentArea
|
Calculates the incident area of this PlateModel as seen from the specified direction. The direction is specified in either the Spacecraft body fixed frame or the ICRF, according to the frame argument.
|
GetPlate
|
Gets a reference to the Plate associated with the specified label. If no Plate is associated with that label, an error is reported.
|
GetSRPForce
|
Returns the current SRP force on the PlateModel in the specified reference frame.
In order for the PlateModel to have an effect on the Spacecraft's propagation, the Spacecraft's ForceModel must be configured correctly. Turn on SRP using ForceModel.SRP = 1, and then choose PlateModel-based SRP using ForceModel.SRPForceGeometry = 1.
|
GetSRPTorque
|
Returns the current SRP torque on the PlateModel about the Spacecraft's center of mass. The torque is computed in the Spacecraft body fixed frame.
|
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.
|
RemoveAllPlates
|
Remove all plates from the plate model.
|
RemovePlate
|
Removes the plate identified by plateName.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetFaceColors
|
Sets the face color for all the plates in the PlateModel. To set the color of an individual plate, use the Plate.FaceColor property
|
SetNormalColors
|
Sets the normal vector color for all the plates in the PlateModel. To set the normal vector color of an individual plate, use the Plate.NormalColor property.
|
SetNormalLengths
|
Sets the length to use when drawing the normal vectors for all the plates in the PlateModel. To set the normal vector length for an individual plate, use the Plate.NormalLength property.
|
SetWireframeColors
|
Sets the wireframe color for all the plates in the PlateModel. To set the color of an individual plate, use the Plate.WireframeColor property.
|
|
|
