CEP27: toolkit Snippet #297

bam241 · 2019-10-30T15:45:05Z

This is a suggestion to improve, ease and homogenize an the usage of toolkit capability in archetypes.

This idea is to limit as much as possible the need for implementation in a newly develop archetypes to avoid divergence in the implementation and the convention by providing a snippet that one can simply includes in the archetypes class definition header (inside the core definition of the class) to ensure variable name are identical.

Example can be found in:

Position implementation change cyclus#1510 for the snippet implementation
Update Position cycamore#502 for the corresponding archetypes implementations

gonuke

A bunch of editorial changes - I'm not sure I fully understand all the usage details, either.

source/cep/cep27.rst

gonuke · 2019-10-31T03:02:10Z

source/cep/cep27.rst

+2. Add the proper default initialisation of the variable required for the
+   snippet.
+
+3. In the ``Archetype::EnterNotify()``, assign the Snippet with value


Do you really assign the "Snippet" with a value???

bam241 · 2019-11-11T20:31:12Z

Cc @yarden-livnat

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

gonuke

This nearly there - thanks for the updates.

source/cep/cep27.rst

gonuke · 2019-11-21T23:43:06Z

source/cep/cep27.rst

+add characteristics to archetypes such as Position or Metadata, the actual
+implementation method is very verbose, where in each archetypes one needs to add
+the new specification in the arcehtype header, then assign it and use it in the
+cpp file, with no guarantee on the consistency in the variable naming and


This sentence kind of runs on... Maybe consider making it a couple of sentences.

source/cep/cep27.rst

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

source/cep/cep27.rst

gonuke · 2019-11-27T03:23:15Z

source/cep/cep27.rst

+        var1(0.0),
+        var2(0.0),
+        ...,
+        coordinates(0,0), //coordinates constructor (toolkit feature class)


This initializer is not necessary/valid because the snippet in this example doesn't include the coordinates variable.

gonuke · 2019-11-27T03:26:27Z

source/cep/cep27.rst

+--------------------
+``toolkit/my_snippet.cycpp.h``:
+.. highlight:: c
+    cyclus::toolkit::Position coordinates;


Is this only in the version without inheritance? Is this the only difference between the with and without?

it also changes in the implementation of the archetype

I mean the only difference in the snippet. It would be great if the same snippet could be used in both modes.

gonuke · 2019-11-27T03:27:44Z

source/cep/cep27.rst

+        var1(0.0),
+        var2(0.0),
+        ...,
+        coordinates(0,0), //coordinates constructor (toolkit feature class)


if we use C++11 can we initialize these in the snippet?

yes that's true, this will be way better !

I'll try this in my Position PR and see how it does work out!

it seems to be working, I updated both the PR and the CEP accordingly

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

source/cep/cep27.rst

gonuke · 2019-11-27T21:09:39Z

source/cep/cep27.rst

+
+The |Cyclus| toolkit is designed to easily implement specific capabilities in
+newly developed archetypes, such as a trading policy, commodity producers, etc. To
+add characteristics to archetypes such as `Position` or `Metadata`, the actual


This is still a long, awkward sentence.

gonuke · 2019-11-27T21:10:26Z

source/cep/cep27.rst

+--------------------
+``toolkit/my_snippet.cycpp.h``:
+.. highlight:: c
+    cyclus::toolkit::Position coordinates;


I mean the only difference in the snippet. It would be great if the same snippet could be used in both modes.

gonuke

Sorry - just one more suggestion...

And then we need review from others!

source/cep/cep27.rst

…ader, and renameing my_snippet into my_feature_snippet

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

bam241

I also renamed my_snippet into my_feature_snippet.
I believe it was making more sense.

source/cep/cep27.rst

gonuke · 2019-11-27T23:11:30Z

I still wonder if there is a way for the same snippet to be used for inheritance and membership?

bam241 · 2019-11-27T23:14:15Z

