C-API | OP_ATTRIBUTE

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.

C-API | OP_ATTRIBUTE

Description

Use this enumeration to specify the type of attribute you want to use on a given object with the OpalGetAttributes, OpalSetAttributes, OpalGetDefaultAttributes and OpalRestoreAttributes functions.

Usage

typedef enum{

ATT_UNKNOWN,

// STRING ATTRIBUTES

  • ATT_STRING_START

  • ATT_COMMAND_AFTER_OPENING_MODEL

  • ATT_COMMAND_BEFORE_OPENING_MODEL

  • ATT_CONFIGURATION_PASSWORD

  • ATT_EMTPRV_ROOT_DIR (deprecated)

  • ATT_FILE_RETRIEVAL_ROOT_DIR

  • ATT_MATLAB_ROOT_DIR

  • ATT_MATRIXX_ROOT_DIR (deprecated)

  • ATT_NAME

  • ATT_RTLAB_ROOT_DIR

  • ATT_DEVENVNODE

  • ATT_PYTHON_ROOT_DIR

  • ATT_USER_COMPILATION_COMMAND

  • ATT_USER_COMPILATION_OPTIONS

  • ATT_USER_EXTERNAL_LIBRARIES

  • ATT_USER_INCLUDE_PATH

  • ATT_USER_LIBRARY_PATH

  • ATT_USER_LINKER_OPTIONS

  • ATT_USER_SOURCE_FILES

  • ATT_USER_TLC_FILE

  • ATT_USER_TMF_FILE

  • ATT_XMATH_TARGET

  • ATT_DESCRIPTION

  • ATT_VALUE

  • ATT_DRIVE_MAPPING_HOST_DRIVE

  • ATT_DRIVE_MAPPING_TARGET_DRIVE

  • ATT_REPORT_FILE_ID

  • ATT_FTP_USER_NAME

  • ATT_FTP_USER_PASSWORD

  • ATT_OS

  • ATT_OS_VERSION

  • ATT_HW_ARCHITECTURE

  • ATT_TARGET_ASSIGNATION

  • ATT_STRING_END

// BOOLEAN ATTRIBUTES

  • ATT_BOOL_START

  • ATT_FREE_DISK_SPACE_LIMIT_CHECK

  • ATT_CACHEABLE_DMA_MEMORY_ACCESS

  • ATT_COMPILE_IN_DEBUG

  • ATT_DISPLAY_CONTROLLER

  • ATT_ENABLE_LOG_CONTROLLER

  • ATT_ENABLE_MONITORING

  • ATT_EXTENDED_TIMEOUT

  • ATT_FILE_RETRIEVAL_BUILD_TREE

  • ATT_FILE_RETRIEVAL_ENABLE

  • ATT_RESET_MODEL_ON_IO_MISSING

  • ATT_USE_RESTRICTED_MODE

  • ATT_IS_MODIFIED

  • ATT_DETECT_OVERRUNS

  • ATT_ENABLE_WATCHDOG

  • ATT_XHP_MODE

  • ATT_AUTOSAVE

  • ATT_RETURN_ON_AMBIGUITY

  • ATT_BOOL_END


// INT ATTRIBUTES

  • ATT_INT_START

  • ATT_ACTION_ON_OVERRUNS

  • ATT_DETECT_OVERRUNS

  • ATT_FREE_DISK_SPACE_LIMIT

  • ATT_MATLAB_VERSION

  • ATT_MESSAGE_PRECISION_FACTOR

  • ATT_REALTIME_COMMUNICATION_LINK

  • ATT_TARGET_PLATFORM

  • ATT_USE_RESTRICTED_MODE_AT

  • ATT_WATCHDOG_TIMEOUT

  • ATT_TARGET_DISPLAY_INFORMATION

  • ATT_REALTIME_MODE

  • ATT_SETTING_TARGET_PLATFORM

  • ATT_API_INSTANCE_ID

  • ATT_STATE

  • ATT_CONTROLLER_DEBUGGER

  • ATT_OBJECT_TYPE

  • ATT_HW_NUMBER_CPUS

  • ATT_FUNCTIONAL_BLOCK

  • ATT_CONTROL_PRIORITY

  • ATT_CPU_ASSIGNATION

  • ATT_LOGICAL_ID

  • ATT_NUM_ROWS

  • ATT_NUM_COLUMNS

  • ATT_INT_END

 

// DOUBLE ATTRIBUTES

  • ATT_DOUBLE_START

  • ATT_PAUSE_TIME

  • ATT_STOP_TIME

  • ATT_TIME_FACTOR

  • ATT_FIXED_STEP_SIZE

  • ATT_DOUBLE_END


// INT64 ATTRIBUTES

  • ATT_INT64_START

  • ATT_REF_ID

  • ATT_HW_CPU_SPEED

  • ATT_HW_DISK_SPACE

  • ATT_INT64_END


// FILENAME ATTRIBUTES

  • ATT_FILENAME_START

  • ATT_FILENAME

  • ATT_SETTINGS_FILE

  • ATT_CURRENT_WORKING_DIRECTORY

  • ATT_FILENAME_END


} OP_ATTRIBUTE;

