as2fm.scxml_converter.scxml_entries.ros_utils.ScxmlRosDeclarationsContainer

class as2fm.scxml_converter.scxml_entries.ros_utils.ScxmlRosDeclarationsContainer(automaton_name: str)

Bases: object

Object that contains a description of the ROS declarations in the SCXML root.

__init__(automaton_name: str)

Constructor of container.

Automaton_name:

Name of the automaton these declarations belong to.

Methods

__init__(automaton_name)	Constructor of container.
append_ros_declaration(scxml_ros_declaration)	Add a ROS declaration to the container instance.
check_valid_action_feedback_fields(...)	Check if the provided fields match with the action type's feedback entries.
check_valid_action_goal_fields(alias_name, ...)	Check if the provided fields match with the action type's goal entries.
check_valid_action_result_fields(...)	Check if the provided fields match with the action type's result entries.
check_valid_srv_req_fields(client_name, ...)	Check if the provided fields match the service request type.
check_valid_srv_res_fields(server_name, ...)	Check if the provided fields match the service response type.
get_action_client_info(client_name)	Given an action client name, provide the related action name and type.
get_action_server_info(server_name)	Given an action server name, provide the related action name and type.
get_automaton_name()	Get name of the automaton that these declarations are defined in.
get_publisher_info(pub_name)	Provide a publisher topic name and type
get_service_client_info(client_name)	Provide a client's service name and type
get_service_server_info(server_name)	Provide a server's service name and type
get_subscriber_info(sub_name)	Provide a subscriber topic name and type
get_timers()
is_action_client_defined(client_name)
is_action_server_defined(server_name)
is_publisher_defined(pub_name)
is_service_client_defined(client_name)
is_service_server_defined(server_name)
is_subscriber_defined(sub_name)
is_timer_defined(timer_name)

append_ros_declaration(scxml_ros_declaration: ScxmlBase) → None

Add a ROS declaration to the container instance.

Parameters:

scxml_ros_declaration – The ROS declaration to add (inheriting from RosDeclaration).

check_valid_action_feedback_fields(server_name: str, ros_fields: List[RosField]) → bool

Check if the provided fields match with the action type’s feedback entries.

Parameters:

• client_name – Name of the action client.

• ros_fields – List of fields to check.

check_valid_action_goal_fields(alias_name: str, ros_fields: List[RosField]) → bool

Check if the provided fields match with the action type’s goal entries.

Parameters:

• alias_name – Name of the action client.

• ros_fields – List of fields to check.

check_valid_action_result_fields(server_name: str, ros_fields: List[RosField]) → bool

Check if the provided fields match with the action type’s result entries.

Parameters:

• client_name – Name of the action client.

• ros_fields – List of fields to check.

check_valid_srv_req_fields(client_name: str, ros_fields: List[RosField]) → bool

Check if the provided fields match the service request type.

check_valid_srv_res_fields(server_name: str, ros_fields: List[RosField]) → bool

Check if the provided fields match the service response type.

get_action_client_info(client_name: str) → Tuple[str, str]

Given an action client name, provide the related action name and type.

get_action_server_info(server_name: str) → Tuple[str, str]

Given an action server name, provide the related action name and type.

get_automaton_name() → str

Get name of the automaton that these declarations are defined in.

get_publisher_info(pub_name: str) → Tuple[str, str]

Provide a publisher topic name and type

get_service_client_info(client_name: str) → Tuple[str, str]

Provide a client’s service name and type

get_service_server_info(server_name: str) → Tuple[str, str]

Provide a server’s service name and type

get_subscriber_info(sub_name: str) → Tuple[str, str]

Provide a subscriber topic name and type