StarField.CatalogType Property

 Top 

Description

The type of star catalog, when the input source is from a file. To load stars from a catalog, the Get command must be used. This property will be set when the Get command is called.

 

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.

 

Attributes

Type:

integer

Access:

read

Valid Values:

Value

Label

-1

N/A

0

FreeFlyer

1

OpenUniverse

2

SkyMap

 

Syntax

myVariable1 = myStarField1.CatalogType;

 

Example 1

The example below shows how to use the Get command to initialize a StarField and set the InputSource, CatalogType, and CatalogFileName properties.

 

StarField StarField1;

 

// Use the Get command to populate stars from 3 different catalogs

Get StarField1 as ffstarcatalog from ".\Support Files\ffstars.dat";

Report StarField1.InputSource, StarField1.CatalogType, StarField1.CatalogFileName, StarField1.NumberOfPoints;

 

Get StarField1 as skymap from ".\Support Files\SMstars.dat";

Report StarField1.InputSource, StarField1.CatalogType, StarField1.CatalogFileName, StarField1.NumberOfPoints;

 

Get StarField1 as openuniverse from ".\Support Files\OUstars.dat";

Report StarField1.InputSource, StarField1.CatalogType, StarField1.CatalogFileName, StarField1.NumberOfPoints;

 

Output:

 

StarField1.InputSource

StarField1.CatalogType

StarField1.CatalogFileName

StarField1.NumberOfPoints

1

0

.\Support Files\ffstars.dat

3123

1

2

.\Support Files\SMstars.dat

700

1

1

.\Support Files\OUstars.dat

3141

 

See also

StarField Object

Get Command

Stars Guide