|
| | Bsp (boost::python::object obj) |
| | Constructs wrapper from existing Python object.
|
| |
| | Bsp (std::string modName, std::string rootClass) |
| | Constructs wrapper by importing module and instantiating root class.
|
| |
| | ~Bsp () |
| | Destroys wrapper (stops root when wrapper owns root instance).
|
| |
| void | addVarListener (void(*func)(std::string, std::string), void(*done)()) |
| | Registers variable listener callbacks on wrapped root.
|
| |
| std::string | getAttribute (std::string attribute) |
| | Returns string form of named attribute from wrapped object.
|
| |
| rogue::interfaces::api::Bsp | operator[] (std::string name) |
| | Returns wrapper for child node using node(name) lookup.
|
| |
| std::shared_ptr< rogue::interfaces::api::Bsp > | getNode (std::string name) |
| | Returns shared wrapper for child node using getNode(name).
|
| |
| std::string | operator() (std::string arg) |
| | Executes wrapped command node with string argument.
|
| |
| std::string | operator() () |
| | Executes wrapped command node without argument.
|
| |
| std::string | execute (std::string arg) |
| | Executes wrapped command node with string argument.
|
| |
| std::string | execute () |
| | Executes wrapped command node without argument.
|
| |
| void | set (std::string value) |
| | Sets wrapped variable value without forcing write transaction.
|
| |
| void | setWrite (std::string value) |
| | Sets wrapped variable value and forces write transaction.
|
| |
| std::string | get () |
| | Gets wrapped variable value without forcing read transaction.
|
| |
| std::string | readGet () |
| | Performs read transaction then gets wrapped variable value.
|
| |
C++ convenience wrapper around a PyRogue node object.
Bsp provides a small C++ API that forwards operations to underlying Python PyRogue objects through Boost.Python. It supports:
- constructing from an existing Python object
- constructing and starting a root class by module/class name
- node traversal (
operator[], getNode)
- command execution and variable set/get helper calls
- root-only variable listener registration
If constructed as a root wrapper (create(modName, rootClass)), destructor stops the root automatically.
Definition at line 44 of file Bsp.h.
| rogue::interfaces::api::Bsp::Bsp |
( |
std::string |
modName, |
|
|
std::string |
rootClass |
|
) |
| |
Constructs wrapper by importing module and instantiating root class.
This constructor is a low-level C++ allocation path. Prefer create() when shared ownership or Python exposure is required. Initializes Python, imports modName, constructs rootClass, starts it, and waits until the Python root reports running state.
- Parameters
-
| modName | Python module name containing root class. |
| rootClass | Python root class name to instantiate. |
Definition at line 46 of file Bsp.cpp.
Creates a wrapper from an existing Python object.
Parameter semantics are identical to the constructor; see Bsp(boost::python::object) for wrapping behavior details. This static factory is the preferred construction path when the object is shared across Rogue graph connections or exposed to Python. It returns std::shared_ptr ownership compatible with Rogue pointer typedefs.
- Parameters
-
| obj | Python object representing a PyRogue node/root. |
- Returns
- Shared pointer to created wrapper.
Company : SLAC National Accelerator Laboratory
Description:
C++ API BSP (Board Support Package)
This file is part of the rogue software platform. It is subject to the license terms in the LICENSE.txt file found in the top-level directory of this distribution and at: https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part of the rogue software platform, including this file, may be copied, modified, propagated, or distributed except according to the terms
contained in the LICENSE.txt file.
Definition at line 29 of file Bsp.cpp.