Elements

  • ATT_UNKNOWN: Unknown attribute. Do not use this attribute.

  • ATT_STRING_START: Attribute separator : beginning of string attributes. Do not use this attribute.

  • ATT_COMMAND_AFTER_OPENING_MODEL: 

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Matlab/Xmath command to execute after opening the model (when editing and compiling).

  • ATT_COMMAND_BEFORE_OPENING_MODEL:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Matlab/Xmath command to execute before opening the model (when editing and compiling).

  • ATT_CONFIGURATION_PASSWORD:

    • Type: char []

    • Applies to: RT-LAB

    • Controls: OP_FB_CONFIG

    • Description: Password required to change RT-LAB global settings.

  • ATT_FILE_RETRIEVAL_ROOT_DIR:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Directory where the files retrieves by RT-LAB after the model execution will be copy.

    • See : ATT_FILE_RETRIEVAL_BUILD_TREE, ATT_FILE_RETRIEVAL_ENABLE

  • ATT_MATLAB_ROOT_DIR:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Directory used to find the Matlab include and source files on target computer. Normally, it should be set to: "Automatic".

  • ATT_NAME:

    • Type: char []

    • Applies to: RT-LAB (read-only), Models/Projects

    • Controls: None, OP_FB_SYSTEM

    • Description: Name of the object.

  • ATT_RTLAB_ROOT_DIR:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Directory to be used to find the RT-LAB executables and include files and libraries on the target computer. Normally, it should be set to: "Automatic".

  • ATT_DEVENVNODE:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Target name where the compilation is
      done on the target.

  • ATT_PYTHON_ROOT_DIR:

    • Type: char []

    • Applies to: RT-LAB

    • Controls: OP_FB_CONFIG

    • Description: Python installation directory on host computer.

  • ATT_USER_COMPILATION_COMMAND:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: User command to be called on target during the compilation process.

 

  • ATT_USER_COMPILATION_OPTIONS:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Options used by the target compiler during the compilation process.

 

  • ATT_USER_EXTERNAL_LIBRARIES:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: External libraries (in addition to the standard system) used by the target linker during the linkage process.

 

  • ATT_USER_INCLUDE_PATH:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Target directory(s) where user include files can be found by the target compiler during the compilation process.

 

  • ATT_USER_LIBRARY_PATH:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Target directory(s) where user libraries can be found by the target linker during the linkage process.

 

  • ATT_USER_LINKER_OPTIONS:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Options used by the target linker during the linkage process.

 

  • ATT_USER_SOURCE_FILE:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Names of source files to be compiled in addition to the code generated by RTW/AutoCod by the target compiler during the compilation process.

 

  • ATT_USER_TLC_FILE: 

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls : OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Template tlc file used during the compilation of Simulink model. Normally, it should be set to Automatic.

  • ATT_USER_TMF_FILE:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Template makefile file used during the compilation of Simulink model. Normally, it should be set to Automatic.

  • ATT_XMATH_TARGET:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: Batch file used for starting Xmath.

  • ATT_DESCRIPTION:

    • Type: char []

    • Applies to: Project

    • Controls: OP_FB_SYSTEM

    • Description: Sums up the objective of an object in a nutshell.

  • ATT_VALUE:

    • Type: char []

    • Applies to: EnvironmentVariable

    • Controls: OP_FB_CONFIG (RT-LAB children), OP_FB_SYSTEM (Model children)

    • Description: Holds the value of an environment variable.

  • ATT_IP_ADDRESS:

    • Type: char []

    • Applies to: Target

    • Controls: OP_FB_CONFIG

    • Description: The IP address of a target node.

  • ATT_DRIVE_MAPPING_HOST_DRIVE:

    • Type: char []

    • Applies to: RT-LAB

    • Controls: OP_FB_CONFIG

    • Description: The host drive in a drive mapping.

  • ATT_DRIVE_MAPPING_TARGET_DRIVE:

    • Type: char []

    • Applies to: RT-LAB

    • Controls: OP_FB_CONFIG

    • Description: The target drive in a drive mapping.

  • ATT_REPORT_FILE_ID:

    • Type: char []

    • Applies to: RT-LAB, Models

    • Controls: OP_FB_CONFIG, OP_FB_SYSTEM

    • Description: The report file ID.

  • ATT_FTP_USER_NAME:

    • Type: char []

    • Applies to: RT-LAB

    • Controls: OP_FB_CONFIG

    • Description: The FTP user name.

  • ATT_FTP_USER_PASSWORD:

    • Type: char []

    • Applies to: RT-LAB

    • Controls: OP_FB_CONFIG

    • Description: The FTP user password.

  • ATT_OS:

    • Type: char []

    • Applies to: Target (read-only)

    • Controls: None

    • Description: The operating system running on the target.

  • ATT_OS_VERSION:

    • Type: char []

    • Applies to: Target (read-only)

    • Controls: None

    • Description: The version of the operating system running on the target.

  • ATT_HW_ARCHITECTURE:

    • Type: char []

    • Applies to: Target (read-only)

    • Controls: None

    • Description: The architecture of the hardware on the target.

  • ATT_TARGET_ASSIGNATION:

    • Type: char []

    • Applies to: Subsystems

    • Controls: OP_FB_CONFIG

    • Description: The name of the target assigned to a subsystem.

  • ATT_STRING_END: Attribute separator: end of string attributes. Do not use this attribute.

  • ATT_BOOL_START: Attribute separator: beginning of boolean attributes. Do not use this attribute.

  • ATT_FREE_DISK_SPACE_LIMIT_CHECK: