GSML - XML Schema Documentation

Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]

Schema Component Representation:
[ Expand All | Collapse All ]

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.
Documentation GSML XML Schema - 0.2.0.a
This document is an XML schema definition of GSML. Detailed documentation of the specification is found in each of the element references.

Notes:
  • We are using Castor in Mercury 1.2+ for data binding. Because of a limitation in Castor, all simple element types such as StationQueryAll are made into empty complex types so that we will get a class to compile.
Changelog:
  • 22 Jan 04 - Creation of this GSML shema.
  • 13 Mar 04 - Removing individual radio control commands. Folding all into a single SetRadio command. Same with the antenna control.
  • 16 Mar 04 - Converting most of root elements to types, only root element will be GSML. Enables use of min/maxOccurs.
  • 14 Apr 04 - Fixed dates above to 04! Moved global declarations of LookAhead, LookNow, TableDriven to just types. Global declarations now only GSML, Session, Station.
  • 22 Apr 04 - Added changed maxOccurs of 10000 to unbounded. Documenting with xs:annotation elements.
  • 27 Apr 04 - Major updates.
    • Added Status element to Session docs.
    • Removed Tx/Rx abreviations, now Transmit/Receive.
    • SetPower now uses Type_PowerDevice instead of a custom type.
    • Added a Type_Time to capture times.
    • Added a type for antenna polarity (LHCP, RHCP, VP, HP).
    • Added a type for radio modes (FM, FMN, etc).
    • Created single state documents for components with an option to set the type of state: Actual, LastSet, Derived.
    • Added DataHandler type that only includes AX.25 for the moment.
    • Added status field to Session document.
    • Added more information to Target documents (TLEs, etc).
    • Added TableDriven function for SessionController.
    • Removed UpdateInterval from hardware states. This capability now handled in the SessionController AutoTrack/Tune features.

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
top

Global Declarations

Element: GSML

Name GSML
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<GSML
source="xs:string [0..1] ?"
destination="xs:string [0..1] ?"
id="xs:string [0..1] ?">
Start Sequence [0..1]
<UpdateRadio> Type_UpdateRadio </UpdateRadio> [1]
<UpdateAntenna> Type_UpdateAntenna </UpdateAntenna> [1]
<SetRadioState> Type_SetRadioState </SetRadioState> [0..*]
<SetAntennaState> Type_SetAntennaState </SetAntennaState> [0..*]
<SetPower> Type_PowerDevice </SetPower> [0..*]
<AntennaState> Type_AntennaState </AntennaState> [0..*]
<RadioState> Type_RadioState </RadioState> [0..*]
<PowerState> Type_PowerState </PowerState> [0..*]
<SessionControllerState> Type_SessionControllerState </SessionControllerState> [0..*]
<MsgServerState> Type_MsgServerState </MsgServerState> [0..*]
<SessionAdd> Type_SessionAdd </SessionAdd> [0..*]
<SessionScheduled> Type_SessionScheduled </SessionScheduled> [0..*]
<SessionDelete> Type_SessionDelete </SessionDelete> [0..*]
<SessionQueryAll> Type_SessionQueryAll </SessionQueryAll> [0..*]
<Sessions> Type_Session </Sessions> [0..*]
<UpdateAutomationServices> Type_AutomationServices </UpdateAutomationServices> [0..*]
<StationRegister> Type_StationRegister </StationRegister> [0..*]
<StationDeRegister> Type_StationDeRegister </StationDeRegister> [0..*]
<StationQueryAll> Type_StationQueryAll </StationQueryAll> [0..*]
<Stations> Type_Stations </Stations> [0..*]
<Pong> Type_Pong </Pong> [0..*]
<Ping> Type_Ping </Ping> [0..*]
<GetState> Type_GetState </GetState> [0..*]
End Sequence
</GSML>
Schema Component Representation
top

Element: Session

Name Session
Type Type_Session
Nillable no
Abstract no
Documentation Element describing a session. Global element because it is used by a variety of GSML messages.
XML Instance Representation
<Session>
<Scheduler> Type_Person </Scheduler> [1..*]
<SessionName> xs:string </SessionName> [1]
<StartTime> Type_Time </StartTime> [1]
<EndTime> Type_Time </EndTime> [1]
<Status> Type_SessionStatus </Status> [1]
<ReservedPipelines> Type_ReservedPipelines </ReservedPipelines> [1]
<Targets> Type_Targets </Targets> [1]
<VirtualMachines> Type_VirtualMachines </VirtualMachines> [0..1]
<AutomationServices> Type_AutomationServices </AutomationServices> [0..1]
<Comment> xs:string </Comment> [0..1]
<SslPublicKey> xs:string </SslPublicKey> [0..1]
<SslPrivateKey> xs:string </SslPrivateKey> [0..1]
</Session>
Schema Component Representation
top

Element: Station

