Package org.yamcs.xtce
Class SpaceSystem
java.lang.Object
org.yamcs.xtce.NameDescription
org.yamcs.xtce.SpaceSystem
- All Implemented Interfaces:
Serializable
SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and
sub-systems. A SpaceSystem is the root element for the set of data necessary to monitor and command an arbitrary
space device - this includes the binary decomposition the data streams going into and out of a device.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.yamcs.xtce.NameDescription
NameDescription.Builder<T extends NameDescription.Builder<T>>
-
Field Summary
Fields inherited from class org.yamcs.xtce.NameDescription
ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAlgorithm
(Algorithm algorithm) void
addArgumentType
(ArgumentType argumentType) void
addCommandContainer
(CommandContainer cmdContainer) void
addMetaCommand
(MetaCommand command) void
Add non-standard data to this SpaceSystem.void
addParameter
(Parameter parameter) void
addParameterType
(ParameterType parameterType) void
addSequenceContainer
(SequenceContainer container) Register the containervoid
void
tries to resolve the reference immediately in the current system; if it cannot, add it to the list of unresolved references - the reference will be resolved when all parts are availablegetAlgorithm
(String algoName) int
getAlgorithmCount
(boolean recurse) getArgumentType
(String typeName) getCommandContainer
(String name) getMetaCommand
(String refName) getMetaCommandByAlias
(String alias) int
getMetaCommandCount
(boolean recurse) <T extends NonStandardData>
TgetNonStandardDataOfType
(Class<T> clazz) getParameter
(String refName) getParameterByAlias
(String alias) Searches through all namespaces for a parameter with the given alias.int
getParameterCount
(boolean recurse) Returns the direct sub parameters of this space systemgetParameters
(boolean recurse) Returns the parameters defined in this space system, or under any of its sub space systemsgetParameterType
(String typeName) int
getParameterTypeCount
(boolean recurse) getSequenceContainer
(String refName) int
getSequenceContainerCount
(boolean recurse) getSubsystem
(String sname) void
remove parameter from SpaceSystem - only used during loading or from XtceDb XtceDb has several maps pointing to these parameters.boolean
removeParameterType
(ParameterType ptype) void
void
setParent
(SpaceSystem parent) toString()
Methods inherited from class org.yamcs.xtce.NameDescription
addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, qualifiedName, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, setShortDescription
-
Constructor Details
-
SpaceSystem
-
-
Method Details
-
setHeader
-
addSequenceContainer
Register the container- Parameters:
container
- Container to be registered
-
addParameter
- Throws:
IllegalArgumentException
-
addParameterType
-
removeParameterType
-
addArgumentType
-
addAlgorithm
-
addMetaCommand
-
getMetaCommand
-
getParameterType
-
getArgumentType
-
getSequenceContainer
-
addCommandContainer
-
getCommandContainer
-
getAlgorithm
-
getParameter
-
addSpaceSystem
- Throws:
IllegalArgumentException
-
addUnresolvedReference
tries to resolve the reference immediately in the current system; if it cannot, add it to the list of unresolved references - the reference will be resolved when all parts are available -
getSequenceContainers
-
getCommandContainers
-
getSequenceContainerCount
public int getSequenceContainerCount(boolean recurse) -
getParameters
Returns the direct sub parameters of this space system -
getParameters
Returns the parameters defined in this space system, or under any of its sub space systems -
getParameterCount
public int getParameterCount(boolean recurse) -
getParameterTypes
-
getParameterTypeCount
public int getParameterTypeCount(boolean recurse) -
getArgumentTypes
-
getSubSystems
-
getAlgorithms
-
getAlgorithmCount
public int getAlgorithmCount(boolean recurse) -
getMetaCommands
-
removeParameter
remove parameter from SpaceSystem - only used during loading or from XtceDb XtceDb has several maps pointing to these parameters.- Parameters:
p
- parameter to remove
-
getMetaCommandCount
public int getMetaCommandCount(boolean recurse) -
getUnresolvedReferences
-
setParent
-
getParent
-
getSubsystem
-
getRootSequenceContainer
-
getHeader
-
addNonStandardData
Add non-standard data to this SpaceSystem. This enables loading any kind of data from within custom SpaceSystemLoaders and making it available through the XtceDb.Non-standard data is distinguished from each other using the classname. Only one object is allowed for each classname.
-
getNonStandardDataOfType
-
getNonStandardData
-
toString
-
getParameterByAlias
Searches through all namespaces for a parameter with the given alias. Returns a list with all matches. This is an expensive operation as it iterates over all parameters- Parameters:
alias
-- Returns:
- a list of parameters matching the alias. If no alias matches the list will be empty.
-
getSequenceContainerByAlias
-
getMetaCommandByAlias
-