org.orekit.files.ccsds.ndm.odm

Class UserDefined

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.

Since:

11.0

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and 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 and Description
UserDefined() Create an empty data set.

Method Summary

Modifier and Type	Method and 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, 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