Package org.yamcs.xtce

Class Parameter

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.Parameter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SystemParameter

public class Parameter
extends NameDescription

A Parameter is a description of something that can have a value; it is not the value itself.

See Also:

• Serialized Form

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

Constructors

Constructor	Description
Parameter(String name)

Method Summary

Modifier and Type	Method	Description
DataSource	getDataSource()
Object	getInitialValue()
ParameterType	getParameterType()
String	getRecordingGroup()
boolean	isCommandParameter()	Return true if this parameter is used/valid in a commanding context: that is if the data source is DataSource.COMMAND or DataSource.COMMAND_HISTORY
boolean	isPersistent()
void	setDataSource(DataSource dataSource)
void	setInitialValue(Object initialValue)	Sets the initial value for the parameter (if any).
void	setParameterType(ParameterType pm)
void	setPersistent(boolean persistent)	If set, the parameter's value will be preserved during Yamcs restarts
void	setRecordingGroup(String g)
String	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

Methods inherited from class java.lang.Object

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

Constructor Details

Parameter

public Parameter(String name)

Method Details

getDataSource

public DataSource getDataSource()

setDataSource

public void setDataSource(DataSource dataSource)

setParameterType

public void setParameterType(ParameterType pm)

getParameterType

public ParameterType getParameterType()

getRecordingGroup

public String getRecordingGroup()

setRecordingGroup

public void setRecordingGroup(String g)

getInitialValue

public Object getInitialValue()

Returns:

the initial value of the parameter (if any)

setInitialValue

public void setInitialValue(Object initialValue)

Sets the initial value for the parameter (if any). The value has to be compatible with its type.

Parameters:

initialValue -

isCommandParameter

public boolean isCommandParameter()

Return true if this parameter is used/valid in a commanding context: that is if the data source is DataSource.COMMAND or DataSource.COMMAND_HISTORY

toString

public String toString()

Overrides:

toString in class Object

isPersistent

public boolean isPersistent()

setPersistent

public void setPersistent(boolean persistent)

If set, the parameter's value will be preserved during Yamcs restarts