Skip to content
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

Jump to bottom

Choosing reference over pointer #314

Closed
shakthi-prashanth-m opened this issue Mar 12, 2018 · 2 comments
Closed

Choosing reference over pointer #314

shakthi-prashanth-m opened this issue Mar 12, 2018 · 2 comments
Assignees
@shakthi-prashanth-m
Labels
enhancement

Comments

@shakthi-prashanth-m
Copy link
Contributor

It is recommended to use references when we can, and pointers when we have to.
(Reference: https://isocpp.org/wiki/faq/references#refs-vs-ptrs)

We can replace Device *_parent to Device & _parent as I see that, its possible. We initialize while activating plugin and never modify it. Also, we have a method (below) that actually gives, a reference to a device, not pointer.

Device &device(uint64_t uuid);

Consider, below piece of application code:

Device &device = dc.device(); // we get reference to device
auto action = std::make_shared<Action>(&device); // why pass its address ?

// Why not pass it as-is?
auto action = std::make_shared<Action>(device);

I just noticed this.
@julianoes, was it done intentionally for some vital reason? If not, then we can find similar usages and replace them properly.
@julianoes
Copy link
Collaborator

I tend to agree. Thanks for writing that up @shakthi-prashanth-m. Do you agree @JonasVautherin?

@JonasVautherin
Copy link
Collaborator

Yes, I agree. I usually use references and smart pointers instead of raw pointers.

@shakthi-prashanth-m shakthi-prashanth-m self-assigned this Mar 12, 2018
shakthi-prashanth-m pushed a commit that referenced this issue Mar 13, 2018
Replace pointers to reference wherever possible (#314)
e7a5bcf 
Replace `Device *PluginImplBase::parent` => `Device &PluginImplBase::parent`.
And replaces everywhere as required.
shakthi-prashanth-m pushed a commit that referenced this issue Mar 13, 2018
Replace pointers => references (#314)
6317a98 
Replaced wherever applicabale.
shakthi-prashanth-m pushed a commit that referenced this issue Mar 13, 2018
Replace raw pointers => smart pointers (#314)
8041602 
Smart pointers provide automatic resource management. In other words,
they implement "Resource Acquisition Is Initialialization programming idiom".
The main goal of this idiom is to ensure that resource acquisition occurs
at the same time that the object is initialized, so that all resources
for the object are created and made ready in one line of code.

`std::unique_ptr` is a smart pointer that owns and manages another object
through a pointer and disposes of that object when the unique_ptr goes out of scope.

Ref 1: https://docs.microsoft.com/en-us/cpp/cpp/smart-pointers-modern-cpp
Ref 2: http://en.cppreference.com/w/cpp/memory/unique_ptr
@shakthi-prashanth-m shakthi-prashanth-m mentioned this issue Mar 13, 2018
Merged
shakthi-prashanth-m pushed a commit that referenced this issue Mar 13, 2018
external_example: Pass device by refernece (#314)
ec5694f 
In `CMakeLists.txt`, include directory for example.h is added.
shakthi-prashanth-m pushed a commit that referenced this issue Mar 13, 2018
core: Make use of shared pointers (#314)
1e2b53b 
This replaces raw pointers used in connections and devices
by smart pointers. This avoids, freeing them in destructor and also
makes code clean and readable.
shakthi-prashanth-m pushed a commit that referenced this issue Mar 13, 2018
plugins: Doc update of API usage (#314)
d3047cf 
Updates all the plugin API description about passing device object,
instead of pointer to it.
@hamishwillee hamishwillee mentioned this issue Mar 13, 2018
Closed
JonasVautherin pushed a commit that referenced this issue Mar 14, 2018
@JonasVautherin
Replace pointers to reference wherever possible (#314)
1462ad1 
Replace `Device *PluginImplBase::parent` => `Device &PluginImplBase::parent`.
And replaces everywhere as required.
JonasVautherin pushed a commit that referenced this issue Mar 14, 2018
@JonasVautherin
Replace pointers => references (#314)
ed3a4d1 
Replaced wherever applicabale.
JonasVautherin pushed a commit that referenced this issue Mar 14, 2018
@JonasVautherin
Replace raw pointers => smart pointers (#314)
f1cfa59 
Smart pointers provide automatic resource management. In other words,
they implement "Resource Acquisition Is Initialialization programming idiom".
The main goal of this idiom is to ensure that resource acquisition occurs
at the same time that the object is initialized, so that all resources
for the object are created and made ready in one line of code.

`std::unique_ptr` is a smart pointer that owns and manages another object
through a pointer and disposes of that object when the unique_ptr goes out of scope.

Ref 1: https://docs.microsoft.com/en-us/cpp/cpp/smart-pointers-modern-cpp
Ref 2: http://en.cppreference.com/w/cpp/memory/unique_ptr
JonasVautherin pushed a commit that referenced this issue Mar 14, 2018
@JonasVautherin
external_example: Pass device by refernece (#314)
55d958b 
In `CMakeLists.txt`, include directory for example.h is added.
JonasVautherin pushed a commit that referenced this issue Mar 14, 2018
@JonasVautherin
core: Make use of shared pointers (#314)
7d1da9c 
This replaces raw pointers used in connections and devices
by smart pointers. This avoids, freeing them in destructor and also
makes code clean and readable.
JonasVautherin pushed a commit that referenced this issue Mar 14, 2018
@JonasVautherin
plugins: Doc update of API usage (#314)
a2b9db9 
Updates all the plugin API description about passing device object,
instead of pointer to it.
JonasVautherin added a commit that referenced this issue Mar 14, 2018
@JonasVautherin
fix backend following #314
0794c71
JonasVautherin added a commit that referenced this issue Mar 15, 2018
@JonasVautherin
fix backend following #314
4fe6cf6
@mrpollo mrpollo mentioned this issue Jun 5, 2018
Closed
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
Replace pointers to reference wherever possible (mavlink#314)
ca489c8 
Replace `Device *PluginImplBase::parent` => `Device &PluginImplBase::parent`.
And replaces everywhere as required.
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
Replace pointers => references (mavlink#314)
807fc9d 
Replaced wherever applicabale.
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
Replace raw pointers => smart pointers (mavlink#314)
96f91d8 
Smart pointers provide automatic resource management. In other words,
they implement "Resource Acquisition Is Initialialization programming idiom".
The main goal of this idiom is to ensure that resource acquisition occurs
at the same time that the object is initialized, so that all resources
for the object are created and made ready in one line of code.

`std::unique_ptr` is a smart pointer that owns and manages another object
through a pointer and disposes of that object when the unique_ptr goes out of scope.

Ref 1: https://docs.microsoft.com/en-us/cpp/cpp/smart-pointers-modern-cpp
Ref 2: http://en.cppreference.com/w/cpp/memory/unique_ptr
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
external_example: Pass device by refernece (mavlink#314)
8670917 
In `CMakeLists.txt`, include directory for example.h is added.
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
core: Make use of shared pointers (mavlink#314)
d67c886 
This replaces raw pointers used in connections and devices
by smart pointers. This avoids, freeing them in destructor and also
makes code clean and readable.
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
plugins: Doc update of API usage (mavlink#314)
6503ed4 
Updates all the plugin API description about passing device object,
instead of pointer to it.
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this issue Nov 27, 2018
@JonasVautherin
fix backend following mavlink#314
ee4ee3a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shakthi-prashanth-m shakthi-prashanth-m

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@julianoes @JonasVautherin @shakthi-prashanth-m