WattsonNetworkEntity#

class wattson.cosimulation.simulators.network.components.wattson_network_entity.WattsonNetworkEntity(*, id: str, system_name: Optional[str] = None, display_name: Optional[str] = None, network_emulator: Optional[ForwardRef('NetworkEmulator')] = None, emulation_instance: Optional[Any] = None, segment: str = 'main', config: dict = <factory>, _is_started: bool = False, logger: Optional[logging.Logger] = None)#

Bases: NetworkEntity

Methods

__init__

generate_display_name

generate_dns_host_name

generate_name

get_class_id

get_dns_host_name

get_namespace

get_numerical_id

get_prefix

set_class_id

start

start_emulation_instance

stop

stop_emulation_instance

to_remote_representation

Creates a dictionary for synchronization with a RemoteNetworkEntity.

Attributes

class_id

display_name

emulation_instance

entity_id

is_started

logger

network_emulator

segment

system_id

system_name

id

config

__init__(*, id: str, system_name: str | None = None, display_name: str | None = None, network_emulator: NetworkEmulator | None = None, emulation_instance: ~typing.Any | None = None, segment: str = 'main', config: dict = <factory>, _is_started: bool = False, logger: ~logging.Logger | None = None) None#
to_remote_representation(force_state_synchronization: bool = True) RemoteNetworkEntityRepresentation#

Creates a dictionary for synchronization with a RemoteNetworkEntity.

Parameters:

force_state_synchronization (bool, optional) – Whether to force a synchronization of the internal state with the actual state (Default value = True)

Returns:

A dictionary representation of this WattsonNetworkEntity for synchronization with a RemoteNetworkEntity.

Return type:

RemoteNetworkEntityRepresentation