search

JiphuTzu / pococapsule

Automatically exported from code.google.com/p/pococapsule
0 stars 0 forks source link

Add more documentation about <array type="namevalue"> #7

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
This is a enhancement request for the Developer Guide documentation.

The file "pococpp-iocdsm-dev-guide102.pdf" mentions that <array> can have
type "namevalue" but doesn't really say more than that about how to use it.
 I know that <item> can have "name" and "value" attributes, but it is not
at all clear how my code is supposed to access that information.

It would be nice if an example was included in the documentation that shows
how to use an array of type="namevalue", and how PocoCapsule turns that
into invocation code.  For example, I tried creating such an array, and was
surprised to see the proxy code referring to a type called
"POCO_NameValue", which never seemed to be mentioned in the documentation.

If this issue would be better as a forum discussion, I will be happy to
participate.

Original issue reported on code.google.com by bra...@gmail.com on 6 Mar 2009 at 7:53

GoogleCodeExporter commented 9 years ago 
> The file "pococpp-iocdsm-dev-guide102.pdf" mentions that <array> can have
> type "namevalue" but doesn't really say more than that about how to use it.
> I know that <item> can have "name" and "value" attributes, but it is not
> at all clear how my code is supposed to access that information.

<array> of namevalue was largely introduced for PocoCapsule internal
use (CORBA integration). However, its usage should be self-explained.
Namely, it will pass the argument as two parameters. The first one (as
in the case of other array types) is the count of the array. The
second parameter is the array itself. The array element in this case
is a struct with two 'const char*' fields. By default, the struct type
id is POCO_NameValue (defined in poco.h). User can override this
definition with another struct with different type name, as long as it
has the name and value fields.

Without using this feature, the same feature (actually, support more
generic name-value) can also be achieved using DSM (similart to how
<map>, <list> are supported in pococapsule). Therefore, this feature
wasn't documented in detail.

> It would be nice if an example was included in the documentation that shows>
> how to use an array of type="namevalue", and how PocoCapsule turns that
> into invocation code.  For example, I tried creating such an array, and was
> surprised to see the proxy code referring to a type called
> "POCO_NameValue", which never seemed to be mentioned in the documentation.

POCO_NameValue is defined in poco.h.

Original comment by kjin...@gmail.com on 9 Mar 2009 at 3:25

GoogleCodeExporter commented 9 years ago 
forwarded to the pococapsule forum:
http://groups.google.com/group/pococapsule/browse_thread/thread/9f48984e1fd097e4

Original comment by kjin...@gmail.com on 9 Mar 2009 at 5:23

GoogleCodeExporter commented 9 years ago

Original comment by kjin...@gmail.com on 31 Mar 2010 at 5:28