|
ChimeraTK::Module * | lookup (const std::string &flattened_module_name) |
|
std::list< std::string > | getChildList () |
|
void | seal () |
|
| VariableGroup (VariableGroup *owner, const std::string &name, const std::string &description, const std::unordered_set< std::string > &tags={}) |
| Constructor: Create VariableGroup register it with its owner. More...
|
|
| VariableGroup ()=default |
| Default constructor: Allows late initialisation of VariableGroups (e.g. More...
|
|
| VariableGroup (VariableGroup &&other) noexcept |
| Move constructor. More...
|
|
| VariableGroup (const VariableGroup &other) noexcept=delete |
|
| VariableGroup (VariableGroup *owner, const std::string &name, const std::string &description, const std::unordered_set< std::string > &tags={}) |
| Constructor: Create VariableGroup register it with its owner. More...
|
|
| VariableGroup ()=default |
| Default constructor: Allows late initialisation of VariableGroups (e.g. More...
|
|
| VariableGroup (VariableGroup &&other) noexcept |
| Move constructor. More...
|
|
| VariableGroup (const VariableGroup &other) noexcept=delete |
|
VariableGroup & | operator= (VariableGroup &&other) noexcept |
| Move assignment. More...
|
|
VariableGroup & | operator= (const VariableGroup &other) noexcept=delete |
|
ModuleType | getModuleType () const override |
| Return the module type of this module, or in case of a VirtualModule the module type this VirtualModule was derived from. More...
|
|
ChimeraTK::Model::VariableGroupProxy | getModel () |
| Return the application model proxy representing this module. More...
|
|
std::string | getVirtualQualifiedName () const override |
|
void | unregisterModule (Module *module) override |
| Unregister another module as a sub-module. More...
|
|
| Module (EntityOwner *owner, const std::string &name, const std::string &description, const std::unordered_set< std::string > &tags={}) |
| Constructor: Create Module by the given name with the given description and register it with its owner. More...
|
|
| Module ()=default |
| Default constructor: Allows late initialisation of modules (e.g. More...
|
|
| ~Module () override |
| Destructor. More...
|
|
| Module (Module &&other) noexcept |
| Move constructor. More...
|
|
Module & | operator= (Module &&other) noexcept |
| Move assignment operator. More...
|
|
virtual void | prepare () |
| Prepare the execution of the module. More...
|
|
virtual void | run () |
| Execute the module. More...
|
|
virtual void | terminate () |
| Terminate the module. More...
|
|
ChimeraTK::ReadAnyGroup | readAnyGroup () |
| Create a ChimeraTK::ReadAnyGroup for all readable variables in this Module. More...
|
|
void | readAll (bool includeReturnChannels=false) |
| Read all readable variables in the group. More...
|
|
void | readAllNonBlocking (bool includeReturnChannels=false) |
| Just call readNonBlocking() on all readable variables in the group. More...
|
|
void | readAllLatest (bool includeReturnChannels=false) |
| Just call readLatest() on all readable variables in the group. More...
|
|
void | writeAll (bool includeReturnChannels=false) |
| Just call write() on all writable variables in the group. More...
|
|
void | writeAllDestructively (bool includeReturnChannels=false) |
| Just call writeDestructively() on all writable variables in the group. More...
|
|
std::string | getQualifiedName () const override |
| Get the fully qualified name of the module instance, i.e. More...
|
|
std::string | getFullDescription () const override |
| Obtain the full description including the full description of the owner. More...
|
|
void | setOwner (EntityOwner *newOwner) |
| Set a new owner. More...
|
|
EntityOwner * | getOwner () const |
|
VersionNumber | getCurrentVersionNumber () const override |
| Return the current version number which has been received with the last push-type read operation. More...
|
|
void | setCurrentVersionNumber (VersionNumber version) override |
| Set the current version number. More...
|
|
DataValidity | getDataValidity () const override |
| Return the data validity flag. More...
|
|
void | incrementDataFaultCounter () override |
| Set the data validity flag to fault and increment the fault counter. More...
|
|
void | decrementDataFaultCounter () override |
| Decrement the fault counter and set the data validity flag to ok if the counter has reached 0. More...
|
|
std::list< EntityOwner * > | getInputModulesRecursively (std::list< EntityOwner * > startList) override |
| Use pointer to the module as unique identifier. More...
|
|
size_t | getCircularNetworkHash () const override |
| Get the ID of the circular dependency network (0 if none). More...
|
|
Module * | findApplicationModule () |
| Find ApplicationModule owner. More...
|
|
void | disable () |
| Disable the module such that it is not part of the Application. More...
|
|
| EntityOwner (std::string name, std::string description, std::unordered_set< std::string > tags={}) |
| Constructor: Create EntityOwner by the given name with the given description. More...
|
|
| EntityOwner () |
| Default constructor just for late initialisation. More...
|
|
virtual | ~EntityOwner ()=default |
| Virtual destructor to make the type polymorphic. More...
|
|
| EntityOwner (EntityOwner &&other) noexcept |
| Move constructor. More...
|
|
| EntityOwner (const EntityOwner &other)=delete |
|
EntityOwner & | operator= (EntityOwner &&other) noexcept |
| Move assignment operator. More...
|
|
EntityOwner & | operator= (const EntityOwner &other)=delete |
|
const std::string & | getName () const |
| Get the name of the module instance. More...
|
|
std::string | getQualifiedNameWithType () const |
| Get the fully qualified name of the module instance, followed by the C++ data type (in pointy brackets) More...
|
|
const std::string & | getDescription () const |
| Get the description of the module instance. More...
|
|
std::list< VariableNetworkNode > | getAccessorList () const |
| Obtain the list of accessors/variables directly associated with this instance. More...
|
|
std::list< Module * > | getSubmoduleList () const |
| Obtain the list of submodules associated with this instance. More...
|
|
std::list< VariableNetworkNode > | getAccessorListRecursive () const |
| Obtain the list of accessors/variables associated with this instance and any submodules. More...
|
|
std::list< Module * > | getSubmoduleListRecursive () const |
| Obtain the list of submodules associated with this instance and any submodules. More...
|
|
void | registerAccessor (VariableNetworkNode accessor) |
| Called inside the constructor of Accessor: adds the accessor to the list. More...
|
|
void | unregisterAccessor (const VariableNetworkNode &accessor) |
| Called inside the destructor of Accessor: removes the accessor from the list. More...
|
|
void | registerModule (Module *module, bool addTags=true) |
| Register another module as a sub-module. More...
|
|
void | addTag (const std::string &tag) |
| Add a tag to all Application-type nodes inside this group. More...
|
|
void | dump (const std::string &prefix="", std::ostream &stream=std::cout) const |
| Print the full hierarchy to given stream. More...
|
|
bool | hasReachedTestableMode () |
| Check whether this module has declared that it reached the testable mode. More...
|
|
template<typename T > |
std::string | constant (T value) |
| Create a variable name which will be automatically connected with a constant value. More...
|
|
Definition at line 68 of file ConfigReader.cc.