[Hamlib-stationserver] Domain Object Outline: What's in a Station?

[Art B. <ac...@in...>]

OK, we're starting to get into the tall grass now... not complicated, really, just a lot of detail.  And an outline isn't really adequate to describe all the details.  Still, before we start drawing UML diagrams maybe we can do an initial scope-check.  

So... here for discussion is a first, top-level and partial, draft for discussion of what logical objects we'll need to support in StationServer:

------------------------------
Domain Object Outline for “StationServer”
Draft for Discussion #1, 5 March 2014
 
Outline structure describes composition (“has a”) relationships.  ALL CAPS indicates an inheritance (“is a”) relationship.  “*” indicates that multiple instances may be present
 
STATION (defined as all equipment controlled by a single StationServer)

	* Power Source
		Voltage READING
		Current READING
		Max. Current (configuration constant)
		Name

	* Receiver
		Power Source (reference)
		* Frequency Range (configuration constants)
		Preamp
		RF Gain (Value CONTROL)
		Frequency
			Center, Carrier or slave to Mode setting (Select CONTROL)
			Value (Value CONTROL / READING)
		Mode / Modem
			Selection (Select CONTROL / READING)
			(various mode-specific controls and readings)
		* Filter (each has various controls and readings)
			Bandwidth
			Passband
			Roofing
			Notch
			Noise Blanker
			Digital Noise Reduction
			Audio Equalizer (Vector CONTROL)
		* Content Output Channel
			Audio
			Video
			Data
			Subchannel 
				(various readings for CTCSS, DCS, DV ID Text, etc.)
			Spectrum View
				Bandwidth (Value CONTROL)
				Dimension (Value CONTROL)
				Data (Vector READING)
		S-Meter (Value READING)
		Squelch Level (Value CONTROL)
		* RX-Inhibited-By (typically a reference to a Transmitter)
		Antenna Selection 
			(Select CONTROL / READING)
		Name

	* Transmitter
		Power Source (reference)
		Frequency
		Mode / Modem (various mode-specific controls and readings)
		Speech Processor
		* Content Input Channel
			Audio
			Video
			Data
			Subchannel 
				(various settings for CTCSS, DCS, DV ID Text, etc.)
		Transmit / PTT (Toggle CONTROL)
		VOX 
			On/Off
			Level
			Anti-VOX Level
			Delay
		RF Power Level (Value CONTROL)
		Power Amplifier
		Antenna Tuner
		Antenna Selection
		Name

	*  Antenna
		Description
		Name

	* Rotator
		Associated Antennas (references)
		Azimuth
		Elevation
		Name

	* Other Devices
		Readings
		Controls
		Name
 
....................................
Generic Classes
Outline structure describes subclasses (inheritance) except that items in parentheses are components.  (All object instances get unique names.)
 
CONTROL
	Trigger
	Toggle
	Select
		(List of legal values)
	Value
		(Range of legal values)
	Vector
		(Dimension / Number of Elements)
		(Range of possible values)
 
READING
	Event Signal
	Flag 
	Selection
		(List of possible values)
	Value
		(Range of possible values)
	Vector
		(Dimension / Number of Elements)
		(Range of possible values)
	Reference
		(Name of referenced object)