org.yamcs.xtce

Class AggregateDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.AggregateDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

AggregateArgumentType, AggregateParameterType

public class AggregateDataType
extends NameDescription
implements DataType

See Also:

Serialized Form

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregateDataType(AggregateDataType t)
	AggregateDataType(String name)

Method Summary

Modifier and Type	Method and Description
void	addMember(Member memberType)
void	addMembers(List<Member> memberList)
Member	getMember(String name) Returns a member on the given name.
Member	getMember(String[] path) Returns a member in a hierarchical aggregate.
List<Member>	getMemberList()
AggregateMemberNames	getMemberNames()
String	getTypeAsString() String which represents the type.
Yamcs.Value.Type	getValueType() Return the expected Value type of an engineering value conforming to this XTCE data type
void	setInitialValue(String initialValue) Sets the initial value converting from string to the specific type value

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, toString, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.DataType

getName

Constructor Detail

AggregateDataType

public AggregateDataType(String name)

AggregateDataType

protected AggregateDataType(AggregateDataType t)

Method Detail

addMember

public void addMember(Member memberType)

addMembers

public void addMembers(List<Member> memberList)

getTypeAsString

public String getTypeAsString()

Description copied from interface: DataType

String which represents the type. This string will be presented to the users of the system.

Specified by:

getTypeAsString in interface DataType

Returns:

getMember

public Member getMember(String name)

Returns a member on the given name. If no such member is present return null

Parameters:

name - the name of the member to be returned

Returns:

the member with the given name

getMemberList

public List<Member> getMemberList()

getValueType

public Yamcs.Value.Type getValueType()

Description copied from interface: DataType

Return the expected Value type of an engineering value conforming to this XTCE data type

Specified by:

getValueType in interface DataType

Returns:

getMember

public Member getMember(String[] path)

Returns a member in a hierarchical aggregate. It is equivalent with a chained call of getMember(String):

 getMember(path[0]).getMember(path[1])...getMember(path[n])
 

assuming that all the elements on the path exist.

Parameters:

path - - the path to be traversed. Its length has to be at least 1 - otherwise an IllegalArgumentException will be thrown.

Returns:

the member obtained by traversing the path or null if not such member exist.

setInitialValue

public void setInitialValue(String initialValue)

Description copied from interface: DataType

Sets the initial value converting from string to the specific type value

Specified by:

setInitialValue in interface DataType

getMemberNames

public AggregateMemberNames getMemberNames()

Returns:

the (unique) object encoding the member names