Lattix API#
The Lattix API will allow you access the features of Lattix external from the Lattix application.
- You will get access the following (not a complete list)
Load, save, create, and update Lattix Projects.
Query dependencies, metrics, rules, and violations in a project.
Create and delete subsystems, rules in a project.
Available apis:
- Java Lattix API
- Lattix Python API
- Python API Reference
- Module: pyliblattix
IteratorAtomBasicCollectionPartitionPartition.atom_partitionPartition.leafPartition.referencePartition.references_atom()Partition.atomPartition.atom_setPartition.containerPartition.partition_referencePartition.parent_rule_sourcePartition.levelPartition.segment_map_indexPartition.clear_text_descriptionPartition.descriptionPartition.display_namePartition.namePartition.short_display_namePartition.x_m_l_partition_typePartition.atom_iterator()Partition.property_name_iterator()Partition.set_segment_map_index()
PartitionCollectionPartitionCollectionCollectionPartitionSetPartitionRelationPartitionRelationCollectionAtomKindAtomKind.has_behavior()AtomKind.memberAtomKind.supports_dependencies()AtomKind.supports_members()AtomKind.get_atom_property_definition()AtomKind.get_property_definition()AtomKind.flagsAtomKind.image_nameAtomKind.module_idAtomKind.nameAtomKind.res_nameAtomKind.behavior_iterator()AtomKind.property_definition_iterator()
MetricMetricsDataMetricsData.get_metric()MetricsData.get_metric2()MetricsData.get_metric3()MetricsData.custom_metricsMetricsData.hidden_metricsMetricsData.notify()MetricsData.notify_all()MetricsData.wait2()MetricsData.to_string()MetricsData.all_metrics_iteratorMetricsData.metrics_iteratorMetricsData.hash_code()MetricsData.get_global_metric()MetricsData.add_global_metric()MetricsData.set_global_metrics_data()MetricsData.add_to_all_metrics()MetricsData.build_all_metrics()MetricsData.cleanup()MetricsData.dispose()MetricsData.dump_metrics()
AtomCollectionAtomSetDsmOrderingAlgorithmDependModuleDependencyKindGraphCyclesDependencyBehaviorDependencyBehavior.maskDependencyBehavior.hash_code()DependencyBehavior.ordinal()DependencyBehavior.name_resDependencyBehavior.name()DependencyBehavior.notify()DependencyBehavior.notify_all()DependencyBehavior.wait2()DependencyBehavior.to_string()DependencyBehavior.value_of()DependencyBehavior.behavor_string_to_flags()DependencyBehavior.get_behavior_string()
AtomBehaviorAtomBehavior.maskAtomBehavior.hash_code()AtomBehavior.ordinal()AtomBehavior.name_resAtomBehavior.name()AtomBehavior.notify()AtomBehavior.notify_all()AtomBehavior.wait2()AtomBehavior.to_string()AtomBehavior.has_member_behavior()AtomBehavior.is_member_behavior()AtomBehavior.value_of()AtomBehavior.behavor_string_to_flags()
PartitionEdgePathPartitionEdgePathCollectionMetricGroupMetricGroup.do_calc_as_group()MetricGroup.disable_hierarchyMetricGroup.hiddenMetricGroup.get_metric()MetricGroup.remove_metric()MetricGroup.descriptionMetricGroup.notify()MetricGroup.notify_all()MetricGroup.wait2()MetricGroup.idMetricGroup.res_nameMetricGroup.to_string()MetricGroup.metric_iterator()MetricGroup.hash_code()MetricGroup.add_metric()MetricGroup.remove_all()MetricGroup.set_disable_hierarchy()
AtomKindCountAtomKindCount.disable_hierarchy()AtomKindCount.percentAtomKindCount.segment_map_indexAtomKindCount.idAtomKindCount.image_nameAtomKindCount.nameAtomKindCount.notify()AtomKindCount.notify_all()AtomKindCount.set_segment_map_index()AtomKindCount.wait2()AtomKindCount.decimal_precisionAtomKindCount.hash_code()AtomKindCount.get_description()AtomKindCount.format_stringAtomKindCount.format_string_resAtomKindCount.to_string()AtomKindCount.build_id()AtomKindCount.create_count_resource()
CriteriaDependencyFilterRuleSetWorkItemWorkItem.has_child_work_items()WorkItem.parent_work_itemWorkItem.priorityWorkItem.key_indexWorkItem.key_map_indexWorkItem.default_descriptionWorkItem.descriptionWorkItem.idWorkItem.nameWorkItem.ownerWorkItem.plain_text_descriptionWorkItem.titleWorkItem.typeWorkItem.child_work_items()WorkItem.set_key_index()WorkItem.set_key_map_index()
WorkItemCollectionRuleViolatorDependencyBasicDependencyCollectionRuleRuleSourceRuleViolatorCollectionRuleViolatorSetDependencyEdgeDependencyEdgeCollectionAtomPropertyDefinitionAtomPropertyDefinition.has_behavior()AtomPropertyDefinition.long_precisionAtomPropertyDefinition.clone()AtomPropertyDefinition.decimal_precisionAtomPropertyDefinition.flagAtomPropertyDefinition.typeAtomPropertyDefinition.format_string_resAtomPropertyDefinition.module_idAtomPropertyDefinition.nameAtomPropertyDefinition.res_nameAtomPropertyDefinition.behavior_iterator()
PropertyBehaviorPropertyBehavior.maskPropertyBehavior.hash_code()PropertyBehavior.ordinal()PropertyBehavior.name_resPropertyBehavior.name()PropertyBehavior.notify()PropertyBehavior.notify_all()PropertyBehavior.wait2()PropertyBehavior.to_string()PropertyBehavior.value_of()PropertyBehavior.behavor_string_to_flags()
TagTagCollectionNumberColorProjectModelProjectModel.contains_atom()ProjectModel.has_ancestor()ProjectModel.has_ancestor2()ProjectModel.has_collapsed_members()ProjectModel.has_expanded_members()ProjectModel.is_dependency_edge_hidden()ProjectModel.is_dependency_edge_hidden2()ProjectModel.disposedProjectModel.is_partition_hidden()ProjectModel.is_partition_tagged()ProjectModel.read_onlyProjectModel.is_top_level_atom_partition()ProjectModel.validProjectModel.new_search_criteria_builder()ProjectModel.get_manual_atom()ProjectModel.new_manual_atom()ProjectModel.get_atom()ProjectModel.get_atom2()ProjectModel.get_atom_at()ProjectModel.get_main_ancestor_atom()ProjectModel.get_source_atom_for()ProjectModel.get_target_atom_for()ProjectModel.get_target_atom_for2()ProjectModel.get_all_atoms()ProjectModel.get_atoms_at()ProjectModel.partitions_to_atoms()ProjectModel.get_atom_kind()ProjectModel.new_atom_set()ProjectModel.get_dependencies()ProjectModel.get_depend_module()ProjectModel.new_manual_dependency()ProjectModel.new_dependency_edge()ProjectModel.get_edges()ProjectModel.get_edges2()ProjectModel.get_edges3()ProjectModel.get_edges_between()ProjectModel.get_edges_from()ProjectModel.get_edges_from_work_item()ProjectModel.get_external_edges()ProjectModel.get_used_by_edges()ProjectModel.get_used_by_edges2()ProjectModel.get_used_by_edges3()ProjectModel.get_uses_edges()ProjectModel.get_uses_edges2()ProjectModel.get_dependency_kind()ProjectModel.get_ordering_algorithm()ProjectModel.get_metric_definition()ProjectModel.new_partition()ProjectModel.new_partition_with_atom()ProjectModel.get_child_partition_by_name()ProjectModel.get_display_sub_partition()ProjectModel.get_partition()ProjectModel.get_partition2()ProjectModel.root_partitionProjectModel.get_sub_partition()ProjectModel.atoms_to_partitions()ProjectModel.get_all_partitions()ProjectModel.get_all_partitions2()ProjectModel.get_descendant_atom_partitions()ProjectModel.get_partitions_by_name()ProjectModel.get_sub_partitions()ProjectModel.get_tagged_partitions()ProjectModel.get_cycle_components()ProjectModel.get_low_level_cycle_components()ProjectModel.new_partition_set()ProjectModel.new_sorted_partition_set()ProjectModel.get_partition_rules()ProjectModel.get_rule_violators()ProjectModel.get_rule_violators2()ProjectModel.get_rule_violators3()ProjectModel.get_rule_violators_from_work_item()ProjectModel.new_rule_violator_set()ProjectModel.applied_rulesProjectModel.create_or_find_tag()ProjectModel.new_impact_tag()ProjectModel.new_impact_tag2()ProjectModel.new_tag()ProjectModel.get_tag()ProjectModel.all_tagsProjectModel.get_direct_tags_for()ProjectModel.get_tags_for()ProjectModel.create_work_item()ProjectModel.create_work_item2()ProjectModel.create_work_item3()ProjectModel.create_work_item4()ProjectModel.work_itemsProjectModel.inc_ref()ProjectModel.get_dependency_strength()ProjectModel.get_impact_strength()ProjectModel.get_partition_index()ProjectModel.get_sub_partition_count()ProjectModel.instanceProjectModel.get_metric_value()ProjectModel.get_atom_kind_resource_name()ProjectModel.get_atom_property_value()ProjectModel.get_dependency_kind_resource_name()ProjectModel.get_full_source_name()ProjectModel.get_partition_description()ProjectModel.project_nameProjectModel.all_high_level_cyclesProjectModel.all_metric_definitionsProjectModel.get_all_partition_iterator()ProjectModel.get_atom_partition_iterator()ProjectModel.atoms_from_databaseProjectModel.get_descendent_rules_for()ProjectModel.get_inherited_rules_for()ProjectModel.get_module_atom_kinds()ProjectModel.get_module_dependency_kinds()ProjectModel.module_idsProjectModel.ordering_algorithmsProjectModel.project_atom_kindsProjectModel.project_dependency_kindsProjectModel.get_rules_for()ProjectModel.get_tags_for2()ProjectModel.get_used_by_edges_closure()ProjectModel.get_uses_edges_closure()ProjectModel.partition_property_name_iterator()ProjectModel.sub_partition_display_iterator()ProjectModel.sub_partition_iterator()ProjectModel.visible_sub_partition_iterator()ProjectModel.add_atom_to_partition()ProjectModel.add_partition_to_tag()ProjectModel.add_partitions_to_tag()ProjectModel.change_atom_kind()ProjectModel.clear_partition_property()ProjectModel.clear_tag_filter()ProjectModel.collapse_members()ProjectModel.delete_partition()ProjectModel.delete_partition_tree()ProjectModel.delete_rule()ProjectModel.delete_tag()ProjectModel.expand_members()ProjectModel.hide_dependencies()ProjectModel.hide_partition()ProjectModel.import_file_as_manual()ProjectModel.import_l_d_ias_module()ProjectModel.move_partition()ProjectModel.move_partition_to()ProjectModel.perform_ordering()ProjectModel.remove_atom_from_partition()ProjectModel.remove_dependency_edge()ProjectModel.remove_dependency_edge2()ProjectModel.remove_partitions_from_tag()ProjectModel.rename_partition()ProjectModel.set_atom_property()ProjectModel.set_cell_text()ProjectModel.set_cell_text2()ProjectModel.set_edge_property()ProjectModel.set_edge_property2()ProjectModel.set_partition_description()ProjectModel.set_tag_color()ProjectModel.set_tag_criteria()ProjectModel.set_tag_edges()ProjectModel.set_tag_filter()ProjectModel.set_tag_partitions()ProjectModel.set_work_item_description()ProjectModel.set_work_item_name()ProjectModel.set_work_item_owner()ProjectModel.unhide_dependencies()ProjectModel.unhide_partition()ProjectModel.check_canceled()ProjectModel.dispose()ProjectModel.create_or_find_tag2()ProjectModel.create_or_find_tag_red()ProjectModel.color_from_str()ProjectModel.get_dsm_js_data()ProjectModel.get_name_alt()ProjectModel.get_string_atom_property()ProjectModel.get_atom_property_names()ProjectModel.get_int_edge_propertys()ProjectModel.save_project()ProjectModel.save_project_as()
LattixPythonApiFileFile.can_execute()File.can_read()File.can_write()File.create_new_file()File.exists()File.absoluteFile.directoryFile.fileFile.hiddenFile.mkdir()File.mkdirs()File.rename_to()File.set_executable()File.set_executable2()File.set_read_only()File.set_readable()File.set_readable2()File.set_writable()File.set_writable2()File.notify()File.notify_all()File.wait2()File.compare_to()File.hash_code()File.absolute_fileFile.canonical_fileFile.parent_fileFile.absolute_pathFile.canonical_pathFile.nameFile.parentFile.pathFile.to_string()File.create_temp_file()File.create_temp_file2()File.delete_on_exit()
ResourceManagerSearchCriteriaBuilderSearchCriteriaBuilder.atom_kind_filter_builder()SearchCriteriaBuilder.case_sensitive()SearchCriteriaBuilder.reg_exSearchCriteriaBuilder.partitions_with_atoms()SearchCriteriaBuilder.partitions_without_atoms()SearchCriteriaBuilder.text()SearchCriteriaBuilder.build()SearchCriteriaBuilder.notify()SearchCriteriaBuilder.notify_all()SearchCriteriaBuilder.wait2()SearchCriteriaBuilder.to_string()SearchCriteriaBuilder.hash_code()
AtomKindFilterBuilderSearchCriteriaacquire_lattix_api()
- Module: pyliblattix