Project

General

Profile

Necessary Maintenance #17008

FindOneP: document what happens when asking for the "B" pointer to an unassociated "A"

Added by Gianluca Petrillo about 3 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
-
Start date:
06/23/2017
Due date:
% Done:

0%

Estimated time:
1.00 h
Spent time:
Scope:
Internal
Experiment:
-
SSI Package:
Duration:

Description

The documentation at Inter-Product References seems not to mention what is the result of the query:

art::FindOneP<B> query(As, event, label);
art::Ptr<B> result = query.at(i);
when As[i] is not associated with any B.

It might be that result will be an invalid pointer... if so, it needs to be documented.

History

#1 Updated by Gianluca Petrillo about 3 years ago

... aaand I forgot a fundamental letter

art::FindOneP<B> query(As, event, label);
art::Ptr<B> result = query.at(i);

(people who can may fix the issue description)

#2 Updated by Kyle Knoepfel about 3 years ago

  • Description updated (diff)

#3 Updated by Kyle Knoepfel about 3 years ago

  • Status changed from New to Accepted
  • Assignee set to Christopher Green
  • Estimated time set to 1.00 h

#4 Updated by Christopher Green about 3 years ago

  • Status changed from Accepted to Resolved

The Inter-Product_References documentation has been clarified slightly: specifically at Inter-Product_References and Inter-Product_References. The document may be found from the main Wiki page under the heading, Data products and ROOT dictionaries, labelled, "Inter-Product References (Assns, FindOne{,P}, FindMany{,P})." Please let us know if the documentation remains insufficient to answer any questions.

#5 Updated by Gianluca Petrillo about 3 years ago

It seems to miss the information about art::Ptr<B> from art::FindManyP, when the former is not resolvable.
I suppose the description would be the same as for art::FindOneP.

#6 Updated by Kyle Knoepfel over 2 years ago

  • Status changed from Resolved to Closed


Also available in: Atom PDF