Name Station
Type Type_Station
Nillable no
Abstract no
Documentation Document used in GSML messages that reference a station.
XML Instance Representation
<Station>
<Name> xs:string </Name> [1]
<URL> xs:string </URL> [1]
<Location> Type_Location </Location> [1]
<Pipelines> Type_Pipelines </Pipelines> [1]
<Administrator> Type_Person </Administrator> [1..*]
<AccessPort> xs:integer </AccessPort> [0..1]
<SslPublicKey> xs:string </SslPublicKey> [0..1]
<SslPrivateKey> xs:string </SslPrivateKey> [0..1]
</Station>
Schema Component Representation
top

Element: Time

Name Time
Type Type_Time
Nillable no
Abstract no
Documentation Element describing a time document. Global element because it is used by a variety of GSML messages.
XML Instance Representation
<Time
Type="Type_TimeTypes [0..1]">
<TimeZone> xs:string </TimeZone> [0..1]
<Year> xs:integer </Year> [0..1]
<Month> xs:integer </Month> [0..1]
<Day> xs:integer </Day> [0..1]
<Hour> xs:integer </Hour> [0..1]
<Second> xs:integer </Second> [0..1]
<MilliSecond> xs:integer </MilliSecond> [0..1]
<UnixTimeSeconds> xs:long </UnixTimeSeconds> [0..1]
<UnixTimeMilliSeconds> xs:long </UnixTimeMilliSeconds> [0..1]
</Time>
Schema Component Representation
top

Global Definitions

Complex Type: Type_AX.25

Super-types: None
Sub-types: None
Name Type_AX.25
Abstract no
Documentation Describes AX.25 data handling capabilites.
XML Instance Representation
<...>
<Modem> Type_Modem </Modem> [1]
<TNC> Type_TNC </TNC> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Altitude

Super-types: xs:double < Type_Altitude (by extension)
Sub-types: None
Name Type_Altitude
Abstract no
Documentation Type for altitude documents.
XML Instance Representation
<...
Unit="Type_UnitsAltitude [0..1]">
xs:double
</...>
Schema Component Representation
top

Complex Type: Type_AntennaState

Super-types: None
Sub-types: None
Name Type_AntennaState
Abstract no
Documentation Status of the antenna hardware component. Two elements (values) for each state variable are allowed. One could be the LastSet, and the other a measured quantity (Actual, Derived, see Type_StateType).
XML Instance Representation
<...>
<AzimuthAngle> Type_HardwareValueDouble </AzimuthAngle> [0..2]
<ElevationAngle> Type_HardwareValueDouble </ElevationAngle> [0..2]
<PolarityDirection> Type_PolarityDirection </PolarityDirection> [0..2]
<AntennaPreampEnabled> Type_HardwareValueBoolean </AntennaPreampEnabled> [0..2]
</...>
Schema Component Representation
top

Complex Type: Type_AutomationServices

Super-types: None
Sub-types: None
Name Type_AutomationServices
Abstract no
Documentation Document describing the requested automation services of a session. Attribute SessionName used when this Type is used for updating session automation services.
XML Instance Representation
<...
SessionName="xs:string [0..1]">
<Service_AutoTrack> Type_Service_AutoControl </Service_AutoTrack> [1]
<Service_AutoTune> Type_Service_AutoControl </Service_AutoTune> [1]
<Service_ProductionUnit> Type_Service_ProductionUnit </Service_ProductionUnit> [1]
<Service_VHLAccess> Type_Service_VHLAccess </Service_VHLAccess> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Data

Super-types: None
Sub-types: None
Name Type_Data
Abstract no
Documentation Document used in SessionProduct to data set to and received from the satellite.
XML Instance Representation
<...>
<Time> ... </Time> [1]
<Content> xs:base64Binary </Content> [1]
<Source> xs:string </Source> [1]
<SourceType> Type_SourceType </SourceType> [1]
</...>
Schema Component Representation
top

Complex Type: Type_DataHandler

Super-types: None
Sub-types: None
Name Type_DataHandler
Abstract no
Documentation Document type for the various data handler options of the pipeline. Possibilities here are infinity. It's our hope that this functionality is captured in a VM rather than spec'ed here. But, as a example, we have set up an AX.25 data handler.
XML Instance Representation
<...>
<AX.25> Type_AX.25 </AX.25> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Die

Super-types: None
Sub-types: None
Name Type_Die
Abstract no
Documentation Requests a component to exit.
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_Frequency

Super-types: xs:double < Type_Frequency (by extension)
Sub-types: None
Name Type_Frequency
Abstract no
Documentation Document type for frequencies.
XML Instance Representation
<...
Unit="Type_UnitsFrequency [0..1]">
xs:double
</...>
Schema Component Representation
top

Complex Type: Type_FrequencyRange

