Parameter (Yamcs :: XTCE 5.4.2 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DataSource`	`getDataSource()`
`Object`	`getInitialValue()`
`ParameterType`	`getParameterType()`
`String`	`getRecordingGroup()`
`void`	`setDataSource(DataSource dataSource)`
`void`	`setInitialValue(Object initialValue)`	Sets the initial value for the parameter (if any).
`void`	`setParameterType(ParameterType pm)`
`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, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, setShortDescription

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- Parameter
```
public Parameter(String name)
```

Method Detail

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 -

toString
```
public String toString()
```
Overrides:

toString in class Object