ros2_snapshot.workspace_modeler.workspace_modeler module
Workspace_modeler: a tool for probing ROS installation and workspace.
This discovers all ROS packages and documents the configuruation.
- class ros2_snapshot.workspace_modeler.workspace_modeler.PackageModeler
Bases:
objectClass responsible for crawling ROS workspace and extracting package information.
- property action_specification_bank
Return the SpecificationBankBuilder for Action Specifications.
- Returns:
the SpecificationBankBuilder for Action Specifications
- Return type:
SpecificationBankBuilderpackage_name
- crawl()
Crawl the ROS workspace to populate the snapshotModel with the details of the ROS Packages in workspace.
- Returns:
True if successful; False if failures were encountered
- Return type:
bool
- property message_specification_bank
Return the SpecificationBankBuilder for Message Specifications.
- Returns:
the SpecificationBankBuilder for Message Specifications
- Return type:
SpecificationBankBuilder
- property node_specification_bank
Return the NodeBankBuilder.
- Returns:
the NodeBankBuilder
- Return type:
- property package_specification_bank
Return the PackageBankBuilder.
- Returns:
the PackageBankBuilder
- Return type:
PackageBankBuilder
- print_statistics()
Print statistics.
- property ros_model
Return the snapshotModel instance.
- Returns:
the snapshotModel instance, if called after the probe method; Otherwise, None
- Return type:
snapshotModel
- property service_specification_bank
Return the SpecificationBankBuilder for Service Specifications.
- Returns:
the SpecificationBankBuilder for Service Specifications
- Return type:
SpecificationBankBuilder
- source_name = 'package_modeler'
- ros2_snapshot.workspace_modeler.workspace_modeler.get_options(argv)
Get command line options for package modeler.
- Parameters:
argv – command line arguments
- ros2_snapshot.workspace_modeler.workspace_modeler.main(argv=None)
Run the method for the ROS Snapshot tool.
This is the driver that sets up and runs everything.