dsim_model member functions that provide object network management More...
Functions | |
| dsim_network * | dsim_model::create_managed_network (const char *name, const char *description) |
| Create a new object network managed by this model. | |
| dsim_network * | dsim_model::managed_network_with_name (const char *name) |
| Managed network with name. | |
dsim_model member functions that provide object network management
Often in a simulation, groups of objects form networks- power networks, modeling power flow; thermal networks, modeling heat transfer; etc - and models provide support for that capability with these functions.
Models can create networks; in the simulation setup file, then, connections between objects within the network can then be designated. These connections can also contain parameters, values that are assigned to the connection in the setup file and are then used by the network's manager to handle updates of the network.
Most network management is done via the dsim_network and dsim_connection classes; the functions here only provide network creation and lookup functionality. See those classes for additional documentation.
| dsim_network * dsim_model::create_managed_network | ( | const char * | name, |
| const char * | description | ||
| ) | [protected, inherited] |
Create a new object network managed by this model.
Creates a new managed network. Subsequent network configuration is then performed via the returned dsim_network object.
| name | The name to give the new network, which must be unique within the set of networks at this object. Must not be NULL. |
| description | A human-readable description of the purpose of this network, which will be displayed to users configuring this network during simulation setup. |
| dsim_network * dsim_model::managed_network_with_name | ( | const char * | name ) | [protected, inherited] |
Managed network with name.
Looks up a managed network created by this object.
| name | The name of the network of interest. Must not be NULL. |
1.7.2