Super-types: None
Sub-types: None
Name Type_FrequencyRange
Abstract no
Documentation Document type for frequency ranges used in specifying pipeline capabilites.
XML Instance Representation
<...>
<Maximum> Type_Frequency </Maximum> [1]
<Minimum> Type_Frequency </Minimum> [1]
<Bandwidth> Type_Frequency </Bandwidth> [1]
</...>
Schema Component Representation
top

Complex Type: Type_GainType

Super-types: xs:double < Type_GainType (by extension)
Sub-types: None
Name Type_GainType
Abstract no
Documentation Document type for gain data.
XML Instance Representation
<...
Unit="Type_UnitsGain [0..1]">
xs:double
</...>
Schema Component Representation
top

Complex Type: Type_GetState

Super-types: None
Sub-types: None
Name Type_GetState
Abstract no
Documentation Request internal state and status of receiving component.
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_HardwareValueBoolean

Super-types: xs:boolean < Type_HardwareValueBoolean (by extension)
Sub-types: None
Name Type_HardwareValueBoolean
Abstract no
Documentation Type for hardware boolean values that includes a StateType attribute to say from where the value came.
XML Instance Representation
<...
StateType="Type_StateType [0..1]">
xs:boolean
</...>
Schema Component Representation
top

Complex Type: Type_HardwareValueDouble

Super-types: xs:double < Type_HardwareValueDouble (by extension)
Sub-types: None
Name Type_HardwareValueDouble
Abstract no
Documentation Type for hardware double values that includes a StateType attribute to say where the value came from.
XML Instance Representation
<...
StateType="Type_StateType [0..1]">
xs:double
</...>
Schema Component Representation
top

Complex Type: Type_HardwareValueInteger

Super-types: xs:integer < Type_HardwareValueInteger (by extension)
Sub-types: None
Name Type_HardwareValueInteger
Abstract no
Documentation Type for hardware integer values that includes a StateType attribute to say where the value came from.
XML Instance Representation
<...
StateType="Type_StateType [0..1]">
xs:integer
</...>
Schema Component Representation
top

Complex Type: Type_HardwareValueString

Super-types: xs:string < Type_HardwareValueString (by extension)
Sub-types: None
Name Type_HardwareValueString
Abstract no
Documentation Type for hardware string values that includes a StateType attribute to say where the value came from.
XML Instance Representation
<...
StateType="Type_StateType [0..1]">
xs:string
</...>
Schema Component Representation
top

Complex Type: Type_LatLon

Super-types: xs:double < Type_LatLon (by extension)
Sub-types: None
Name Type_LatLon
Abstract no
Documentation Type for latitude and longitude documents.
XML Instance Representation
<...
Unit="Type_UnitsLatLon [0..1]">
xs:double
</...>
Schema Component Representation
top

Complex Type: Type_Location

Super-types: None
Sub-types: None
Name Type_Location
Abstract no
Documentation Document containing station location information.
XML Instance Representation
<...>
<Latitude> Type_LatLon </Latitude> [1]
<Longitude> Type_LatLon </Longitude> [1]
<Altitude> Type_Altitude </Altitude> [1]
</...>
Schema Component Representation
top

Complex Type: Type_LookAhead

Super-types: None
Sub-types: None
Name Type_LookAhead
Abstract no
Documentation LookAhead uses an open loop calculation from TLEs to determine a satellites position some point in the future and configures the station to that setting now. Period is the interval between updates. LeadTime designates how far ahead to look.
XML Instance Representation
<...>
<LeadTime> Type_Time </LeadTime> [1]
<Period> xs:integer </Period> [1]
</...>
Schema Component Representation
top

Complex Type: Type_LookNow

Super-types: None
Sub-types: None
Name Type_LookNow
Abstract no
Documentation LookNow uses an open loop calculation from TLEs to determine a satellites position and configure the station appropriately.
XML Instance Representation
<...
Period="xs:integer [0..1]"/>
Schema Component Representation
top

Complex Type: Type_ModeRadio

Super-types: xs:string < Type_ModeRadioTypes (by restriction) < Type_ModeRadio (by extension)
Sub-types: None
Name Type_ModeRadio
Abstract no
Documentation Type for radio modes that includes a StateType attribute to say where the value came from.
XML Instance Representation
<...
StateType="Type_StateType [0..1]">
Type_ModeRadioTypes
</...>
Schema Component Representation
top

Complex Type: Type_Modem

Super-types: None
Sub-types: None
Name Type_Modem
Abstract no
Documentation Document describing a modem.
XML Instance Representation
<...>
<Baud> xs:integer </Baud> [1]
<ModulationType> Type_ModulationType </ModulationType> [1]
</...>
Schema Component Representation
top

Complex Type: Type_MsgServerState

Super-types: None
Sub-types: None
Name Type_MsgServerState
Abstract no
Documentation Status of a message server component. Currently just contains number of clients.
XML Instance Representation
<...
NumberOfClients="xs:integer [0..1]"/>
Schema Component Representation
top

Complex Type: Type_Organization

