ska_oso_pdm.schemas.csp
The schemas.csp.csp_configuration module defines Marshmallow schemas that map the CSP definition section of an SKA scheduling block to/from JSON.
- class CSPConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the ska_oso_pdm.CSPConfiguration class
- cbf_config
alias of
CBFConfigurationSchema
- common_config
alias of
CommonConfigurationSchema
- create(data, **_)
Convert parsed JSON back into a CSPConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
CSPConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for SubArrayNode configuration
- lowcbf_config
alias of
LowCBFConfigurationSchema
- subarray_config
alias of
SubarrayConfigurationSchema
The schemas.csp.common module defines Marshmallow schemas that map the common section of the CSP definition section of an SKA scheduling block to/from JSON.
- class CommonConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the CommonConfigurationSchema
- create(data, **_)
Convert parsed JSON back into a CSPConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
CommonConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for FSP configuration
The schemas.csp.cbf module defines Marshmallow schemas that map the MID CBF section of the CSP definition section of an SKA scheduling block to/from JSON.
- class CBFConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the CBFConfigurationSchema
- create(data, **_)
Convert parsed JSON back into a CBFConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
CBFConfiguration instance populated to match JSON
- Return type:
- fsp_configs
alias of
FSPConfigurationSchema
- class FSPConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the FSPConfiguration
- create(data, **_)
Convert parsed JSON back into a FSPConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
FSPConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict suitable for FSP configuration
- function_mode
alias of
FSPFunctionMode
The schemas.csp.lowcbf module defines Marshmallow schemas that map the LOWCBF section of the CSP definition section of an SKA scheduling block to/from JSON.
- class LowCBFConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a LowCBFConfigurationSchema instance
- create(data, **_)
Convert parsed JSON back into a LowCBFConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
LowCBFConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes the LOWCBF configuration specification
- stations
alias of
StationConfigurationSchema
- vis
alias of
VisConfigurationSchema
- class StationBeamConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a StationBeamConfiguration instance
- create(data, **_)
Convert parsed JSON back into a StationBeamConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
StationBeamConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes a station beam configuration
- class StationBeamHostSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a StationBeamHost instance
- create(data, **_)
Convert parsed JSON back into a StationBeamHost object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
StationBeamHost instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes a station beam SDP channel and host.
- class StationBeamMacSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a StationBeamMac instance
- create(data, **_)
Convert parsed JSON back into a StationBeamMac object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
StationBeamMac instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes a station beam SDP channel and server MAC
- class StationBeamPortSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a StationBeamPort instance
- create(data, **_)
Convert parsed JSON back into a StationBeamPort object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
StationBeamPort instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes a station beam SDP channel and UDP port and stride
- class StationConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a StationConfiguration instance
- create(data, **_)
Convert parsed JSON back into a StationConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
StationConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes the SDP visibility destinations
- class VisConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a VisConfigurationSchema instance
- create(data, **_)
Convert parsed JSON back into a VisConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
VisConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes the visibility output descriptions
- fsp
alias of
VisFSPConfigurationSchema
- class VisFSPConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a VisFSPConfiguration instance
- create(data, **_)
Convert parsed JSON back into a VisFSPConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
VisFSPConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes the FSPs used for correlation
- class VisStationBeamConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema to serialise and deserialise a VisStationBeamConfiguration instance
- create(data, **_)
Convert parsed JSON back into a VisStationBeamConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
VisStationBeamConfiguration instance populated to match JSON
- filter_nulls(data, **_)
Filter out null values from JSON.
- Parameters:
data – Marshmallow-provided dict containing parsed object values
_ – kwargs passed by Marshmallow
- Returns:
dict that describes a visstationbeamconfiguration
The schemas.csp.subarray module defines Marshmallow schemas that map the subarray section of the CSP definition section of an SKA scheduling block to/from JSON.
- class SubarrayConfigurationSchema(*args: Any, **kwargs: Any)[source]
Marshmallow schema for the SubarrayConfigurationSchema
- create(data, **_)
Convert parsed JSON back into a SubarrayConfiguration object.
- Parameters:
data – dict containing parsed JSON values
_ – kwargs passed by Marshmallow
- Returns:
SubarrayConfiguration instance populated to match JSON
- Return type: