Documentation Home Page RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

GetDefaultAttributes

Group

Generic

Description

Get the default values of some object attributes.
See the OP_ATTRIBUTE enumeration for a complete list of available attributes.

Required Control

None

Usage

attributeValues = rtlabApi.GetDefaultAttributes (ids, attributes)
ids = (OP_REF, ...)
attributes = (OP_ATTRIBUTE, ...)
attributeValues = (value1, ...)

Input

  • ids: Tuple of object ids on witch the GetDefaultAttributes function will act. The size of the array must be equal to size of attributes tuple.

  • attributes: Tuple of attributes to get on the corresponding objects specified with the ids argument. The size of the array must be equal to size of attributes tuple.

Output

  • attributesValues: Tuple of values corresponding to each object ids and attributes.

Exception

  • EOK: Success.

  • EINVAL: Invalid arguments specified.

  • EBADF: Model not specified by previous Connect or OpenProject.

  • EIO: Error sending the request or receiving the reply.

Examples

None

Related Items

GetAttributes, SetAttributes, RestoreAttributes, OP_ATTRIBUTE.

Modules

import RtlabApi

 

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323