org.xtce.toolkit

Class XTCESpaceSystemMetrics

java.lang.Object

org.xtce.toolkit.XTCESpaceSystemMetrics

public class XTCESpaceSystemMetrics
extends Object

The XTCESpaceSystemMetrics class is instantiated by the toolkit to capture interesting information about the contents of an XTCE Space System. A "deep" or "recursive" count is performed when this object is constructed with an XTCEDatabase object and is shallow reflecting only one Space System when constructed using an XTCESpaceSystem object.

Author:

David Overeem

Constructor Summary

Constructors

Constructor and Description
XTCESpaceSystemMetrics(XTCEDatabase database) Constructor The constructor computes all the metrics for the provided Database object at construction time and cannot throw.
XTCESpaceSystemMetrics(XTCESpaceSystem spaceSystem) Constructor The constructor computes all the metrics for the provided Space System object at construction time and cannot throw.

Method Summary

Modifier and Type	Method and Description
long	getNumberOfChildSpaceSystems() Retrieve the number of child Space Systems in the counted Space System.
long	getNumberOfContainers() Retrieve the number of containers counted.
long	getNumberOfParameters() Retrieve the number of parameters counted.
long	getNumberOfParameterTypes() Retrieve the number of parameter types counted.
long	getNumberOfTelecommandArguments() Retrieve the number of telecommand arguments counted.
long	getNumberOfTelecommandArgumentTypes() Retrieve the number of telecommand argument types counted.
long	getNumberOfTelecommandContainers() Retrieve the number of telecommand containers counted.
long	getNumberOfTelecommandParameters() Retrieve the number of telecommand parameters counted.
long	getNumberOfTelecommandParameterTypes() Retrieve the number of telecommand parameter types counted.
long	getNumberOfTelecommands() Retrieve the number of telecommands counted.
long	getNumberOfTelemetryContainers() Retrieve the number of telemetry containers counted.
long	getNumberOfTelemetryParameters() Retrieve the number of telemetry parameters counted.
long	getNumberOfTelemetryParameterTypes() Retrieve the number of telemetry parameter types counted.
boolean	isDeepCount() Retrieve the type of count that was performed to construct these metrics.

Methods inherited from class java.lang.Object

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

Constructor Detail

XTCESpaceSystemMetrics

public XTCESpaceSystemMetrics(XTCESpaceSystem spaceSystem)

Constructor The constructor computes all the metrics for the provided Space System object at construction time and cannot throw. The accessors are trivial and just return the computed value. Values cannot be recomputed without reconstructing the object because the reference to the XTCESpaceSystem is not kept after construction.

Parameters:

spaceSystem - The XTCESpaceSystem object to count.

XTCESpaceSystemMetrics

public XTCESpaceSystemMetrics(XTCEDatabase database)

Constructor The constructor computes all the metrics for the provided Database object at construction time and cannot throw. The accessors are trivial and just return the computed value. Values cannot be recomputed without reconstructing the object because the reference to the XTCEDatabase is not kept after construction.

Parameters:

database - The XTCEDatabase object to count.

Method Detail

isDeepCount

public boolean isDeepCount()

Retrieve the type of count that was performed to construct these metrics. The "deep" or "recursive" count is performed when this object is constructed with an XTCEDatabase object and is shallow reflecting only one Space System when constructed using an XTCESpaceSystem object.

Returns:

Boolean indicating if the count is for an entire database or false when it is just one Space System in a database object.

getNumberOfChildSpaceSystems

public long getNumberOfChildSpaceSystems()

Retrieve the number of child Space Systems in the counted Space System.

Returns:

long indicating the number of Space Systems that are children of this Space System or the total number of Space Systems when this object is a "deep" count.

getNumberOfTelemetryParameters

public long getNumberOfTelemetryParameters()

Retrieve the number of telemetry parameters counted.

Returns:

long containing the number of telemetry parameters in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelecommandParameters

public long getNumberOfTelecommandParameters()

Retrieve the number of telecommand parameters counted.

Returns:

long containing the number of telecommand parameters in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfParameters

public long getNumberOfParameters()

Retrieve the number of parameters counted.

Returns:

long containing the number of all parameters in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelemetryParameterTypes

public long getNumberOfTelemetryParameterTypes()

Retrieve the number of telemetry parameter types counted.

Returns:

long containing the number of telemetry parameter types in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelecommandParameterTypes

public long getNumberOfTelecommandParameterTypes()

Retrieve the number of telecommand parameter types counted.

Returns:

long containing the number of telecommand parameter types in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfParameterTypes

public long getNumberOfParameterTypes()

Retrieve the number of parameter types counted.

Returns:

long containing the number of all parameter types in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelecommandArguments

public long getNumberOfTelecommandArguments()

Retrieve the number of telecommand arguments counted.

Returns:

long containing the number of telecommand arguments in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelecommandArgumentTypes

public long getNumberOfTelecommandArgumentTypes()

Retrieve the number of telecommand argument types counted.

Returns:

long containing the number of telecommand argument types in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelemetryContainers

public long getNumberOfTelemetryContainers()

Retrieve the number of telemetry containers counted.

Returns:

long containing the number of telemetry containers in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelecommandContainers

public long getNumberOfTelecommandContainers()

Retrieve the number of telecommand containers counted.

Returns:

long containing the number of telecommand containers in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfContainers

public long getNumberOfContainers()

Retrieve the number of containers counted.

Returns:

long containing the number of all containers in the counted Space System or the total number in the database when this object is a "deep" count.

getNumberOfTelecommands

public long getNumberOfTelecommands()

Retrieve the number of telecommands counted.

Returns:

long containing the number of telecommands in the counted Space System or the total number in the database when this object is a "deep" count. Both MetaCommand and BlockMetaCommand elements are considered telecommands for this purpose.