ts::SAT::beam_hopping_time_plan_info_type Class Reference

Representation of a beam hopping time plan, identified by the beamhopping_time_plan_id with information relating to the period(s) in time that the beam will illuminate the cell each beamhopping cycle. More...

#include <tsSAT.h>

Inheritance diagram for ts::SAT::beam_hopping_time_plan_info_type:

Collaboration diagram for ts::SAT::beam_hopping_time_plan_info_type:

Classes
class	slot
	Indicates if there is a transmission in the respective timeslot. More...

Public Member Functions
	beam_hopping_time_plan_info_type ()=default
	Default constructor.
	beam_hopping_time_plan_info_type (PSIBuffer &buf)
	Read-in constructor.
virtual void	deserialize (PSIBuffer &buf) override
	This method deserializes (populates) the attributes of a geostationary satellite.
virtual bool	fromXML (const xml::Element *element) override
	This method populates this object from XML attributes and sub-element.
uint16_t	plan_length (void) const
	Determines the size of this iteration of a beam hopping time plan to allow quick jumping to the next iteration.
virtual void	serialize (PSIBuffer &buf) const override
	This method serializes the attributes of a geostationary satellite.
uint8_t	time_plan_mode (void) const
	Determines the time plan mode for this beam hopping time plan.
virtual void	toXML (xml::Element *root) override
	This method converts this object to XML by populating necessary attributes and sub-elements into the provided element.

Public Attributes
uint32_t	beamhopping_time_plan_id = 0
	Label to identify the beamhopping time plan that is detailed in this loop.
std::optional< uint16_t >	current_slot {}
	15 bits.The slot in which the transmission of this table started.
NCR_type	cycle_duration {}
	Duration in NCR of cycle duration.
std::optional< NCR_type >	dwell_duration {}
	Duration in NCR of dwell duration.
std::optional< NCR_type >	grid_size {}
	The duration in NCR of grid size.
std::optional< NCR_type >	on_time {}
	NCR of on time.
std::optional< NCR_type >	revisit_duration {}
	The maximal duration of time by which a cell is not illuminated, when not in sleep mode.
std::optional< NCR_type >	sleep_duration {}
	Duration in NCR of sleep duration.
std::optional< NCR_type >	sleep_time {}
	The NCR time when the sleep mode will be entered.
std::vector< slot >	slot_transmission_on {}
	Indicates if there is a transmission in the respective timeslot.
NCR_type	time_of_application {}
	NCR of time of application.

Detailed Description

Representation of a beam hopping time plan, identified by the beamhopping_time_plan_id with information relating to the period(s) in time that the beam will illuminate the cell each beamhopping cycle.

See also

ETSI EN 300 648, 5.2.11.3

Constructor & Destructor Documentation

beam_hopping_time_plan_info_type()

ts::SAT::beam_hopping_time_plan_info_type::beam_hopping_time_plan_info_type ( PSIBuffer &  buf )

inline

Read-in constructor.

Parameters

[in,out]

buf

Deserialization buffer. Read the descriptor payload from buf. The end of read is the end of the binary payload. If any kind of error is reported in the buffer or if the payload is not completely read, the deserialization is considered as invalid.

Member Function Documentation

plan_length()

uint16_t ts::SAT::beam_hopping_time_plan_info_type::plan_length

(

void

)

const

Determines the size of this iteration of a beam hopping time plan to allow quick jumping to the next iteration.

Returns

The size, in bytes (12 bits), of this iteration in the loop, starting with the beamhopping_time_plan_id and ending at the end of the loop.

time_plan_mode()

uint8_t ts::SAT::beam_hopping_time_plan_info_type::time_plan_mode

(

void

)

const

Determines the time plan mode for this beam hopping time plan.

Returns

(2 bits), indicating the time plan mode or -1 plan mode cannot be determined

fromXML()

virtual bool ts::SAT::beam_hopping_time_plan_info_type::fromXML ( const xml::Element *  element )

overridevirtual

This method populates this object from XML attributes and sub-element.

Parameters

[in]

element

The element whose attributes and sub-elements are parsed to construct this object

Returns

true if the requisite attributes and sub-elements are available and correct

Implements ts::SAT::SAT_base.

toXML()

virtual void ts::SAT::beam_hopping_time_plan_info_type::toXML ( xml::Element *  root )

overridevirtual

This method converts this object to XML by populating necessary attributes and sub-elements into the provided element.

Parameters

[in,out]

root

The element whose attributes and sub-elements are added to to represent values in this object

Implements ts::SAT::SAT_base.

serialize()

virtual void ts::SAT::beam_hopping_time_plan_info_type::serialize ( PSIBuffer &  buf ) const

overridevirtual

This method serializes the attributes of a geostationary satellite.

Parameters

[in,out]

buf

A PSIBuffer with the appropriate size for the section payload.

Implements ts::SAT::SAT_base.

deserialize()

virtual void ts::SAT::beam_hopping_time_plan_info_type::deserialize ( PSIBuffer &  buf )

overridevirtual

This method deserializes (populates) the attributes of a geostationary satellite.

Parameters

[in,out]

buf

Deserialization buffer. Read the descriptor payload from buf. The end of read is the end of the binary payload. If any kind of error is reported in the buffer or if the payload is not completely read, the deserialization is considered as invalid.

Implements ts::SAT::SAT_base.

Member Data Documentation

current_slot

std::optional<uint16_t> ts::SAT::beam_hopping_time_plan_info_type::current_slot {}

15 bits.The slot in which the transmission of this table started.

32767 (all bits set to '1'), denotes that the current slot is not communicated for this entry.

sleep_time

std::optional<NCR_type> ts::SAT::beam_hopping_time_plan_info_type::sleep_time {}

The NCR time when the sleep mode will be entered.

Starting from this NCR time for the duration given by sleep_time_duration, receivers can expect not to be illuminated.

---

The documentation for this class was generated from the following file:

• tsSAT.h