| Package | Description |
|---|---|
| org.xtce.apps.editor.dialogs | |
| org.xtce.apps.editor.ui |
This package is the XTCE Viewer/Browser graphical user interface tool,
which is launched from main() at org.xtce.apps.editor.ui.XTCEViewer.
|
| org.xtce.math | |
| 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.
|
| org.xtce.toolkit.examples |
This package is a set of test and example classes with main() functions
that are used to illustrate the toolkit API in use.
|
| Constructor and Description |
|---|
XTCEViewerArgumentXmlDialog(Frame parent,
boolean modal,
XTCEArgument argument)
Constructor to create a new XML output dialog for a Parameter in an
XTCE document.
|
XTCEViewerContainerXmlDialog(Frame parent,
boolean modal,
XTCETCContainer container)
Creates new dialog window for showing the XTCE SequenceContainer
element XML contents.
|
XTCEViewerContainerXmlDialog(Frame parent,
boolean modal,
XTCETelecommand tc)
Creates new dialog window for showing the XTCE PCMStreamType element
XML contents.
|
XTCEViewerContainerXmlDialog(Frame parent,
boolean modal,
XTCETMContainer container)
Creates new dialog window for showing the XTCE SequenceContainer
element XML contents.
|
XTCEViewerContainerXmlDialog(Frame parent,
boolean modal,
XTCETMStream stream)
Creates new dialog window for showing the XTCE PCMStreamType element
XML contents.
|
XTCEViewerParameterDetailDialog(Frame parent,
boolean modal,
XTCEParameter parameter)
Creates new form XTCEViewerParameterDetailDialog TODO
|
XTCEViewerParameterXmlDialog(Frame parent,
boolean modal,
XTCEParameter parameter)
Constructor to create a new XML output dialog for a Parameter in an
XTCE document.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XTCEViewerContainerDrawing.save(File fileName)
Method to save the drawing to an image file on the filesystem.
|
| Modifier and Type | Method and Description |
|---|---|
Number |
SplineCalibration.calibrate(Number xValue)
Apply this Spline Calibrator, otherwise known as a
"piecewise function", to an uncalibrated value.
|
Number |
PolynomialCalibration.calibrate(Number xValue)
Apply this Polynomial Calibrator to an uncalibrated value.
|
Number |
MathOperationCalibration.calibrate(Number xValue)
Calibration of values using MathOperationCalibrator has some limited
support for common numeric values and operators.
|
Number |
Calibration.calibrate(Number xValue)
Method to convert an uncalibrated value to a calibrated value by
applying the Calibrator in the XTCE document.
|
String |
MathOperationCalibration.toInfixString()
Method to create a simple space delimited string that represents the
infix expression from the XTCE MathOperationCalibrator that this
object instance represents.
|
Number |
SplineCalibration.uncalibrate(Number yValue)
Apply this Spline Calibrator to an already calibrated value.
|
Number |
PolynomialCalibration.uncalibrate(Number yValue)
Apply this Polynomial Calibrator to an already calibrated value.
|
Number |
MathOperationCalibration.uncalibrate(Number yValue)
Reverse calibration of values is not yet supported for
MathOperationCalibrator.
|
Number |
Calibration.uncalibrate(Number yValue)
Method to convert a calibrated value to an uncalibrated value by
reversing the Calibrator in the XTCE document.
|
| Modifier and Type | Method and Description |
|---|---|
void |
XTCEDatabase.addSpaceSystem(String name,
String path)
Function to add a new Space System element to the XTCE document
structure.
|
void |
XTCEDatabase.deleteSpaceSystem(String ssPath)
Deletes a SpaceSystem element from the current XTCE document.
|
BitSet |
XTCEContainerContentModelBase.encodeContainer()
Encode a raw binary BitSet from the processed container content model
for potential file or wire transmission.
|
NodeList |
XTCEDatabaseParser.evaluateXPathQuery(String query)
Evaluate an arbitrary XPath Query Expression and return a generic
NodeList object back or an exception with an error message.
|
List<String> |
XTCEDatabaseExporterCsv.exportContainers(File outFile)
Export the containers in the XTCE file represented by an XTCEDatabase
object.
|
List<String> |
XTCEDatabaseExporter.exportContainers(File outFile)
Export the telemetry containers in the XTCE file represented by an
XTCEDatabase object.
|
List<String> |
XTCEDatabaseExporterCsv.exportParameters(File outFile)
Export the parameters in the XTCE file represented by an XTCEDatabase
object.
|
List<String> |
XTCEDatabaseExporter.exportParameters(File outFile)
Export the parameters in the XTCE file represented by an XTCEDatabase
object.
|
List<String> |
XTCEDatabaseExporterCsv.exportTelecommands(File outFile)
Export the telecommands in the XTCE file represented by an XTCEDatabase
object.
|
List<String> |
XTCEDatabaseExporter.exportTelecommands(File outFile)
Export the telecommands in the XTCE file represented by an XTCEDatabase
object.
|
BitSet |
XTCEContainerContentModelBase.extractRawValue(XTCEContainerContentEntry currentEntry)
Extracts the raw binary value from a container where the binary of the
container has been provided to this object.
|
protected XTCETMContainer |
XTCEContainerContentModelBase.findContainer(String containerRef,
XTCENamedObject currentContainer) |
protected XTCEParameter |
XTCEContainerContentModelBase.findParameter(String parameterRef,
XTCENamedObject currentContainer) |
protected XTCETelecommand |
XTCEContainerContentModelBase.findTelecommand(String metaCommandRef,
XTCENamedObject currentContainer) |
static XTCEAbsoluteTimeType |
XTCEFunctions.getAbsoluteTimeHandler(org.omg.space.xtce.AbsoluteTimeDataType element)
Method to locate a time handler for an XTCE AbsoluteTimeDataType
element.
|
XTCEArgument |
XTCETelecommand.getArgument(String name)
Retrieve a named Argument object from this Telecommand object.
|
XTCETMContainer |
XTCESpaceSystem.getContainer(String nameOrPath)
Retrieve a named SequenceContainer as a toolkit modeled XTCETMContainer
object from this Space System object.
|
XTCETMContainer |
XTCEDatabase.getContainer(String contFullPath)
Retrieve a specific container in the XTCE database by the fully
qualified path name to the container, using XTCE document path rules.
|
Document |
XTCEDatabaseParser.getDocument()
Method to return the document object from the Document Object Model
(DOM) of this XTCE document.
|
Element |
XTCEDatabaseParser.getDocumentElement()
Method to return the root document element from the Document Object
Model (DOM) of this XTCE document.
|
XTCETMStream |
XTCEDatabase.getStream(String name)
Function to retrieve a the Telemetry Streams that is defined in the
XTCE document.
|
XTCETelecommand |
XTCESpaceSystem.getTelecommand(String nameOrPath)
Retrieves a named Telecommand from this Space System as an
XTCETelecommand object.
|
XTCETelecommand |
XTCEDatabase.getTelecommand(String contFullPath)
Retrieve a specific telecommand in the XTCE database by the fully
qualified path name to the telecommand, using XTCE document path rules.
|
XTCEParameter |
XTCESpaceSystem.getTelecommandParameter(String name)
Retrieves a named TC Parameter from this Space System.
|
XTCEParameter |
XTCESpaceSystem.getTelemetryParameter(String name)
Retrieves a named TM Parameter from this Space System.
|
boolean |
XTCEContainerContentModelBase.isProcessingCompatible(BitSet rawBits)
Retrieve the compatibility of this container with the raw bits provided
by the caller to determine if this is the right model object to match
the binary.
|
protected org.omg.space.xtce.SpaceSystemType |
XTCEDatabaseParser.loadDatabase(File dbFile,
boolean validateOnLoad,
boolean applyXIncludes,
boolean readOnly)
Protected method to read/parse an XTCE XML document and populate the
internal data members for this object.
|
protected org.omg.space.xtce.SpaceSystemType |
XTCEDatabaseParser.loadDatabase(InputStream dbStream,
String path,
boolean validateOnLoad,
boolean applyXIncludes,
boolean readOnly)
Protected method to read/parse an XTCE XML document and populate the
internal data members for this object.
|
protected org.omg.space.xtce.SpaceSystemType |
XTCEDatabaseParser.loadDatabase(URL dbLocation,
boolean validateOnLoad,
boolean applyXIncludes,
boolean readOnly)
Protected method to read/parse an XTCE XML document and populate the
internal data members for this object.
|
String |
XTCEDocumentMarshaller.marshalToXml(JAXBElement xmlElement) |
protected org.omg.space.xtce.SpaceSystemType |
XTCEDatabaseParser.newDatabase(String spaceSystemName)
Method to create a new XTCE Document in memory, which is always created
in an editable state instead of read-only.
|
void |
XTCEDatabaseParser.normalizeDocument()
Method to normalize the whitespace in the XML Document Object Model to
make saved documents look clean.
|
long |
XTCEContainerContentModel.processContainer()
This method processes the contents of the entire container into
an ArrayList of XTCEContainerContentEntry objects.
|
XTCEContainerContentModel |
XTCEDatabase.processContainer(XTCETMContainer container,
BitSet binaryData)
Function to decompose an XTCETMContainer object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCEDatabase.processContainer(XTCETMContainer container,
byte[] bytes)
Function to decompose an XTCETMContainer object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCEDatabase.processContainer(XTCETMContainer container,
InputStream stream)
Function to decompose an XTCETMContainer object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCEDatabase.processContainer(XTCETMContainer container,
List<XTCEContainerEntryValue> userValues,
boolean showAllConditions)
Function to decompose an XTCETMContainer object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStream(BitSet binaryData)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStream(byte[] bytes)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStream(InputStream stream)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStreamIncludeOnly(BitSet binaryData,
List<XTCETMContainer> includeList)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStreamIncludeOnly(byte[] bytes,
List<XTCETMContainer> includeList)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStreamIncludeOnly(InputStream stream,
List<XTCETMContainer> includeList)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStreamWithExcludes(BitSet binaryData,
List<XTCETMContainer> excludeList)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStreamWithExcludes(byte[] bytes,
List<XTCETMContainer> excludeList)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCEContainerContentModel |
XTCETMStream.processStreamWithExcludes(InputStream stream,
List<XTCETMContainer> excludeList)
Function to decompose a binary data stream into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
long |
XTCETelecommandContentModel.processTelecommand()
This method processes the contents of the entire telecommand into
a List of XTCEContainerContentEntry objects.
|
XTCETelecommandContentModel |
XTCEDatabase.processTelecommand(XTCETelecommand telecommand,
BitSet binaryData)
Function to decompose an XTCETelecommand object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCETelecommandContentModel |
XTCEDatabase.processTelecommand(XTCETelecommand telecommand,
byte[] bytes)
Function to decompose an XTCETelecommand object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCETelecommandContentModel |
XTCEDatabase.processTelecommand(XTCETelecommand telecommand,
InputStream stream)
Function to decompose an XTCETelecommand object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
XTCETelecommandContentModel |
XTCEDatabase.processTelecommand(XTCETelecommand tcObject,
List<XTCEContainerEntryValue> userValues,
boolean showAllConditions)
Function to decompose an XTCETelecommand object into a simple array of
entries that an application can iterate over without the need to
resolve XTCE data model references, included additional containers,
base containers, and conditional processing.
|
protected void |
XTCEDatabaseParser.renameElement(Element element,
String newName)
Rename an Element node in the Document Object Model assuming that it is
the XTCE namespace but consider that the XTCE URI might be the default
namespace, in which case there is no prefix, or it could have the
xtce: prefix.
|
void |
XTCEDatabase.save(File dbFile)
Function to save the currently loaded database file.
|
protected void |
XTCEDatabaseParser.saveDatabase(File dbFile)
Method to write the current XTCE Document in memory to a File object.
|
String |
XTCETMStream.toXml()
Retrieve an XML string that represents this Stream element.
|
String |
XTCETMContainer.toXml()
Retrieve an XML string that represents this Container element.
|
String |
XTCETelecommand.toXml()
Retrieve an XML string that represents this MetaCommand element.
|
String |
XTCETCContainer.toXml()
Retrieve an XML string that represents this Container element.
|
String |
XTCEParameter.toXml()
Retrieve an XML string that represents this Parameter or Member
element.
|
String |
XTCEArgument.toXml()
Retrieve a string of the XML text for this Argument element.
|
String |
XTCETypedObject.typeToXml()
Retrieve an XML string that represents this typed object's "type"
element.
|
String |
XTCEArgument.typeToXml()
Retrieve an XML string that represents this argument object's "type"
element.
|
protected void |
XTCEDatabaseParser.updateHistorySet(List<String> messages)
Update the History elements in the XTCE document before saving, only if
the document uses the Header element.
|
static String |
XTCEFunctions.xmlPrettyPrint(NodeList nodes)
Method to format and "beautify" the XML text from a provided DOM
NodeList object.
|
static String |
XTCEFunctions.xmlPrettyPrint(String xmlText)
Method to format and "beautify" the XML text from a provided String
object containing XML ASCII text.
|
| Constructor and Description |
|---|
XTCEContainerContentModel(XTCETMContainer container,
List<XTCESpaceSystem> spaceSystems,
BitSet binaryData)
Constructor
This constructor creates the container content model object with TM
parameter values evaluated from the binary provided in a BitSet.
|
XTCEContainerContentModel(XTCETMContainer container,
List<XTCESpaceSystem> spaceSystems,
List<XTCEContainerEntryValue> userValues,
boolean showAllConditions)
Constructor
This constructor creates the container content model object with some
optional user values provided in a list.
|
XTCEDatabase(File dbFile,
boolean validateOnLoad,
boolean applyXIncludes,
boolean readOnly)
Constructor for use with an XTCE database file on the filesystem.
|
XTCEDatabase(InputStream istream,
File dbFile,
boolean validateOnLoad,
boolean applyXIncludes,
boolean readOnly)
Constructor for use with an XTCE database file from a stream.
|
XTCEDatabase(String topLevelSpaceSystemName)
Constructor for creating a new XTCE database object based on a top
level SpaceSystem element name.
|
XTCEDatabase(URL dbLocation,
boolean validateOnLoad,
boolean applyXIncludes,
boolean readOnly)
Constructor for use with an XTCE database file on the filesystem.
|
XTCEDatabaseCompressor(File file,
Properties options)
Constructor
Create and initialize an instance of the XTCE Database Compressor for
XML document compression.
|
XTCEDatabaseConverter(File file,
boolean useXInclude)
Constructor
Create and initialize an instance of the XTCE Database Converter for
schema 1.1 to 1.2.
|
XTCEDatabaseExporter(XTCEDatabase db,
Properties properties,
Charset charEncoding)
Constructor
The exporter object needs to be constructed with a list of properties.
|
XTCEDatabaseExporterCsv(XTCEDatabase db,
Properties properties,
Charset charEncoding)
Constructor
|
XTCETelecommandContentModel(XTCETelecommand tcObject,
List<XTCESpaceSystem> spaceSystems,
BitSet binaryData)
Constructor
This constructor creates the telecommand content model object with TC
argument values evaluated from the binary provided in a BitSet.
|
XTCETelecommandContentModel(XTCETelecommand tcObject,
List<XTCESpaceSystem> spaceSystems,
List<XTCEContainerEntryValue> userValues,
boolean showAllConditions)
Constructor
This constructor creates the telecommand content model object with some
optional user values provided in a list.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
ContainerDefaultValueDump.showContainerDefaultValues(String container,
String aliasNameSpace)
Method to display the found parameter default/initial values in the
user provided database container.
|
Copyright © 2015–2019. All rights reserved.