Super-types: None
Sub-types: None
Name Type_Organization
Abstract no
Documentation Document type containing data for organizations related to GS resources.
XML Instance Representation
<...>
<Email> xs:string </Email> [1]
<PhoneNumber> xs:string </PhoneNumber> [1]
<Name> xs:string </Name> [1]
<Unit> xs:string </Unit> [1]
<City> xs:string </City> [1]
<State> xs:string </State> [1]
<Country> xs:string </Country> [1]
</...>
Schema Component Representation
top

Complex Type: Type_OutputPower

Super-types: xs:double < Type_OutputPower (by extension)
Sub-types: None
Name Type_OutputPower
Abstract no
Documentation Document type for output power data.
XML Instance Representation
<...
Unit="Type_UnitsPower [0..1]">
xs:double
</...>
Schema Component Representation
top

Complex Type: Type_Person

Super-types: None
Sub-types: None
Name Type_Person
Abstract no
Documentation Document type containing data for persons related to GS resources.
XML Instance Representation
<...>
<Name> xs:string </Name> [1]
<Email> xs:string </Email> [1]
<PhoneNumber> xs:string </PhoneNumber> [1]
<Organization> Type_Organization </Organization> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Ping

Super-types: None
Sub-types: None
Name Type_Ping
Abstract no
Documentation Enables application level pings of ground station software systems. Similar to the classic "ping" networking command.
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_Pipeline

Super-types: None
Sub-types: None
Name Type_Pipeline
Abstract no
Documentation Document describing a pipeline. Used to specify ground station hardware capabilities.
XML Instance Representation
<...>
<Name> xs:string </Name> [0..1]
<Mode> Type_ModePipelines </Mode> [0..1]
<ReceiveGain> Type_GainType </ReceiveGain> [0..1]
<TransmitGain> Type_GainType </TransmitGain> [0..1]
<OutputPower> Type_OutputPower </OutputPower> [0..1]
<TransmitFrequencyRange> Type_FrequencyRange </TransmitFrequencyRange> [0..1]
<ReceiveFrequencyRange> Type_FrequencyRange </ReceiveFrequencyRange> [0..1]
<DataHandler> Type_DataHandler </DataHandler> [0..*]
</...>
Schema Component Representation
top

Complex Type: Type_Pipelines

Super-types: None
Sub-types: None
Name Type_Pipelines
Abstract no
Documentation Document of pipeline descriptions.
XML Instance Representation
<...>
<Pipeline> Type_Pipeline </Pipeline> [1..*]
</...>
Schema Component Representation
top

Complex Type: Type_PolarityDirection

Super-types: xs:string < Type_PolarityTypes (by restriction) < Type_PolarityDirection (by extension)
Sub-types: None
Name Type_PolarityDirection
Abstract no
Documentation Type for antenna polarity direction that includes a StateType attribute to say where the value came from.
XML Instance Representation
<...
StateType="Type_StateType [0..1]">
Type_PolarityTypes
</...>
Schema Component Representation
top

Complex Type: Type_Pong

Super-types: None
Sub-types: None
Name Type_Pong
Abstract no
Documentation Application response to a Ping command.
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_PowerDevice

Super-types: None
Sub-types: None
Name Type_PowerDevice
Abstract no
Documentation Power status of a component. XXX What is the difference between Name and ID? Status is either "on" or "off".
XML Instance Representation
<...
Name="xs:string [0..1]"
Id="xs:string [0..1]"
Status="xs:string [0..1]"/>
Schema Component Representation
top

Complex Type: Type_PowerState

Super-types: None
Sub-types: None
Name Type_PowerState
Abstract no
Documentation Power state (on,off) of hardware components.
XML Instance Representation
<...>
<Device> Type_PowerDevice </Device> [1..*]
</...>
Schema Component Representation
top

Complex Type: Type_RadioState

Super-types: None
Sub-types: None
Name Type_RadioState
Abstract no
Documentation Status of the radio hardware component.
XML Instance Representation
<...>
<TransmitFrequency> Type_HardwareValueDouble </TransmitFrequency> [0..1]
<ReceiveFrequency> Type_HardwareValueDouble </ReceiveFrequency> [0..1]
<TransmitMode> Type_ModeRadio </TransmitMode> [0..1]
<ReceiveMode> Type_ModeRadio </ReceiveMode> [0..1]
<TransmitPower> Type_HardwareValueInteger </TransmitPower> [0..1]
<Squelch> Type_HardwareValueInteger </Squelch> [0..1]
<Attenuation> Type_HardwareValueInteger </Attenuation> [0..1]
<RadioPreampEnabled> Type_HardwareValueBoolean </RadioPreampEnabled> [0..1]
</...>
Schema Component Representation
top

Complex Type: Type_ReservedPipelines

Super-types: None
Sub-types: None
Name Type_ReservedPipelines
Abstract no
Documentation Document describing the reserved pipelines of a session.
XML Instance Representation
<...>
<PipeName> xs:string </PipeName> [1..10]
</...>
Schema Component Representation
top

