UMAAPy

UMAAPy Documentation

  • Installation
  • Getting Started
    • Minimal Reader/Writer
    • Minimal Report Provider/Consumer
    • Minimal Command Provider/Consumer
  • Developing UMAAPy
    • Contributor Environment
    • Type Generation
    • Testing Workflow
  • Multi-Topic UMAA
    • Overview
    • Quick Start (Readers)
    • Quick Start (Writers)
    • Integration Test Use Cases
    • API Reference Highlights

API Documentation

  • API Documentation
    • core
      • ReportConsumer
        • ReportConsumer
      • ReportProvider
        • ReportProvider
      • CommandProvider
        • CommandProvider
      • CommandConsumer
        • CommandConsumer
    • util
      • DDS Configurator
        • DDSConfigurator
        • ReaderListenerEventType
        • UmaaQosProfileCategory
        • WriterListenerEventType
      • EventProcessor
        • Command
        • EventProcessor
        • RecurringTask
        • Task
      • Timestamp
        • Timestamp
      • UMAACommand
        • UmaaCommand
        • UmaaCommandException
        • UmaaCommandFactory
      • UMAA Utils
        • HashableIdentifierType
        • HashableNumericGUID
        • UMAAConcept
        • UMAAFieldInfo
        • classify_obj_by_umaa()
        • get_specializations_from_generalization()
        • guid_equal()
        • guid_key()
        • infer_umaa_key_fields()
        • make_instance_key_fn()
        • path_for_list_element()
        • path_for_set_element()
        • topic_from_type()
        • validate_umaa_obj()
      • UUID Factory
        • build_identifier_type()
        • generate_guid()
        • generate_identifier_type()
        • guid_from_string()
        • guid_to_hex()
        • make_filter_for_guid()
      • multi_topic_support
        • Key ideas
        • BuilderEditView
        • CombinedBuilder
        • CombinedEditHandle
        • CombinedSample
        • ElementHandle
        • ElementView
        • ForwardingReaderListener
        • ForwardingWriterListener
        • ListCollection
        • ListEditor
        • OverlayView
        • SetCollection
        • SetEditor
        • UmaaFilteredReaderAdapter
        • UmaaReaderAdapter
        • UmaaWriterAdapter
        • get_at_path()
        • set_at_path()
        • Usage Examples
      • multi_topic_reader
        • AssemblySignal
        • ReaderDecorator
        • ReaderNode
        • Example
      • multi_topic_reader_decorators
        • GenSpecReader
        • LargeListReader
        • LargeSetReader
        • PassthroughReader
      • multi_topic_writer
        • TopLevelWriter
        • WriterDecorator
        • WriterNode
        • Example
      • multi_topic_writer_decorators
        • GenSpecWriter
        • LargeListWriter
        • LargeSetWriter
      • provider
        • Provider
      • reader_listener
        • ReaderListener

Architecture Decisions

  • Architecture Decision Records
    • Conventions
      • ADR 0001: Cyclone-First Single-Backend Strategy
        • Status
        • Date
        • Context
        • Decision
        • Consequences
        • Non-Goals
        • Follow-Up
UMAAPy
  • Overview: module code

All modules for which code is available

  • umaapy.core.command_consumer
  • umaapy.core.command_provider
  • umaapy.core.report_consumer
  • umaapy.core.report_provider
  • umaapy.util.dds_configurator
  • umaapy.util.event_processor
  • umaapy.util.multi_topic_reader
  • umaapy.util.multi_topic_reader_decorators
  • umaapy.util.multi_topic_support
  • umaapy.util.multi_topic_writer
  • umaapy.util.multi_topic_writer_decorators
  • umaapy.util.provider
  • umaapy.util.reader_listener
  • umaapy.util.timestamp
  • umaapy.util.umaa_command
  • umaapy.util.umaa_utils
  • umaapy.util.uuid_factory

© Copyright 2025, Devon Reed.

Built with Sphinx using a theme provided by Read the Docs.