I still wonder if there is a way for the same snippet to be used for inheritance and membership?

that would be nice !

maybe an other way to do this would be to let cycpp do that using #pragmas ?

gonuke · 2019-11-27T23:16:47Z

Maybe we don't include the member variable in the snippet? The user needs to define the name for that member variable? That relaxes one kind of imposed consistency, but maybe that variable name is purely internal and doesn't need to be consistent... just a thought

bam241 · 2019-11-27T23:18:09Z

Maybe we don't include the member variable in the snippet? The user needs to define the name for that member variable? That relaxes one kind of imposed consistency, but maybe that variable name is purely internal and doesn't need to be consistent... just a thought

I liked the snippet idea for the variables exposed in the cyclus input to ensure those one are the same

--- edit ---
I am not sure but I feel like I am missing something about your idea !

gonuke · 2019-11-27T23:25:10Z

source/cep/cep27.rst

+--------------------
+``toolkit/my_feature_snippet.cycpp.h``:
+.. highlight:: c
+    cyclus::toolkit::Position coordinates(0,0);


If you remove only this line (not exposed in input), then the snippet can be used in both modes, and developer chooses name of member variable.

In fact, that might be better, because otherwise developer has to know name of member variable defined in the snippet.

this is correct, (and I like the versatility it provides)
I guess it is a balance between versatility and amount of work on the developer side:
if we only support without-inheritance everything should be includable in the snippet.
if we want to support both, developers have to add:

#include 'toolkit/my_toolkit.h

inheritance or feature element

#include toolkit/snippet.cycpp.h` in the class core.

(this is also why without inheritance has my (slight) preference.)

the good thing with removing the variable it would allow both with and without inheritance

Even without inheritance, I'm not sure we want to assume that the member variable is always defined by the snippet... what if you want two positions?

sure but then what is the use of the snippet ? because some member variable are defined in the snippet (at least the one expose in the input.)

I don't see how to use the snippet with 2 positions.

This might not be the best example of including more than one instance. In addition, there may be a need to initialize each instance which gets complicated again. Nevertheless, I think asking the developer to explicitly declare their member variable is not too much to ask.

We should open this up to additional discussion, e.g. on the mailing list.

I still think there is a benefit to having a single snippet file and then letting user choose the variable name in the non-inheritance case. We can include that in the example in the documentation.

Once we get that resolved, and clean up this CEP, I think I'm ready to approve/merge this and the follow-up PR's in the code repos.

source/cep/cep27.rst

katyhuff · 2020-01-27T20:35:02Z

Just a couple little grammar comments suggested above -- otherwise looks good to me.

Co-Authored-By: Katy Huff <katyhuff@users.noreply.github.com>

gonuke

I think this is ready to move forward

bam241 added 4 commits October 28, 2019 11:39

intro

0a96da5

update

9ea0df2

done with first draft

6686d60

some review

1c75d2b

bam241 requested a review from gonuke October 30, 2019 15:45

bam241 assigned bam241 and unassigned bam241 Oct 30, 2019

bam241 requested a review from katyhuff October 30, 2019 15:45

gonuke requested changes Oct 31, 2019

View reviewed changes

bam241 and others added 4 commits November 18, 2019 13:59

Apply suggestions from code review

a5bc8d8

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

some improvement and addition of an implementation example

3fcb4a7

removing trailing space

2f09ba2

some text improvement

2e79678

gonuke requested changes Nov 21, 2019

View reviewed changes

bam241 and others added 6 commits November 26, 2019 09:40

upadte tittle

3afaa92

Apply suggestions from code review

26b7515

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

Merge branch 'cep27' of github.com:bam241/cyclus.github.com into cep27

4bb1528

add information about where to put the preprocessor additional line

d045749

Add inheritance example

5d09ded

some syntax change

5770f22

gonuke reviewed Nov 27, 2019

View reviewed changes

source/cep/cep27.rst Outdated Show resolved Hide resolved