Complex Type: Type_SendCommand

Super-types: None
Sub-types: None
Name Type_SendCommand
Abstract no
Documentation Wrapper for a GSML message to be sent at a specified time, used by TableDriven control.
XML Instance Representation
<...>
<GSML> ... </GSML> [0..*]
<Time> ... </Time> [0..1]
</...>
Schema Component Representation
top

Complex Type: Type_Service_AutoControl

Super-types: None
Sub-types: None
Name Type_Service_AutoControl
Abstract no
Documentation Document describing auto control of tracking and tuning functions.
XML Instance Representation
<...>
<LookAhead> Type_LookAhead </LookAhead> [1]
<LookNow> Type_LookNow </LookNow> [1]
<TableDriven> Type_TableDriven </TableDriven> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Service_ProductionUnit

Super-types: None
Sub-types: None
Name Type_Service_ProductionUnit
Abstract no
Documentation Service description for the ProductionUnit. Enables logging of internal session GSML message, transmitted data, and received data. Transmit and Receive data is encoded into ASCII.
XML Instance Representation
<...
LogInternalGSML="xs:boolean [0..1]"
LogTransmittedData="xs:boolean [0..1]"
LogReceivedData="xs:boolean [0..1]"
EncodingType="Type_EncodingType [0..1]"/>
Schema Component Representation
top

Complex Type: Type_Service_VHLAccess

Super-types: None
Sub-types: None
Name Type_Service_VHLAccess
Abstract no
Documentation Description of VHL access server service. Allow low level commanding at the VHL level by remote users.
XML Instance Representation
<...
ServerType="Type_ServerType [0..1]"
Name="xs:string [0..1]"
Port="xs:integer [0..1]"/>
Schema Component Representation
top

Complex Type: Type_Session

Super-types: None
Sub-types: None
Name Type_Session
Abstract no
Documentation Document type describing a session.
XML Instance Representation
<...>
<Scheduler> Type_Person </Scheduler> [1..*]
<SessionName> xs:string </SessionName> [1]
<StartTime> Type_Time </StartTime> [1]
<EndTime> Type_Time </EndTime> [1]
<Status> Type_SessionStatus </Status> [1]
<ReservedPipelines> Type_ReservedPipelines </ReservedPipelines> [1]
<Targets> Type_Targets </Targets> [1]
<VirtualMachines> Type_VirtualMachines </VirtualMachines> [0..1]
<AutomationServices> Type_AutomationServices </AutomationServices> [0..1]
<Comment> xs:string </Comment> [0..1]
<SslPublicKey> xs:string </SslPublicKey> [0..1]
<SslPrivateKey> xs:string </SslPrivateKey> [0..1]
</...>
Schema Component Representation
top

Complex Type: Type_SessionAdd

Super-types: None
Sub-types: None
Name Type_SessionAdd
Abstract no
Documentation Requests that a session be scheduled.
XML Instance Representation
<...>
<Session> ... </Session> [0..*]
</...>
Schema Component Representation
top

Complex Type: Type_SessionControllerState

Super-types: None
Sub-types: None
Name Type_SessionControllerState
Abstract no
Documentation Status of the session controller. Captures state of the satellite estimator as well.
XML Instance Representation
<...
satellite="xs:string [0..1]"
latitude="xs:double [0..1]"
longitude="xs:double [0..1]"
range="xs:double [0..1]"
altitude="xs:double [0..1]"
velocity="xs:double [0..1]"
footprint="xs:double [0..1]"
orbitnum="xs:long [0..1]"
visibility="xs:integer [0..1]"
time="xs:long [0..1]"
state="xs:string [0..1]"
keps="xs:string [0..1]"
azimuthAngle="xs:double [0..1]"
elevationAngle="xs:double [0..1]"
txFrequency="xs:double [0..1]"
rxFrequency="xs:double [0..1]"
doppler="xs:double [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SessionDelete

Super-types: None
Sub-types: None
Name Type_SessionDelete
Abstract no
Documentation Request deletion of a session with name, SessionName.
XML Instance Representation
<...
SessionName="xs:string [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SessionMessage

Super-types: None
Sub-types: None
Name Type_SessionMessage
Abstract no
Documentation Document used in SessionProduct to log messages sent over the SessionMessage Server.
XML Instance Representation
<...>
<Content> xs:string </Content> [1]
<Time> ... </Time> [1]
</...>
Schema Component Representation
top

Complex Type: Type_SessionProduct

Super-types: None
Sub-types: None
Name Type_SessionProduct
Abstract no
Documentation Contains a complete summary of a session. All session level GSML messages are logged. All data sent to and received from the satellite is logged.
XML Instance Representation
<...>
<Session> ... </Session> [1]
<SessionMessage> Type_SessionMessage </SessionMessage> [0..*]
<Data> Type_Data </Data> [0..*]
</...>
Schema Component Representation
top

