add readme for tag parameter framework #3414
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| While defining a new Shogun class, `register_param()` or `register_member()` should be used in the constructor to register parameters and member variables of the class. This would allow the parameters or class member variables values to be queried or modified using `gets()` / `sets()`. These functions are required to prevent Shogun users to modify and query arbitrary parameters in an object but only those set of parameters which have been registered by using these two functions. The new Shogun class should also inherit `CSGObject` as these two functions are `protected` in `CSGObject`. Let's look at an example to make this more concrete. | ||
|
|
||
| ```cpp |
There was a problem hiding this comment.
|
|
||
| ### What are Tags? | ||
|
|
||
| `Tag` is a Shogun class which stores name and type information of a parameter. This allows a `Tag` object to be used as an identifier for a parameter in this new framework. Eg: |
|
Cool! I think it's very clear and only minor stuff needs to be fixed! |
Closed
|
This should be a wiki, no? |
|
Yes, I recently added a new repo for the wiki which can be cloned in a Wanna try? On Monday, 31 October 2016, Soumyajit De notifications@github.com wrote:
Sent from my phone |
|
Ill do it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have randomly placed it in
docfor now. I think this will go to the wiki. Sending a PR for feedback.@lisitsyn @vigsterkr