UserDefined (OREKIT 13.0-SNAPSHOT API)

File failed to load: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/extensions/TeX/autoload.js

java.lang.Object
- org.orekit.files.ccsds.section.CommentsContainer
- - org.orekit.files.ccsds.ndm.odm.UserDefined

All Implemented Interfaces:

Section
```
public class UserDefined
extends CommentsContainer
```
Container for user defined data.
Beware that the Orekit getters and setters all rely on SI units. The parsers and writers take care of converting these SI units into CCSDS mandatory units. The Unit class provides useful fromSi and toSI methods in case the callers already use CCSDS units instead of the API SI units. The general-purpose Unit class (without an 's') and the CCSDS-specific Units class (with an 's') also provide some predefined units. These predefined units and the fromSi and toSI conversion methods are indeed what the parsers and writers use for the conversions.

Since:

11.0

Author:

Luc Maisonobe

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`USER_DEFINED_PREFIX`	Prefix for user defined parameters keys.
`static String`	`USER_DEFINED_XML_ATTRIBUTE`	Attribute name for user defined parameters keys.
`static String`	`USER_DEFINED_XML_TAG`	Tag name for user defined parameters keys.

Constructor Summary

Constructors
Constructor Description

UserDefined()
Create an empty data set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addEntry(String key, String value)`	Add a key/value entry.
`Map<String,String>`	`getParameters()`	Get all user defined parameters.

Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer
acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments, setComments, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USER_DEFINED_XML_TAG
```
public static final String USER_DEFINED_XML_TAG
```
    Tag name for user defined parameters keys.
    
    See Also:
    
    Constant Field Values
  - USER_DEFINED_XML_ATTRIBUTE
```
public static final String USER_DEFINED_XML_ATTRIBUTE
```
    Attribute name for user defined parameters keys.
    
    See Also:
    
    Constant Field Values
  - USER_DEFINED_PREFIX
```
public static final String USER_DEFINED_PREFIX
```
    Prefix for user defined parameters keys.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserDefined
```
public UserDefined()
```
    Create an empty data set.
- Method Detail
  - getParameters
```
public Map<String,String> getParameters()
```
    Get all user defined parameters.
    The USER_DEFINED_PREFIX has been stripped away from the keys.
    
    Returns:
    
    unmodifiable view of the map containing all user defined parameters
  - addEntry
```
public void addEntry(String key,
                     String value)
```
    Add a key/value entry.
    
    Parameters:
    
    key - parameter key, with the USER_DEFINED_PREFIX stripped away
    
    value - parameter value