Complex Type: Type_SessionQueryAll

Super-types: None
Sub-types: None
Name Type_SessionQueryAll
Abstract no
Documentation Requests a list of all sessions at a particular station.
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_SessionScheduled

Super-types: None
Sub-types: None
Name Type_SessionScheduled
Abstract no
Documentation Response to a SessionAdd. Provides a return code that describes the success of the action. The SessionName attribute corresponds the Session description from the SessionAdd and is locally unique to a station.
XML Instance Representation
<...
SessionName="xs:string [0..1]">
<ReturnCode> xs:string </ReturnCode> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Sessions

Super-types: None
Sub-types: None
Name Type_Sessions
Abstract no
Documentation Response to a SessionQueryAll that includes all Sessions known to a station.
XML Instance Representation
<...>
<Session> ... </Session> [1..*]
</...>
Schema Component Representation
top

Complex Type: Type_SetAntennaState

Super-types: None
Sub-types: None
Name Type_SetAntennaState
Abstract no
Documentation Set the state of an antenna hardware component.
XML Instance Representation
<...
AzimuthAngle="xs:double [0..1]"
ElevationAngle="xs:double [0..1]"
PolarityDirection="xs:string [0..1]"
PreampIsEnabled="xs:boolean [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SetAzimuthAngle

Super-types: None
Sub-types: None
Name Type_SetAzimuthAngle
Abstract no
Documentation Set the azimuth angle of an antenna.
XML Instance Representation
<...
Angle="xs:double [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SetElevationAngle

Super-types: None
Sub-types: None
Name Type_SetElevationAngle
Abstract no
Documentation Set the elevation angle of an antenna.
XML Instance Representation
<...
Angle="xs:double [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SetPower

Super-types: None
Sub-types: None
Name Type_SetPower
Abstract no
Documentation Set the status (on,off) of a hardware component.
XML Instance Representation
<...
ComponentId="xs:string [0..1]"
Status="xs:string [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SetRadioState

Super-types: None
Sub-types: None
Name Type_SetRadioState
Abstract no
Documentation Set the state of a radio hardware component.
XML Instance Representation
<...
TransmitFrequency="xs:double [0..1]"
ReceiveFrequency="xs:double [0..1]"
ReceiveMode="xs:string [0..1]"
TransmitMode="xs:string [0..1]"
TransmitPower="xs:integer [0..1]"
Squelch="xs:integer [0..1]"
Attenuation="xs:integer [0..1]"
PreampEnabled="xs:boolean [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SetReceiveFrequency

Super-types: None
Sub-types: None
Name Type_SetReceiveFrequency
Abstract no
Documentation Set the receive frequency of a radio.
XML Instance Representation
<...
Frequency="xs:double [0..1]"/>
Schema Component Representation
top

Complex Type: Type_SetTransmitFrequency

Super-types: None
Sub-types: None
Name Type_SetTransmitFrequency
Abstract no
Documentation Set the transmit frequency of a radio.
XML Instance Representation
<...
Frequency="xs:double [0..1]"/>
Schema Component Representation
top

Complex Type: Type_Station

Super-types: None
Sub-types: None
Name Type_Station
Abstract no
Documentation Document used in GSML messages that reference a station.
XML Instance Representation
<...>
<Name> xs:string </Name> [1]
<URL> xs:string </URL> [1]
<Location> Type_Location </Location> [1]
<Pipelines> Type_Pipelines </Pipelines> [1]
<Administrator> Type_Person </Administrator> [1..*]
<AccessPort> xs:integer </AccessPort> [0..1]
<SslPublicKey> xs:string </SslPublicKey> [0..1]
<SslPrivateKey> xs:string </SslPrivateKey> [0..1]
</...>
Schema Component Representation
top

Complex Type: Type_StationDeRegister

Super-types: None
Sub-types: None
Name Type_StationDeRegister
Abstract no
Documentation Forces a station to be removed from a servers registration list.
XML Instance Representation
<...>
<Station> ... </Station> [1..*]
</...>
Schema Component Representation
top

Complex Type: Type_StationQueryAll

Super-types: None
Sub-types: None
Name Type_StationQueryAll
Abstract no
Documentation Query all stations registered with a server.
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_StationRegister

Super-types: None
Sub-types: None
Name Type_StationRegister
Abstract no
Documentation Register a GSML enabled station with an FGN server. The registration is valid until the expiration time.
XML Instance Representation
<...
Expiration="xs:long [0..1]">
<Station> ... </Station> [1..*]
</...>
Schema Component Representation
top

Complex Type: Type_Stations

Super-types: None
Sub-types: None
Name Type_Stations
Abstract no
Documentation Response to a StationQueryAll message that contains a list of registered ground stations.
XML Instance Representation
<...>
<Station> ... </Station> [0..*]
</...>
Schema Component Representation
top

Complex Type: Type_TableDriven

