NameDescription (Yamcs :: XTCE 5.1.0 API)

java.lang.Object
- org.yamcs.xtce.NameDescription

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AggregateDataType, Algorithm, Argument, ArrayDataType, BaseDataType, Container, Member, MetaCommand, Parameter, SpaceSystem
```
public class NameDescription
extends Object
implements Serializable
```
The type definition used by most elements that require a name with optional descriptions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NameDescription.Builder<T extends NameDescription.Builder<T>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`NameDescription.Builder<T extends NameDescription.Builder<T>>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AncillaryData>`	`ancillaryData` Escape hatch for storing any type of information
`protected String`	`name` Name of the object
`static char`	`PATH_SEPARATOR` path separator used in the fully qualified names
`protected String`	`qualifiedName` fully qualified name (i.e. space system name+"/"+name
`protected XtceAliasSet`	`xtceAliasSet` Set of aliases

Constructor Summary

Constructors
Modifier Constructor and Description

NameDescription(NameDescription.Builder<?> builder)

protected NameDescription(NameDescription t)

Constructors
Modifier	Constructor and Description
	`NameDescription(NameDescription.Builder<?> builder)`
`protected`	`NameDescription(NameDescription t)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlias(String namespace, String alias)`
`void`	`addAliases(XtceAliasSet newAliases)` Adds all aliases to the existing aliases.
`void`	`addAncillaryData(AncillaryData data)` Stores the given ancillary data.
`String`	`getAlias(String namespace)`
`XtceAliasSet`	`getAliasSet()`
`List<AncillaryData>`	`getAncillaryData()`
`String`	`getLongDescription()`
`String`	`getName()` Returns the non qualified name of the item
`static String`	`getName(String fqname)` returns the last component of the fully qualified name
`String`	`getOpsName()` OPS name, in XTCE defined as alias for namespace "MDB:OPS Name"
`String`	`getQualifiedName()` Returns the fully qualified name.
`String`	`getShortDescription()`
`String`	`getSubsystemName()`
`static String`	`getSubsystemName(String fqname)` returns the subsystem fully qualified name where this name is valid (i.e. the full path of the directory name if it were a filesystem)
`void`	`setAliasSet(XtceAliasSet aliasSet)` Assign set of aliases with the object.
`void`	`setAncillaryData(List<AncillaryData> ancillaryData)`
`void`	`setLongDescription(String longDescription)`
`void`	`setName(String newName)`
`void`	`setQualifiedName(String qname)`
`void`	`setShortDescription(String shortDescription)`

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

- Field Detail
  - PATH_SEPARATOR
```
public static char PATH_SEPARATOR
```
    path separator used in the fully qualified names
  - name
```
protected String name
```
    Name of the object
  - qualifiedName
```
protected String qualifiedName
```
    fully qualified name (i.e. space system name+"/"+name
  - xtceAliasSet
```
protected XtceAliasSet xtceAliasSet
```
    Set of aliases
  - ancillaryData
```
protected List<AncillaryData> ancillaryData
```
    Escape hatch for storing any type of information
- Constructor Detail
  - NameDescription
```
public NameDescription(NameDescription.Builder<?> builder)
```
  - NameDescription
```
protected NameDescription(NameDescription t)
```
- Method Detail
  - setName
```
public void setName(String newName)
```
  - getName
```
public String getName()
```
    Returns the non qualified name of the item
    
    Returns:
  - getAlias
```
public String getAlias(String namespace)
```
  - setQualifiedName
```
public void setQualifiedName(String qname)
```
  - addAncillaryData
```
public void addAncillaryData(AncillaryData data)
```
    Stores the given ancillary data. If an entry already existed for the applicable name, that entry will be overriden.
  - setAncillaryData
```
public void setAncillaryData(List<AncillaryData> ancillaryData)
```
  - getAncillaryData
```
public List<AncillaryData> getAncillaryData()
```
  - getQualifiedName
```
public String getQualifiedName()
```
    Returns the fully qualified name.
    
    Returns:
    
    a name of shape /system/subsys1/subsys2/item
  - setShortDescription
```
public void setShortDescription(String shortDescription)
```
  - getShortDescription
```
public String getShortDescription()
```
  - setLongDescription
```
public void setLongDescription(String longDescription)
```
  - getLongDescription
```
public String getLongDescription()
```
  - setAliasSet
```
public void setAliasSet(XtceAliasSet aliasSet)
```
    Assign set of aliases with the object. The previous aliases if any are replaced by the new ones.
    
    Parameters:
    
    aliasSet - Set of aliases
  - getAliasSet
```
public XtceAliasSet getAliasSet()
```
  - addAliases
```
public void addAliases(XtceAliasSet newAliases)
```
    Adds all aliases to the existing aliases. The new aliases may overwrite already existing aliases - in this case the old ones will be replaced with the new ones.
    
    Parameters:
    
    newAliases -
  - addAlias
```
public void addAlias(String namespace,
                     String alias)
```
  - getOpsName
```
public String getOpsName()
```
    OPS name, in XTCE defined as alias for namespace "MDB:OPS Name"
    
    Returns:
    
    OPS Name alias if defined, otherwise name in the default namespace
  - getSubsystemName
```
public String getSubsystemName()
```
    Returns:
    
    fully qualified name of the subsystem of which this name is part of
  - getName
```
public static String getName(String fqname)
```
    returns the last component of the fully qualified name
    
    Parameters:
    
    fqname -
    
    Returns:
  - getSubsystemName
```
public static String getSubsystemName(String fqname)
```
    returns the subsystem fully qualified name where this name is valid (i.e. the full path of the directory name if it were a filesystem)
    
    Parameters:
    
    fqname -
    
    Returns:
    
    the fully qualified name

Class NameDescription

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_SEPARATOR

name

qualifiedName

xtceAliasSet

ancillaryData

Constructor Detail

NameDescription

NameDescription

Method Detail

setName

getName

getAlias

setQualifiedName

addAncillaryData

setAncillaryData

getAncillaryData

getQualifiedName

setShortDescription

getShortDescription

setLongDescription

getLongDescription

setAliasSet

getAliasSet

addAliases

addAlias

getOpsName

getSubsystemName

getName

getSubsystemName