satellite

cosmica.models.satellite

__all__ module-attribute

__all__ = [
    "ConstellationSatellite",
    "Satellite",
    "SatelliteTerminal",
    "UserSatellite",
]

ConstellationSatellite dataclass

ConstellationSatellite(
    *, id: T, orbit: SatelliteOrbitModel | None = None
)

Bases: Satellite[T]

global_id property

global_id: NodeGID

The universally unique identifier of the node.

id instance-attribute

id: T

orbit class-attribute instance-attribute

orbit: SatelliteOrbitModel | None = None

__str__

__str__() -> str

Source code in src/cosmica/models/node.py

def __str__(self) -> str:
    return self.global_id

class_name classmethod

class_name() -> str

Source code in src/cosmica/models/satellite.py

@classmethod
@override
def class_name(cls) -> str:
    return "CSAT"

Satellite dataclass

Satellite(*, id: T)

Bases: Node[T], ABC

global_id property

global_id: NodeGID

The universally unique identifier of the node.

id instance-attribute

id: T

__str__

__str__() -> str

Source code in src/cosmica/models/node.py

def __str__(self) -> str:
    return self.global_id

class_name classmethod

class_name() -> str

Class name as a string used for the key generation.

Override this method if you want to use a different class name for the key generation.

Source code in src/cosmica/models/node.py

@classmethod
def class_name(cls) -> str:
    """Class name as a string used for the key generation.

    Override this method if you want to use a different class name for the key generation.
    """
    return cls.__name__

SatelliteTerminal dataclass

SatelliteTerminal(
    *,
    id: T,
    terminal_id: T,
    azimuth_min: float,
    azimuth_max: float,
    elevation_min: float,
    elevation_max: float,
    angular_velocity_max: float
)

Bases: Satellite[T]

angular_velocity_max instance-attribute

angular_velocity_max: float

azimuth_max instance-attribute

azimuth_max: float

azimuth_min instance-attribute

azimuth_min: float

elevation_max instance-attribute

elevation_max: float

elevation_min instance-attribute

elevation_min: float

global_id property

global_id: NodeGID

The universally unique identifier of the node.

id instance-attribute

id: T

terminal property

terminal: OpticalCommunicationTerminal[T]

terminal_id instance-attribute

terminal_id: T

__str__

__str__() -> str

Source code in src/cosmica/models/node.py

def __str__(self) -> str:
    return self.global_id

class_name classmethod

class_name() -> str

Class name as a string used for the key generation.

Override this method if you want to use a different class name for the key generation.

Source code in src/cosmica/models/node.py

@classmethod
def class_name(cls) -> str:
    """Class name as a string used for the key generation.

    Override this method if you want to use a different class name for the key generation.
    """
    return cls.__name__

UserSatellite dataclass

UserSatellite(*, id: T)

Bases: Satellite[T]

global_id property

global_id: NodeGID

The universally unique identifier of the node.

id instance-attribute

id: T

__str__

__str__() -> str

Source code in src/cosmica/models/node.py

def __str__(self) -> str:
    return self.global_id

class_name classmethod

class_name() -> str

Source code in src/cosmica/models/satellite.py

@classmethod
@override
def class_name(cls) -> str:
    return "USAT"