Super-types: None
Sub-types: None
Name Type_TableDriven
Abstract no
Documentation Table driven enables commands to be scripted before a pass and executed at the marked time. The Offset attribute (time in milliseconds) allows the table time values to be shifted in an easy fashion. This is useful for small errors in the predicted values.
XML Instance Representation
<...
Offset="xs:integer [0..1]">
<SendCommand> Type_SendCommand </SendCommand> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Target

Super-types: None
Sub-types: None
Name Type_Target
Abstract no
Documentation Document describing the target of a session. Contains the name of the satellite, the international satellite number, and the two line element sets. The base frequencies are from the perspective of the target, what are its transmit and receive frequencies.
XML Instance Representation
<...>
<Name> xs:string </Name> [0..1]
<SatelliteNumber> xs:integer </SatelliteNumber> [0..1]
<TwoLineElements> xs:string </TwoLineElements> [0..1]
<BaseTransmitFrequency> Type_Frequency </BaseTransmitFrequency> [0..*]
<BaseReceiveFrequency> Type_Frequency </BaseReceiveFrequency> [0..*]
</...>
Schema Component Representation
top

Complex Type: Type_Targets

Super-types: None
Sub-types: None
Name Type_Targets
Abstract no
Documentation Document containing targets, a group of satellites for a session.
XML Instance Representation
<...>
<Target> Type_Target </Target> [1]
</...>
Schema Component Representation
top

Complex Type: Type_Time

Super-types: None
Sub-types: None
Name Type_Time
Abstract no
Documentation Type for describing time related elements.
XML Instance Representation
<...
Type="Type_TimeTypes [0..1]">
<TimeZone> xs:string </TimeZone> [0..1]
<Year> xs:integer </Year> [0..1]
<Month> xs:integer </Month> [0..1]
<Day> xs:integer </Day> [0..1]
<Hour> xs:integer </Hour> [0..1]
<Second> xs:integer </Second> [0..1]
<MilliSecond> xs:integer </MilliSecond> [0..1]
<UnixTimeSeconds> xs:long </UnixTimeSeconds> [0..1]
<UnixTimeMilliSeconds> xs:long </UnixTimeMilliSeconds> [0..1]
</...>
Schema Component Representation
top

Complex Type: Type_UpdateAntenna

Super-types: None
Sub-types: None
Name Type_UpdateAntenna
Abstract no
Documentation Request the antenna hardware be updated with new control parameters (such as new elevation angle).
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_UpdateRadio

Super-types: None
Sub-types: None
Name Type_UpdateRadio
Abstract no
Documentation Request the radio hardware be updated with new control parameters (such as doppler shift correction to frequencies).
XML Instance Representation
<.../>
Schema Component Representation
top

Complex Type: Type_VirtualMachine

Super-types: None
Sub-types: None
Name Type_VirtualMachine
Abstract no
Documentation Document containing a virtual machine description. Name is the name of the virtual machine. Path is the file path to the VM. Type is the type of virtual machine.
XML Instance Representation
<...
Name="xs:string [0..1]"
Type="Type_VMType [0..1]"
Path="xs:string [0..1]"/>
Schema Component Representation
top

Complex Type: Type_VirtualMachines

Super-types: None
Sub-types: None
Name Type_VirtualMachines
Abstract no
Documentation Document containing virtual machine descriptions.
XML Instance Representation
<...>
<VirtualMachine> Type_VirtualMachine </VirtualMachine> [0..*]
</...>
Schema Component Representation
top

Simple Type: Type_EncodingType

Super-types: xs:string < Type_EncodingType (by restriction)
Sub-types: None
Name Type_EncodingType
Content
  • Base XSD Type: string
  • value comes from list: {'base64'}
Documentation Type of decoding for binary production unit data.
Schema Component Representation
top

Simple Type: Type_ModePipelines

Super-types: xs:string < Type_ModePipelines (by restriction)
Sub-types: None
Name Type_ModePipelines
Content
  • Base XSD Type: string
  • value comes from list: {'TX'|'RX'|'TRX'}
Documentation Enumerated types for pipelines. TX is Transmit only. RX is Receive only. TRX is transmit and receive.
Schema Component Representation
top

Simple Type: Type_ModeRadioTypes

Super-types: xs:string < Type_ModeRadioTypes (by restriction)
Sub-types:
Name Type_ModeRadioTypes
Content
  • Base XSD Type: string
  • value comes from list: {'FM'|'FMN'|'CW'|'CWN'|'LSB'|'USB'}
Documentation Describes types of radio modulation modes. FM, FMN, CW, CWN, LSB, USB.
Schema Component Representation
top

Simple Type: Type_ModulationType

Super-types: xs:string < Type_ModulationType (by restriction)
Sub-types: None
Name Type_ModulationType
Content
  • Base XSD Type: string
  • value comes from list: {'FSK'|'AFSK'}
Documentation
Schema Component Representation
top

Simple Type: Type_PolarityTypes

