Skip to content

doc: Update and add reference to Trace Compass Trace Server guide #275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bhufmann merged 1 commit into from
Jun 2, 2025
Merged

doc: Update and add reference to Trace Compass Trace Server guide #275

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/org.eclipse.tracecompass.doc.dev/doc/Developer-Guide.mediawiki
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ should help developers trying to add new capabilities (support for new trace
type, new analysis or views, etc.) to the framework. End-users, using the RCP
for example, should not have to worry about the concepts explained here.

= Trace Compass Server =
= Trace Compass Trace Server =

For development for `Trace Compass Trace Server` see the [https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/blob/master/doc/trace-server/trace-server-dev-guide.md | Trace Server Developer Guide].
For information on developing for the '''Trace Compass Trace Server''' see the [https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/blob/master/doc/trace-server/trace-server-dev-guide.md | Trace Server Developer Guide].

= Implementing a New Trace Type =

Expand Down Expand Up @@ -4788,6 +4788,8 @@ Data providers are queried with a filter object, which usually contains a time r

''Note that a complete example of analysis, data provider and views can be found in the [https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/blob/master/doc/org.eclipse.tracecompass.examples org.eclipse.tracecompass.examples plugin sources].''

The chapters below describe key concepts and how to create data providers. For more details, other data provider types and complementary information about data providers see also the '''Data Provider''' chapters in the [https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/blob/master/doc/trace-server/trace-server-dev-guide.md | Trace Server Developer Guide]. This guide describes as well how data providers are used in the Trace Compass Trace Server.

== Data provider types ==

The base data provider '''ITmfDataProvider''' interface is the interface each data provider type has to implement. The data provider factories create instances of such provider type. Tree data providers are of type '''ITmfTreeDataProvider''' extend the '''ITmfDataProvider''' interface and returns a tree, as a list of '''TmfTreeDataModel''', with a name, ID and parent ID. The ID is unique to a provider type and the parent ID indicates which element from the list is the entry's parent to rebuild the tree hierarchy from the list of models. Note such tree need to have limited size to not exceed the available memory.
Expand Down
Loading