PointGroupPoint Object

 Top  Previous  Next

Description

The PointGroupPoint object represents one point of a PointGroup, and its properties should be accessed using PointGroup indices: PointGroup1[0].Longitude = 10.

 

Inheritance Hierarchy: Object->PointGroupPoint

 

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.

 

Properties

 

Name

Description

Attributes

Color

Color of the point.

Type:   Variable

Access: Read/Write

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Height

Height of the point. If Earth is set as the central body using the default radius and flattening coefficient, FreeFlyer will use the WGS 84 reference ellipsoid.

Type:   Variable

Access: Read/Write

Units:   km

Latitude

Latitude of the point.

Type:   Variable

Access: Read/Write

Units:   deg

Longitude

Longitude of the point.

Type:   Variable

Access: Read/Write

Units:   deg

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

Opacity

Opacity of the point.

Type:   Variable

Access: Read/Write

Size

Size of the point.

Type:   Variable

Access: Read/Write

Units:   pixel

 
 

 

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

ID

This property is not used at this time.

 

This property has been Deprecated. This property has no effect.

Type:   Variable

Access: Read/Write

Magnitude

This property is not used at this time.

 

This property has been Deprecated. This property has no effect.

Type:   Variable

Access: Read/Write