# DiffoExample v0.4.0 - Table of Contents

> Examples for Diffo TMF Service and Resource Manager

## Pages

- [Guide](readme.md)
- [License](mit.md)

- Domains
  - [The Access Domain](access.md)
  - [Access Livebook](diffo_example_access.md)
  - [Access Domain API](_access_api.md)
  - [The Provider Domain](provider.md)
  - [The NBN Domain](nbn.md)
  - [NBN Livebook](diffo_example_nbn.md)
  - [NBN Domain API](_nbn_api.md)

- How To
  - [Setup the MCP server](setup_mcp.md)

## Modules

- [DiffoExample.Access](DiffoExample.Access.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.AggregateCharacteristic](DiffoExample.Access.AggregateCharacteristic.md): Typed characteristic for an aggregate interface.
- [DiffoExample.Access.BandwidthProfile](DiffoExample.Access.BandwidthProfile.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.Cable](DiffoExample.Access.Cable.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.CableCharacteristic](DiffoExample.Access.CableCharacteristic.md): Typed characteristic for a Cable's physical properties.
- [DiffoExample.Access.Calculations.ShelfTotalPorts](DiffoExample.Access.Calculations.ShelfTotalPorts.md): Sums the `:ports` pool capacity across every card a shelf has assigned
a slot to.
- [DiffoExample.Access.Card](DiffoExample.Access.Card.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.CardCharacteristic](DiffoExample.Access.CardCharacteristic.md): Typed characteristic for a Card's identity.
- [DiffoExample.Access.CharacteristicChanges](DiffoExample.Access.CharacteristicChanges.md): Shared changeset helpers for Access characteristic update actions.
- [DiffoExample.Access.CircuitCharacteristic](DiffoExample.Access.CircuitCharacteristic.md): Typed characteristic for a DSL circuit.
- [DiffoExample.Access.ConstraintsCharacteristic](DiffoExample.Access.ConstraintsCharacteristic.md): Typed characteristic for DSL service constraints.
- [DiffoExample.Access.DslAccess](DiffoExample.Access.DslAccess.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.DslamCharacteristic](DiffoExample.Access.DslamCharacteristic.md): Typed characteristic for a DSLAM's identity.
- [DiffoExample.Access.FloatUnit](DiffoExample.Access.FloatUnit.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.IntegerUnit](DiffoExample.Access.IntegerUnit.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.LineCharacteristic](DiffoExample.Access.LineCharacteristic.md): Typed characteristic for a DSL line's port properties.
- [DiffoExample.Access.Path](DiffoExample.Access.Path.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.PathCharacteristic](DiffoExample.Access.PathCharacteristic.md): Typed characteristic for a Path's physical properties.
- [DiffoExample.Access.Shelf](DiffoExample.Access.Shelf.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Access.ShelfCharacteristic](DiffoExample.Access.ShelfCharacteristic.md): Typed characteristic for a Shelf's identity.
- [DiffoExample.Nbn](DiffoExample.Nbn.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Avc](DiffoExample.Nbn.Avc.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.AvcCharacteristic](DiffoExample.Nbn.AvcCharacteristic.md): Typed characteristic for an AVC's circuit properties.
- [DiffoExample.Nbn.AvcValue](DiffoExample.Nbn.AvcValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.BandwidthProfile](DiffoExample.Nbn.BandwidthProfile.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Catalog](DiffoExample.Nbn.Catalog.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Changes.SetRspId](DiffoExample.Nbn.Changes.SetRspId.md)
- [DiffoExample.Nbn.Csa](DiffoExample.Nbn.Csa.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Cvc](DiffoExample.Nbn.Cvc.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.CvcCharacteristic](DiffoExample.Nbn.CvcCharacteristic.md): Typed characteristic for a CVC's bandwidth properties.
- [DiffoExample.Nbn.CvcMetrics](DiffoExample.Nbn.CvcMetrics.md): Local metrics characteristic for a CVC — `avcs_count` and
`avcs_total_bandwidth` aggregated live across the AVCs the CVC has
assigned a cvlan to. Not inheritable.
- [DiffoExample.Nbn.CvcValue](DiffoExample.Nbn.CvcValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Geo](DiffoExample.Nbn.Geo.md): Seeds NBN POI and CSA places for South Australia and the rest of Australia,
pairing each POI 1:1 with its CSA via a PlaceRef (POI -> CSA).
- [DiffoExample.Nbn.Initializer](DiffoExample.Nbn.Initializer.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Location](DiffoExample.Nbn.Location.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.LocationPoint](DiffoExample.Nbn.LocationPoint.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.NbnEthernet](DiffoExample.Nbn.NbnEthernet.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Nni](DiffoExample.Nbn.Nni.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.NniCharacteristic](DiffoExample.Nbn.NniCharacteristic.md): Typed characteristic for an NNI's port properties.
- [DiffoExample.Nbn.NniGroup](DiffoExample.Nbn.NniGroup.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.NniGroupCharacteristic](DiffoExample.Nbn.NniGroupCharacteristic.md): Typed characteristic for an NNI Group's identity.
- [DiffoExample.Nbn.NniGroupMetrics](DiffoExample.Nbn.NniGroupMetrics.md): Local metrics characteristic for an NNI Group — demand-side aggregates
across assigned CVCs (`cvcs_count`, `cvcs_total_bandwidth`), capacity-side
aggregates across comprised NNIs (`nnis_count`, `nnis_total_bandwidth`),
and the derived `utilization = cvcs_total_bandwidth / nnis_total_bandwidth`.
- [DiffoExample.Nbn.NniGroupValue](DiffoExample.Nbn.NniGroupValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.NniValue](DiffoExample.Nbn.NniValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Ntd](DiffoExample.Nbn.Ntd.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.NtdCharacteristic](DiffoExample.Nbn.NtdCharacteristic.md): Typed characteristic for an NTD's device properties.
- [DiffoExample.Nbn.NtdValue](DiffoExample.Nbn.NtdValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Poi](DiffoExample.Nbn.Poi.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.PriCharacteristic](DiffoExample.Nbn.PriCharacteristic.md): Typed characteristic for an NBN Ethernet access (PRI).
- [DiffoExample.Nbn.PriValue](DiffoExample.Nbn.PriValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Router](DiffoExample.Nbn.Router.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Rsp](DiffoExample.Nbn.Rsp.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.RspOwnership](DiffoExample.Nbn.RspOwnership.md): Shared RSP ownership policies for NBN resources.
- [DiffoExample.Nbn.ServiceInitializer](DiffoExample.Nbn.ServiceInitializer.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Speeds](DiffoExample.Nbn.Speeds.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Technology](DiffoExample.Nbn.Technology.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Uni](DiffoExample.Nbn.Uni.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.UniCharacteristic](DiffoExample.Nbn.UniCharacteristic.md): Typed characteristic for a UNI's port properties.
- [DiffoExample.Nbn.UniValue](DiffoExample.Nbn.UniValue.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Nbn.Util](DiffoExample.Nbn.Util.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Repo](DiffoExample.Repo.md): Diffo - TMF Service and Resource Management with a difference
- [DiffoExample.Util](DiffoExample.Util.md): Cross-domain projection helpers for the diffo_example app.

## Mix Tasks

- [mix gen.api_docs](Mix.Tasks.Gen.ApiDocs.md): Walks each configured domain's `code_interface` defines and writes a
markdown table fragment for inclusion in the domain doc pages.