Iterating over private vector

Hi,
I'm trying to learn how to use C++ properly and I've run into a dilemma.

If I have a class which has a private vector and I want to allow a client of this class to iterate over the objects in the vector how should this be done?

Should I write a public function which return a reference to the vector? Should I return an iterator some how?

Any snippets of code would be appreciated. Obviously no examples are required for the case where a reference is returned.

I would like to know what the most correct way of doing this is and why.

Why does the client need to access private data? You might get ideas for better class interface if you post your code here. If there's a very good reason to let the user of the class access private data, you could declare a friend function; but it's contrary to the spirit of encapsulation.

I'll try and simplify my example.

Let's say there is a class Canvas which has a vector of shapes.

Code:

---

class Canvas
{
public:
 addShape(const Shape &shape);
 deleteShape(...);

private:
 vector<Shape> shapes;
}

---

Lets say the client may want to iterate through all the shapes in a canvas so they can do something with them - draw them for example.

One option I guess is to add a getShape(int n); and size() function so the client can do something like this.

Code:

---

for (int i=0; i<canvas.size(); i++)
{
 canvas.getShape(i).draw()
}

---

I don't know if this is the best way of doing something along those lines. I'm wondering if there are any better suggestions.

It all depends on how much control you want to give the client code.

Do you want to allow the client to add or remove shapes from the vector without using your addShape or deleteShape calls? If so, go ahead and expose the vector.

Do you want to allow the client to modify existing shapes in the vector? If so, expose the vector's begin and end iterators.

Do you only want your client to have readonly access into the vector? If so, expose the vector's const begin and end iterators.

Quote:

---

Do you want to allow the client to modify existing shapes in the vector? If so, expose the vector's begin and end iterators.

---

How is something like this done?

Create begin and end functions in your class and let them return the begin and end iterators from the vector.

I'd also create a public typedef of the vector's iterator type to simplify the code on both your end and the client's end.

Code:

---

class Canvas
{
private:
 vector<Shape> shapes;
public:
 typedef vector<Shape>::iterator iterator;

 iterator begin() { return shapes.begin(); }
 iterator end() { return shapes.end(); }
}

---

The client could just use auto, but sure.
Exposing the const_iterators wouldn't be a bad idea, either, since otherwise the class wouldn't work with const functions.

Thanks for the help. I will need to read up on how iterators work.

Keep in mind that by allowing access to the iterators you are essentially allowing access to the contents of the private container. This may or may not be what you want.