Super-types: xs:string < Type_PolarityTypes (by restriction)
Sub-types:
Name Type_PolarityTypes
Content
  • Base XSD Type: string
  • value comes from list: {'LHCP'|'RHCP'|'VP'|'HP'}
Documentation Describes types of antenna polarity. LHCP - Left Hand Circular Polarization. RHCP - Right Hand Circular Polarization. VP - Veritically Polarization. HP - Horization Polarization.
Schema Component Representation
top

Simple Type: Type_ServerType

Super-types: xs:string < Type_ServerType (by restriction)
Sub-types: None
Name Type_ServerType
Content
  • Base XSD Type: string
  • value comes from list: {'TCP'|'SSL'}
Documentation Description of access server connection type, TCP or SSL sockets.
Schema Component Representation
top

Simple Type: Type_SessionStatus

Super-types: xs:string < Type_SessionStatus (by restriction)
Sub-types: None
Name Type_SessionStatus
Content
  • Base XSD Type: string
  • value comes from list: {'SCHEDULED'|'ACTIVE'|'COMPLETED'|'KILL'|'KILLED'|'ERROR'}
Documentation Status of a session. KILL signifies a session in the process of being killed and stopped.
Schema Component Representation
top

Simple Type: Type_SourceType

Super-types: xs:string < Type_SourceType (by restriction)
Sub-types: None
Name Type_SourceType
Content
  • Base XSD Type: string
  • value comes from list: {'TX'|'RX'}
Documentation Enumeration of data types in Type_Data to distiguish source of data. RX is data received from satellite. TX is data sent to satellite.
Schema Component Representation
top

Simple Type: Type_StateType

Super-types: xs:string < Type_StateType (by restriction)
Sub-types: None
Name Type_StateType
Content
  • Base XSD Type: string
  • value comes from list: {'Actual'|'LastSet'|'Derived'}
Documentation Describes type of state returned from Hardware. Actual - hardware has been polled and these are the values. LastSet - value that was last commanded of the hardware. Derived - state derived from other hardware state.
Schema Component Representation
top

Simple Type: Type_TNC

Super-types: xs:string < Type_TNC (by restriction)
Sub-types: None
Name Type_TNC
Content
  • Base XSD Type: string
  • value comes from list: {'KISS'|'Symek'|'Kantronics9612'|'Linux'|'Other'}
Documentation
Schema Component Representation
top

Simple Type: Type_TimeTypes

Super-types: xs:string < Type_TimeTypes (by restriction)
Sub-types: None
Name Type_TimeTypes
Content
  • Base XSD Type: string
  • value comes from list: {'UnixTimeSeconds'|'UnixTimeMilliSeconds'|'Full'}
Documentation Enumeration of possible Time document types. UnixTime(Milli)Seconds is a count from Jan 1, 1970 UTC. Full time specifies time zone, year, month, day, hour, second and milliseconds.
Schema Component Representation
top

Simple Type: Type_UnitsAltitude

Super-types: xs:string < Type_UnitsAltitude (by restriction)
Sub-types: None
Name Type_UnitsAltitude
Content
  • Base XSD Type: string
  • value comes from list: {'Feet'|'Meters'}
Documentation Enumerated units of altitude.
Schema Component Representation
top

Simple Type: Type_UnitsFrequency

Super-types: xs:string < Type_UnitsFrequency (by restriction)
Sub-types: None
Name Type_UnitsFrequency
Content
  • Base XSD Type: string
  • value comes from list: {'Hz'|'KHz'|'MHz'|'GHz'|'THz'}
Documentation Enumerated units of frequencies.
Schema Component Representation
top

Simple Type: Type_UnitsGain

Super-types: xs:string < Type_UnitsGain (by restriction)
Sub-types: None
Name Type_UnitsGain
Content
  • Base XSD Type: string
  • value comes from list: {'Db'}
Documentation Enumerated units of gain.
Schema Component Representation
top

Simple Type: Type_UnitsLatLon

Super-types: xs:string < Type_UnitsLatLon (by restriction)
Sub-types: None
Name Type_UnitsLatLon
Content
  • Base XSD Type: string
  • value comes from list: {'Decimal'|'Degree'}
Documentation Enumerated units of latitude and longitude.
Schema Component Representation
top

Simple Type: Type_UnitsPower

Super-types: xs:string < Type_UnitsPower (by restriction)
Sub-types: None
Name Type_UnitsPower
Content
  • Base XSD Type: string
  • value comes from list: {'Watts'}
Documentation Enumerated units of power.
Schema Component Representation
top

Simple Type: Type_VMType

Super-types: xs:string < Type_VMType (by restriction)
Sub-types: None
Name Type_VMType
Content
  • Base XSD Type: string
  • value comes from list: {'VMWare'|'Xen'}
Documentation Enumeration of Virtual Machine types.
Schema Component Representation
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Generated by xs3p. Last modified: Wed May 19 23:39:43 2004