ska_oso_pdm.schemas.csp.common
The schemas.csp_schema defines Marshmallow schemas that map 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 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
- subarray_config
alias of
SubarrayConfigurationSchema
- 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
- 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
- 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: