Package org.xtce.toolkit

This package is the XTCE Toolkit that provides a convenient and relatively simple Application Programming Interface (API) to use an XTCE document, from an end user application, where the developer need not have advanced knowledge of the intricacies of dealing with the XTCE data model directly.

See: Description

Interface Summary

Interface	Description
XTCEAbsoluteTimeType	This interface permits the user/program to implement the handling of a specific form of an AbsoluteTimeType in the toolkit.

Class Summary

Class	Description
XTCEAlias	This class is a container for capturing the Alias information on an element in the XTCE data model, which is represented as an XTCENamedObject in the toolkit.
XTCEArgument	This class serves as a convenient container for representing Telecommand Arguments in the XTCE data model by abstracting the mechanics of assembling Argument attributes that are derived from XTCE related rules of processing, which can include processing of Argument, Member, and Type elements.
XTCECcsdsCucTimeHandler	This class implements CCSDS CUC time to support AbsoluteTimeDataType elements in an XTCE document.
XTCEConstants	This class contains several static constants for use throughout the XTCE Toolkit and User Interface.
XTCEContainerContentEntry	This class represents a single data entry resolved from an XTCETMContainer, which represents a SequenceContainer in the XTCE data model.
XTCEContainerContentModel	The container content model class encapsulates the pre-processing of an XTCE SequenceContainer into a series of rows suitable for a simple iterator.
XTCEContainerContentModelBase	The base class for the XTCE Container Content models captures the common elements when processing both TM and TC containers.
XTCEContainerEntryValue	This class represents the value of an entry in the container model when processing a specific Container in the XTCE data model.
XTCEDatabase	The XTCEDatabase class is the first core object to be used by a client that is working with an XTCE Database File.
XTCEDatabaseCompressor	Class to implement the capability to compress the XML in an XTCE document considering the schema features to reduce document size.
XTCEDatabaseConverter	Class to implement the capability to convert/upgrade an XTCE document from the 1.1 version to the 1.2 version.
XTCEDatabaseExporter	The XTCEDatabaseExporter class is an abstract base class for providing an interface to implement specific exporter classes.
XTCEDatabaseExporterCsv	The XTCEDatabaseExporterCsv class is a specific implementation of the XTCEDatabaseExporter abstract base class for the purpose of exporting TM parameters to a CSV file.
XTCEDatabaseParser	Helper class to do the XTCE document parsing to support the XTCEDatabase class.
XTCEDocumentMarshaller
XTCEFunctions	This class is a container to capture some common static functions that are applicable throughout the toolkit.
XTCEItemValue	This class captures the attributes needed to encode or decode a raw value to or from an engineering value and provides public methods to do these tasks from the caller's application.
XTCENamedObject	The XTCENamedObject class serves to capture the common elements to XTCE Parameters, Arguments, Containers, and Streams.
XTCENamespaceContext	The XTCE Namespace Context class is used to support XPath Queries by mapping the "xtce" prefix to the URI in the XTCEConstants class.
XTCEParameter	This class serves as a convenient container for representing TM and TC Parameters in the XTCE data model by abstracting the mechanics of assembling Parameter attributes that are derived from XTCE related rules of processing, which can include processing of Parameter, Member, and Type elements.
XTCEPosixTimeHandler	This class implements UNIX POSIX time to support AbsoluteTimeDataType elements in an XTCE document.
XTCESchemaErrorHandler	A class for instantiating an error handler to catch the warnings and errors that are returned by the SAX XML parser.
XTCESpaceSystem	The XTCESpaceSystem class represents the SpaceSystems elements in the XTCE data model and provides convenient accessors that abstract some of the XTCE processing rules from the application developer.
XTCESpaceSystemMetrics	The XTCESpaceSystemMetrics class is instantiated by the toolkit to capture interesting information about the contents of an XTCE Space System.
XTCETCContainer	The XTCETCContainer class models the XTCE CommandContainer element by simplifying the usage by pre-modeling the relationships.
XTCETelecommand	This class serves as a convenient container for representing Telecommands from the XTCE data model by abstracting the mechanics of assembling the Argument and Parameter attributes that are derived from XTCE related rules of processing, which can include processing of Parameter, Member, and Type elements.
XTCETelecommandContentModel	The telecommand content model class encapsulates the pre-processing of an XTCE MetaCommand/BlockMetaCommand into a series of rows suitable for a simple iterator.
XTCETMContainer	The XTCETMContainer class models the XTCE SequenceContainer element by simplifying the usage by pre-modeling the relationships.
XTCETMStream	Class the represent a telemetry stream from the XTCE data model.
XTCETypedObject	The XTCETypedObject class extends the basic XTCENamedObject class to serve by capturing the named objects that have specific type element associated with them, such as Parameter, Arguments, and Members.
XTCEValidRange	This class provides a simple accessor to the ValidRange element on an XTCEParameter or XTCEArgument while abstracting the user away from the type differences.

Enum Summary

Enum	Description
XTCEContainerContentEntry.FieldType	Enumeration type to describe the nature of an entry item on a container or telecommand table and/or drawing.
XTCETypedObject.EngineeringType	Enumeration representing the Calibrated/Engineering type of an item in the XTCE data model.
XTCETypedObject.RawType	Enumeration representing the Raw/Encoding type of an item in the XTCE data model.

Exception Summary

Exception	Description
XTCEDatabaseException	The XTCEDatabaseException class serves to simplify management of exceptions in the toolkit by distinguishing toolkit exceptions from unhandled system exceptions.

Package org.xtce.toolkit Description

This package is the XTCE Toolkit that provides a convenient and relatively simple Application Programming Interface (API) to use an XTCE document, from an end user application, where the developer need not have advanced knowledge of the intricacies of dealing with the XTCE data model directly.

This package is generally used by first instantiating an XTCEDatabase object from an existing file or using the new database file constructor. Once the database has been loaded and optionally validated against the schema, the user may then read and write to TM/TC Parameters, Telecommand, and Containers/Packets within the data model. Examples can be found in the org.omg.space.xtce.examples package.

This package provides the core functionality to the XTCE Graphical User Interface in the "ui" package as well.