- All Implemented Interfaces:
Serializable
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a new command definition to the XTCE db.void
addParameter
(Parameter p, boolean createSpaceSystem) Adds a new parameter to the XTCE db.void
addParameterType
(ParameterType ptype, boolean createSpaceSystem) Adds a new parameter type to the XTCE db.void
addSpaceSystem
(SpaceSystem system) Adds a newSpaceSystem
to the XTCE database.Adds a parameter type to the MDB.void
Called after the database has been populated to build the maps for quickly finding thingsboolean
containsNamespace
(String namespace) createSystemParameter
(String parameterQualifiedNamed, ParameterType ptype, String shortDescription) Creates and returns a system parameter with the given qualified name.getAlgorithm
(String qualifiedName) getAlgorithm
(String namespace, String name) getIndirectParameterRefEntries
(String namespace) Retrieve the list ofIndirectParameterRefEntry
for a given alias namespace.getInheritingContainers
(SequenceContainer container) Get the list of containers inheriting from the given containergetMetaCommand
(String qualifiedName) Returns a meta command by fully qualified name.getMetaCommand
(String namespace, String name) Returns a command based on a name in a namespaceReturns the list of MetaCommmands in the XTCE database<T extends NonStandardData<T>>
TgetNonStandardDataOfType
(Class<T> clazz) getParameter
(String qualifiedName) getParameter
(String namespace, String name) getParameterType
(String qualifiedName) getParameterType
(String namespace, String name) getSequenceContainer
(String qualifiedName) getSequenceContainer
(String namespace, String name) getSpaceSystem
(String qualifiedName) getSpaceSystem
(String namespace, String name) Returns a collection of all theSpaceSystem
objects in the XTCE database.static boolean
isSystemParameter
(String fqn) Checks if a fully qualified name is the name of a system parameter.static boolean
Checks if the named object refers to a system parameter: either the namespace starts withYAMCS_SPACESYSTEM_NAME
or there is no namespace and the fully qualified name starts withYAMCS_SPACESYSTEM_NAME
void
print
(PrintStream out) void
static Yamcs.NamedObjectId
toNamedObjectId
(String qualifiedName)
-
Field Details
-
YAMCS_SPACESYSTEM_NAME
Namespaces system parameters- See Also:
-
YAMCS_CMD_SPACESYSTEM_NAME
- See Also:
-
YAMCS_CMDARG_SPACESYSTEM_NAME
- See Also:
-
YAMCS_CMDHIST_SPACESYSTEM_NAME
- See Also:
-
-
Constructor Details
-
XtceDb
-
-
Method Details
-
getSequenceContainer
-
getSequenceContainer
-
getSequenceContainer
-
getParameter
-
toNamedObjectId
-
getParameter
-
getParameter
-
getParameterType
-
getParameterType
-
getParameterType
-
getRootSequenceContainer
-
setRootSequenceContainer
-
getAlgorithm
-
getAlgorithm
-
getAlgorithm
-
getAlgorithms
-
getParameters
-
getParameterTypes
-
containsNamespace
-
getNamespaces
-
getMetaCommand
Returns a meta command by fully qualified name.- Parameters:
qualifiedName
- - fully qualified name of the command to be returned.- Returns:
- the meta command having the given qualified name. If no such command exists,
null
is returned.
-
getMetaCommand
Returns a command based on a name in a namespace- Parameters:
namespace
-name
-- Returns:
- the meta command having the given name in the given namespace. If no such meta command exists,
null
is returned.
-
getMetaCommand
-
getMetaCommands
Returns the list of MetaCommmands in the XTCE database- Returns:
-
getRootSpaceSystem
-
getSpaceSystem
-
getSpaceSystem
-
getSpaceSystem
-
getSequenceContainers
-
getParameterEntries
- Returns:
- list of ParameterEntry corresponding to a given parameter or
null
if no such entry exists.
-
getContainerEntries
- Returns:
- list of ContainerEntry corresponding to a given sequence container or
null
if no such entry exists.
-
getParameterNames
-
getNonStandardDataOfType
-
getNonStandardData
-
buildIndexMaps
public void buildIndexMaps()Called after the database has been populated to build the maps for quickly finding things -
getInheritingContainers
Get the list of containers inheriting from the given container- Parameters:
container
-- Returns:
-
addParameter
Adds a new parameter to the XTCE db. If the SpaceSystem where this parameter belongs does not exist, and createSpaceSystem is false, throws an IllegalArgumentException If the SpaceSystem where this parameter belongs exists and already contains an parameter by this name, throws and IllegalArgumentException If the SpaceSystem where this parameter belongs does not exist, and createSpaceSystem is true, the whole SpaceSystem hierarchy is created. Note that this method is used to create parameters on the fly. The parameters are not saved anywhere and they will not be available when this object is created by the XtceDbFactory.- Parameters:
p
-createSpaceSystem
- - if true, create all the necessary space systems
-
addParameterType
Adds a new parameter type to the XTCE db.If the SpaceSystem where this parameter type does not exist, and createSpaceSystem is false, throws an IllegalArgumentException.
If the SpaceSystem where this parameter belongs exists and already contains an parameter type by this name, throws and IllegalArgumentException
If the SpaceSystem where this parameter belongs does not exist, and createSpaceSystem is true, the whole SpaceSystem hierarchy is created.
- Parameters:
ptype
- - the parameter type to be addedcreateSpaceSystem
- - if true, create all the necessary space systems
-
createSystemParameter
public SystemParameter createSystemParameter(String parameterQualifiedNamed, ParameterType ptype, String shortDescription) Creates and returns a system parameter with the given qualified name. If the parameter already exists it is returned.- Parameters:
parameterQualifiedNamed
- - the name of the parmaeter to be created. It must start withYAMCS_SPACESYSTEM_NAME
ptype
-- Returns:
- the parameter created or already existing.
- Throws:
IllegalArgumentException
- if theparameterQualifiedNamed
does not start withYAMCS_SPACESYSTEM_NAME
-
addSystemParameterType
Adds a parameter type to the MDB. The type has to have the qualified name set and start withYAMCS_SPACESYSTEM_NAME
.If a type with the same name already exists, it is returned instead. No check is performed that the existing type and the new type are the same or even compatible.
- Parameters:
ptype
-- Returns:
-
addMetaCommand
Adds a new command definition to the XTCE db.Note that this method is used to create commands on the fly.
The commands are not saved anywhere and they will not be available when this object is created with the XtceDbFactory. -
addSpaceSystem
Adds a newSpaceSystem
to the XTCE database. It throws an IllegalArgumentException in the following circumstances:- if a SpaceSystem with this name already exists
- if
system.getParent()
does not return null - if the parent SpaceSystem (identified based on the
NameDescription.getSubsystemName()
) does not exist - if the space system is not empty
- Parameters:
system
- - the space system to be added.
-
isSystemParameter
Checks if the named object refers to a system parameter:- either the namespace starts with
YAMCS_SPACESYSTEM_NAME
- or there is no namespace and the fully qualified name starts with
YAMCS_SPACESYSTEM_NAME
- Parameters:
id
-- Returns:
- either the namespace starts with
-
isSystemParameter
Checks if a fully qualified name is the name of a system parameter. That is iffqn
starts withYAMCS_SPACESYSTEM_NAME
- Parameters:
fqn
-- Returns:
-
getSpaceSystems
Returns a collection of all theSpaceSystem
objects in the XTCE database.- Returns:
- the collection of space systems.
-
getIndirectParameterRefEntries
Retrieve the list ofIndirectParameterRefEntry
for a given alias namespace.- Parameters:
namespace
- - the namespace for which the indirect parameter reference entries should be retrieved. Can be null to return the entries without a namespace.- Returns:
- the list of indirect parameter reference entries whose alias namespace is equal to the given namespace.
If no such entry exists,
null
is returned.
-
print
-