Module org.yamcs.core

Package org.yamcs

Class StreamConfig

java.lang.Object

org.yamcs.StreamConfig

public class StreamConfig
extends Object

Stores the value of the streamConfiguration parameter from yamcs.instance.yaml Used to create the streams at Yamcs startup and by various other services (recording, processor, ...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StreamConfig.StandardStreamType
static class	StreamConfig.StreamConfigEntry
class	StreamConfig.TcStreamConfigEntry
class	StreamConfig.TmStreamConfigEntry

Method Summary

Modifier and Type	Method	Description
List<StreamConfig.StreamConfigEntry>	getEntries()	get all stream configurations
List<StreamConfig.StreamConfigEntry>	getEntries(StreamConfig.StandardStreamType type)	get stream configuration of a specific type.
StreamConfig.StreamConfigEntry	getEntry(StreamConfig.StandardStreamType type, String streamName)	returns the stream config with the given type and name or null if it has not been defined
static StreamConfig	getInstance(String yamcsInstance)
List<String>	getStreamNames(StreamConfig.StandardStreamType type)
List<StreamConfig.TcStreamConfigEntry>	getTcEntries()
StreamConfig.TcStreamConfigEntry	getTcEntry(String streamName)
List<StreamConfig.TmStreamConfigEntry>	getTmEntries()
StreamConfig.TmStreamConfigEntry	getTmEntry(String streamName)

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static StreamConfig getInstance(String yamcsInstance)
                                throws ConfigurationException

Throws:

ConfigurationException

getEntries

public List<StreamConfig.StreamConfigEntry> getEntries()

get all stream configurations

Returns:

a list of stream configuration

getStreamNames

public List<String> getStreamNames(StreamConfig.StandardStreamType type)

getEntries

public List<StreamConfig.StreamConfigEntry> getEntries(StreamConfig.StandardStreamType type)

get stream configuration of a specific type. Returns an empty list if no stream of that type has been defined

Returns:

a list of stream configuration of the given type

getEntry

public StreamConfig.StreamConfigEntry getEntry(StreamConfig.StandardStreamType type,
 String streamName)

returns the stream config with the given type and name or null if it has not been defined

Parameters:

type -

streamName -

Returns:

getTmEntry

public StreamConfig.TmStreamConfigEntry getTmEntry(String streamName)

getTmEntries

public List<StreamConfig.TmStreamConfigEntry> getTmEntries()

getTcEntry

public StreamConfig.TcStreamConfigEntry getTcEntry(String streamName)

getTcEntries

public List<StreamConfig.TcStreamConfigEntry> getTcEntries()