Ets_Topo_Object_Get()
Abstract
Returns a handle to the indexed member object of the specified type in the specified model.
Syntax
Ets_Topo_Object_Get (model_hndl, obj_mtype, obj_index)
| Argument | Type | Description |
|---|---|---|
model_hndl |
EtsT_Model_Handle |
Handle to the (network) model. |
obj_mtype |
“EtsT_Obj_Type“ |
Value specifying the type or meta-type of member object (one of the values in Table 33 “General Sub-Package Symbolic Constants“ on page 1046). |
obj_index |
int |
Index specifying which of the member objects to return. |
Return Type
EtsT_Obj_Handle
Handle to the member object.
Header
ets_api_topo.h
Details
The member objects of a network model are the nodes, subnets, links, and annotations that have be installed (indirectly) into the model as well as the model’s top subnet itself. Currently, only network models have constituent objects.
The obj_mtype argument can be either a specific object type (e.g., EtsC_Obj_Type_Node_Fix) or a general object meta-type (e.g., EtsC_Obj_Mtype_Link).
The obj_index argument must be a value between zero (inclusive) and the count (exclusive) returned by Ets_Topo_Object_Count_Get(), when called with the same model and the same object type.