org.yamcs.xtce

Class SpaceSystem

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.SpaceSystem

All Implemented Interfaces:

Serializable

public class SpaceSystem
extends NameDescription

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:

Serialized Form

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor and Description
SpaceSystem(String name)

Method Summary

Modifier and Type	Method and Description
void	addAlgorithm(Algorithm algorithm)
void	addArgumentType(ArgumentType argumentType)
void	addCommandContainer(CommandContainer cmdContainer)
void	addMetaCommand(MetaCommand command)
void	addNonStandardData(NonStandardData data) Add non-standard data to this SpaceSystem.
void	addParameter(Parameter parameter)
void	addParameterType(ParameterType parameterType)
void	addSequenceContainer(SequenceContainer container) Register the container
void	addSpaceSystem(SpaceSystem ss)
void	addUnresolvedReference(NameReference nr)
Algorithm	getAlgorithm(String algoName)
int	getAlgorithmCount(boolean recurse)
Collection<Algorithm>	getAlgorithms()
ArgumentType	getArgumentType(String typeName)
CommandContainer	getCommandContainer(String name)
Header	getHeader()
MetaCommand	getMetaCommand(String refName)
List<MetaCommand>	getMetaCommandByAlias(String alias)
int	getMetaCommandCount(boolean recurse)
Collection<MetaCommand>	getMetaCommands()
Collection<NonStandardData>	getNonStandardData()
<T extends NonStandardData> T	getNonStandardDataOfType(Class<T> clazz)
Parameter	getParameter(String refName)
List<Parameter>	getParameterByAlias(String alias) Searches through all namespaces for a parameter with the given alias.
int	getParameterCount(boolean recurse)
Collection<Parameter>	getParameters() Returns the direct sub parameters of this space system
Collection<Parameter>	getParameters(boolean recurse) Returns the parameters defined in this space system, or under any of its sub space systems
ParameterType	getParameterType(String typeName)
Collection<ParameterType>	getParameterTypes()
SpaceSystem	getParent()
SequenceContainer	getRootSequenceContainer()
SequenceContainer	getSequenceContainer(String refName)
List<SequenceContainer>	getSequenceContainerByAlias(String alias)
int	getSequenceContainerCount(boolean recurse)
Collection<SequenceContainer>	getSequenceContainers()
SpaceSystem	getSubsystem(String sname)
Collection<SpaceSystem>	getSubSystems()
List<NameReference>	getUnresolvedReferences()
void	removeParameter(Parameter p) remove parameter from SpaceSystem - only used during loading or from XtceDb XtceDb has several maps pointing to these parameters.
void	setHeader(Header h)
void	setParent(SpaceSystem parent)
void	setRootSequenceContainer(SequenceContainer sc)
String	toString()

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getAncillaryDataSet, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, setAliasSet, setLongDescription, setName, setQualifiedName, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpaceSystem

public SpaceSystem(String name)

Method Detail

setHeader

public void setHeader(Header h)

addSequenceContainer

public void addSequenceContainer(SequenceContainer container)

Register the container

Parameters:

container - Container to be registered

addParameter

public void addParameter(Parameter parameter)
                  throws IllegalArgumentException

Throws:

IllegalArgumentException

addParameterType

public void addParameterType(ParameterType parameterType)

addArgumentType

public void addArgumentType(ArgumentType argumentType)

addAlgorithm

public void addAlgorithm(Algorithm algorithm)

addMetaCommand

public void addMetaCommand(MetaCommand command)

getMetaCommand

public MetaCommand getMetaCommand(String refName)

getParameterType

public ParameterType getParameterType(String typeName)

getArgumentType

public ArgumentType getArgumentType(String typeName)

getSequenceContainer

public SequenceContainer getSequenceContainer(String refName)

addCommandContainer

public void addCommandContainer(CommandContainer cmdContainer)

getCommandContainer

public CommandContainer getCommandContainer(String name)

getAlgorithm

public Algorithm getAlgorithm(String algoName)

getParameter

public Parameter getParameter(String refName)

addSpaceSystem

public void addSpaceSystem(SpaceSystem ss)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

addUnresolvedReference

public void addUnresolvedReference(NameReference nr)

getSequenceContainers

public Collection<SequenceContainer> getSequenceContainers()

getSequenceContainerCount

public int getSequenceContainerCount(boolean recurse)

getParameters

public Collection<Parameter> getParameters()

Returns the direct sub parameters of this space system

getParameters

public Collection<Parameter> getParameters(boolean recurse)

Returns the parameters defined in this space system, or under any of its sub space systems

getParameterCount

public int getParameterCount(boolean recurse)

getParameterTypes

public Collection<ParameterType> getParameterTypes()

getSubSystems

public Collection<SpaceSystem> getSubSystems()

getAlgorithms

public Collection<Algorithm> getAlgorithms()

getAlgorithmCount

public int getAlgorithmCount(boolean recurse)

getMetaCommands

public Collection<MetaCommand> getMetaCommands()

removeParameter

public void removeParameter(Parameter p)

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

public List<NameReference> getUnresolvedReferences()

setParent

public void setParent(SpaceSystem parent)

getParent

public SpaceSystem getParent()

getSubsystem

public SpaceSystem getSubsystem(String sname)

getRootSequenceContainer

public SequenceContainer getRootSequenceContainer()

setRootSequenceContainer

public void setRootSequenceContainer(SequenceContainer sc)

getHeader

public Header getHeader()

addNonStandardData

public void addNonStandardData(NonStandardData data)

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

public <T extends NonStandardData> T getNonStandardDataOfType(Class<T> clazz)

getNonStandardData

public Collection<NonStandardData> getNonStandardData()

toString

public String toString()

Overrides:

toString in class Object

getParameterByAlias

public List<Parameter> getParameterByAlias(String alias)

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

public List<SequenceContainer> getSequenceContainerByAlias(String alias)

getMetaCommandByAlias

public List<MetaCommand> getMetaCommandByAlias(String alias)