Extending Instrument::getComponentByName

[Anders Markvardsen]

Here purpose is to extend the C++ method:

Instrument::getComponentByName (const std::string & cname, int nlevels=0)

such that cname can be extended to accept a fully “qualified prefixed path” to a component name. The use case is to allow users to uniquely specify a component, where one or more such components have the same name in the IDF.

For example, imagine we have two banks: “bank 1” and “bank 2” both have a detector with name “det 1”, then the idea here is to allow a syntax, for cname, along the lines of:

bank 1/det 1

There is obviously an issue if an instrument happens to have a component called e.g. “bob/alice”. One way around this would be to have an additional argument to getComponentByName:

getComponentByName(const std::string & cname, int nlevels=0, bool fullyQualifiedPath=false)

here called fullyQualifiedPath which defaults to false, i.e. unless explicitly set to true getComponentByName keeps it original behaviour.

[Karl Palmen]

fullyQualifiedPath=True would require a completely different (and more efficient) search algorthm to the existing fullyQualifiedPath=False.

[Nick Draper]

Moved at the end of release 2.2

[Karl Palmen]

I think there could be a quite simple solution, which involves moving

Instrument::getComponentByName (const std::string & cname, int nlevels=0)

to superclass Component or ComponentAssembly.

Then one could for example look for tube025 in door4, where door4 is unique, but tube025 occurs several times, although unique to door4. This would save the user from having to provide a full qualified prexed path name.

[Karl Palmen]

Nevertheless it would be helpful to make the fully qualified path name available.

This could recursively call CompAssembly::getComponentByName() with the first part taken off the fully qualified path until

(1) the fully qualified path name has only one part

or

(2) the returned Component cannot be cast to CompAssembly, and so has no children.

[Karl Palmen]

The fullyQualifiedPath is not necessary. It can be implied by a '/' in the name.

[Karl Palmen]

Moved getComponentByName from Instrument to CompAssembly re #5658

This will hopefully enable recursive calling on the CompAssembly got from the returned Component.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: b1745eea93a4594fbc318f0e9f72cc160c67370c

[Karl Palmen]

Added recursive code re #5658

New code will compile, but needs testing. Added getComponentByName to ObjCompAssembly.cpp (throws NotImplemented exception) to enable getComponentByName to occur in ICompAssembly.h.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 4cf480db6c11045fe00469bfe11110f1c8bfe8bb

[Karl Palmen]

Fix string splitting error re #5658

Also made it not crash in response to "rubbish/bob" and improved comments.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 4b15e13b913566f308b82d9d064868d6d643f65c

[Karl Palmen]

Make nlevels apply stepwise to strings with '/' re #5658

Also added comments to explain how nlevels applies in such a case.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 4c95ad522b48cd710464abe627d6a89e4e8cadbd

[Karl Palmen]

Extended unit test re #5658

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8104aeaa0b268771b68d2f0a74a9c20f6c0b540f

[Karl Palmen]

Extended unit test may need moving from InstrumentTest to CompAssemblyTest, but this can be dealt with in another ticket. The extension here is for the use cases of this ticket.

[Russell Taylor]

Re #5658. Clear compiler warnings.

Changeset: 923d932b074dd85f344ab8b804e24df3bff86375

[Karl Palmen]

Moved getComponentByName from Instrument to CompAssembly re #5658

This will hopefully enable recursive calling on the CompAssembly got from the returned Component.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: b1745eea93a4594fbc318f0e9f72cc160c67370c

[Karl Palmen]

Added recursive code re #5658

New code will compile, but needs testing. Added getComponentByName to ObjCompAssembly.cpp (throws NotImplemented exception) to enable getComponentByName to occur in ICompAssembly.h.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 4cf480db6c11045fe00469bfe11110f1c8bfe8bb

[Karl Palmen]

Fix string splitting error re #5658

Also made it not crash in response to "rubbish/bob" and improved comments.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 4b15e13b913566f308b82d9d064868d6d643f65c

[Karl Palmen]

Make nlevels apply stepwise to strings with '/' re #5658

Also added comments to explain how nlevels applies in such a case.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 4c95ad522b48cd710464abe627d6a89e4e8cadbd

[Karl Palmen]

Extended unit test re #5658

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8104aeaa0b268771b68d2f0a74a9c20f6c0b540f

[Owen Arnold]

This is an internal component, but unit tests indicate that this is working.

[Russell Taylor]

Re #5658. Clear compiler warnings.

Changeset: 923d932b074dd85f344ab8b804e24df3bff86375

[Stuart Campbell]

This ticket has been transferred to github issue ​6504