Rename libsigrokxx to the more common libsigrokcxx.

[libsigrok.git] / bindings / cxx / include / libsigrok / libsigrok.hpp

diff --git a/bindings/cxx/include/libsigrok/libsigrok.hpp b/bindings/cxx/include/libsigrok/libsigrok.hpp
index 1c99670360c5657a82b62f3f7c4866ecfbf54ce8..5b53da94e548ce3b89814dc915b3d11039dccee4 100644 (file)
--- a/bindings/cxx/include/libsigrok/libsigrok.hpp
+++ b/bindings/cxx/include/libsigrok/libsigrok.hpp
@@ -24,8 +24,8 @@
 Introduction
 ------------
 
-The sigrok++ API provides an object-oriented C++ interface to the functionality
-in libsigrok, including automatic memory and resource management.
+The libsigrokcxx API provides an object-oriented C++ interface to the
+functionality in libsigrok, including automatic memory and resource management.
 
 It is built on top of the public libsigrok C API, and is designed to be used as
 a standalone alternative API. Programs should not mix usage of the C and C++
@@ -45,10 +45,10 @@ use. The C++ interface code also keeps track of internal dependencies between
 libsigrok resources, and ensures that objects are not prematurely deleted when
 their resources are in use by other objects.
 
-This means that management of sigrok++ objects and their underlying libsigrok
-resources can be treated as fully automatic. As long as all shared pointers to
-objects are deleted or reassigned when no longer in use, all underlying
-resources will be released at the right time.
+This means that management of libsigrokcxx objects and their underlying
+libsigrok resources can be treated as fully automatic. As long as all shared
+pointers to objects are deleted or reassigned when no longer in use, all
+underlying resources will be released at the right time.
 
 Getting started
 ---------------
@@ -292,6 +292,7 @@ public:
        /** Open an input stream based on header data.
         * @param header Initial data from stream. */
        shared_ptr<Input> open_stream(string header);
+       map<string, string> serials(shared_ptr<Driver> driver);
 protected:
        map<string, Driver *> _drivers;
        map<string, InputFormat *> _input_formats;
@@ -706,6 +707,8 @@ public:
        void append(void *data, size_t length, unsigned int unit_size);
        /** Get current trigger setting. */
        shared_ptr<Trigger> trigger();
+       /** Get the context. */
+       shared_ptr<Context> context();
        /** Set trigger setting.
         * @param trigger Trigger object to use. */
        void set_trigger(shared_ptr<Trigger> trigger);