op_ima_obj_attr_get_toggle()
Abstract
Obtains the value of a toggle attribute in the specified object.
Syntax
op_ima_obj_attr_get_toggle (objid, attr_name, value_ptr)
| Argument | Type | Description |
|---|---|---|
objid |
Objid |
object ID of the object-of-interest [An object ID can be obtained from several KPs in the Topo and Id packages: op_id_self(), op_topo_parent(), op_topo_child(), op_id_from_userid(), and op_id_from_name().] |
attr_name |
const char * |
name of the attribute-of-interest [This attribute must be of type toggle and defined in the specified object, or an error will occur.] |
value_ptr |
int * |
pointer to a variable to be filled with the specified attribute’s value |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the attribute value was successfully obtained; OPC_COMPCODE_FAILURE otherwise.
If you are dealing with merged compound attributes that are equal (see Note), value_ptr is set to the object ID of one of the merged compound attributes (which one is not specified) and OPC_COMPCODE_SUCCESS is returned. If the merged compound attributes are not equal, OPC_COMPCODE_FAILURE is returned.
Note: In the context of merged compound attributes, “equal” means that all attributes on the compound attribute object have the same name, type, and value, and all the child objects of the compound attribute are equal as well.
Example
int link_cond;
/* Get condition of link. */
op_ima_obj_attr_get_toggle (link_id , "condition", &link_cond);
Details
None.
Purpose
Provides a mechanism to dynamically obtain object attributes during the course of the simulation. This KP works identically to op_ima_obj_attr_get(), but applies only to object attributes of data type toggle. Refer to op_ima_obj_attr_get() for full purpose and details.
Errors
- Same as op_ima_obj_attr_get(), plus the following:
- Program Abort: Attribute (
<name>) is of type (<type>). Can’t get its value as type (boolean).
Reference
- Use the KPs op_ima_obj_attr_set(), op_ima_obj_attr_set_dbl(), op_ima_obj_attr_set_int32(), op_ima_obj_attr_set_objid(), op_ima_obj_attr_set_str(), and op_ima_obj_attr_set_toggle() to assign a value to an object attribute
- Use the KP op_ima_obj_attr_get_dbl() to obtain the value of an object attribute of type double
- Use the KP op_ima_obj_attr_get_int32() to obtain the value of an object attribute of type integer
- Use the KP op_ima_obj_attr_get_objid() to obtain the value of an object attribute of type objid
- Use the KP op_ima_obj_attr_get_str() to obtain the value of an object attribute of type string
- Use the KPs op_ima_sim_attr_get(), op_ima_sim_attr_get_dbl(), op_ima_sim_attr_get_int32(), and op_ima_sim_attr_get_str() to obtain the value of a simulation attribute
- Use the KP op_ima_obj_svar_get() to obtain the value of a process state variable
- Use the KP op_ima_obj_command() to issue a command to an object
- Use the KP op_id_self() to obtain the object ID of the surrounding processor or queue
- Use the KP op_id_from_name() to obtain the object ID of an arbitrary object