gonuke reviewed Nov 27, 2019

View reviewed changes

source/cep/cep27.rst Outdated Show resolved Hide resolved

gonuke reviewed Nov 27, 2019

View reviewed changes

bam241 and others added 3 commits November 27, 2019 11:23

Apply suggestions from code review

0507887

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

calling default construct should be the default when inheriting

d895250

Merge branch 'cep27' of github.com:bam241/cyclus.github.com into cep27

49c25ba

gonuke reviewed Nov 27, 2019

View reviewed changes

gonuke requested changes Nov 27, 2019

View reviewed changes

simplifying motivation sentences, adding missing include

7c4c0c4

gonuke reviewed Nov 27, 2019

View reviewed changes

source/cep/cep27.rst Outdated Show resolved Hide resolved

bam241 and others added 2 commits November 27, 2019 17:05

adding instruction for toolkit feature header include in arcehtype he…

2b066c2

…ader, and renameing my_snippet into my_feature_snippet

Update source/cep/cep27.rst

fdfa326

Co-Authored-By: Paul Wilson <paul.wilson@wisc.edu>

bam241 commented Nov 27, 2019

View reviewed changes

source/cep/cep27.rst Show resolved Hide resolved

gonuke reviewed Nov 27, 2019

View reviewed changes

katyhuff reviewed Jan 27, 2020

View reviewed changes

source/cep/cep27.rst Outdated Show resolved Hide resolved

source/cep/cep27.rst Outdated Show resolved Hide resolved

source/cep/cep27.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

03f4ca9

Co-Authored-By: Katy Huff <katyhuff@users.noreply.github.com>

gonuke approved these changes Mar 27, 2021

View reviewed changes

gonuke merged commit 06bd7ea into cyclus:source Mar 27, 2021

This was referenced Feb 7, 2024

Position implementation change cyclus/cyclus#1510

Open

Add CEP27 to list #329

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CEP27: toolkit Snippet #297

CEP27: toolkit Snippet #297

bam241 commented Oct 30, 2019 •

edited

gonuke left a comment

gonuke Oct 31, 2019

bam241 commented Nov 11, 2019

gonuke left a comment

gonuke Nov 21, 2019

gonuke Nov 27, 2019

gonuke Nov 27, 2019

bam241 Nov 27, 2019 •

edited

gonuke Nov 27, 2019

gonuke Nov 27, 2019

bam241 Nov 27, 2019

bam241 Nov 27, 2019

bam241 Nov 27, 2019

gonuke Nov 27, 2019

gonuke Nov 27, 2019

gonuke left a comment

bam241 left a comment

gonuke commented Nov 27, 2019

bam241 commented Nov 27, 2019 •

edited

gonuke commented Nov 27, 2019

bam241 commented Nov 27, 2019 •

edited

gonuke Nov 27, 2019

bam241 Nov 27, 2019

bam241 Nov 27, 2019

gonuke Nov 28, 2019

bam241 Nov 28, 2019

gonuke Dec 1, 2019

gonuke Mar 28, 2020

katyhuff commented Jan 27, 2020

gonuke left a comment

CEP27: toolkit Snippet #297

CEP27: toolkit Snippet #297

Conversation

bam241 commented Oct 30, 2019 • edited

gonuke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bam241 commented Nov 11, 2019

gonuke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bam241 Nov 27, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gonuke left a comment

Choose a reason for hiding this comment

bam241 left a comment

Choose a reason for hiding this comment

gonuke commented Nov 27, 2019

bam241 commented Nov 27, 2019 • edited

gonuke commented Nov 27, 2019

bam241 commented Nov 27, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

katyhuff commented Jan 27, 2020

gonuke left a comment

Choose a reason for hiding this comment

bam241 commented Oct 30, 2019 •

edited

bam241 Nov 27, 2019 •

edited

bam241 commented Nov 27, 2019 •

edited

bam241 commented Nov 27, 2019 •

edited