Functions - By Category End of trail navigation bar

Table of Contents > QUARC > User's Guide > QUARC MATLAB Functions

Functions - Alphabetical List

A

H

Q

S

V

A

apriltag_get_families

Get a list of the April tag families currently available.

apriltag_get_family

Get information about an April tag family.

apriltag_show_tag

Display the April tag(s) of a given family and identifier(s).

H

hil_*

The deprecated HIL API functions is no longer recommended. The recommended method is to call the quanser.hardware.hil class, which support code generation to Quanser targets.

Q

qc_add_target_uri

Causes a QUARC target to start serving on a particular URI.

qc_build_libraries

Builds the standard Simulink Coder libraries for licensed QUARC targets.

qc_build_model

Builds the code for a model.

qc_build_script

Builds a MATLAB script for a target.

qc_check_model

Checks for Simulink blocks with problems and recommend QUARC replacements.

qc_clean_libraries

Removes the standard RTW libraries for licensed QUARC targets in preparation for rebuilding them.

qc_clean_model

Removes generated code for a model in preparation for a fresh build.

qc_connect_model

Connects a model to its real-time code on a target in external mode.

qc_convert_model_non_toolchain

Converts a model from using QUARC toolchain-based targets to non-toolchain-based targets.

qc_convert_to_q3d

Converts an x3d mesh file to a proprietary q3d format.

qc_disconnect_model

Disconnects a model from its real-time code on a target in external mode.

qc_download_model

Downloads the generated code for a model to a QUARC target.

qc_draw_text

Draws text directly on an image rather than using a figure window or axes.

qc_error

Issues the error corresponding to an error code.

qc_find_ati_netft_sensors

Scans the local network for ATI Net F/T sensors.

qc_find_targets

Scans the local network for QUARC targets and returns information about them.

qc_get_config_string

Retrieves a value in a string based on a configuration set.

qc_get_config_strings

Retrieves all the values in a configuration string.

qc_get_config_variable

Gets the value of configuration-set variable.

qc_get_default_compiler

Returns the default compiler for the given target type.

qc_get_default_model_copy

Returns the default filename to which models are copied.

qc_get_default_model_log

Gets the default filename for model logging.

qc_get_default_model_uri

Returns the default model URI for the given target type.

qc_get_default_target_type

Returns the default target type for QUARC.

qc_get_default_target_uri

Returns the default target URI for a particular protocol or model URI.

qc_get_downloaded_models

Retrieves a list of the models that have been downloaded to a QUARC target.

qc_get_error_message

Gets the error message corresponding to an error code.

qc_get_error_names

Returns the names of the error codes used by QUARC.

qc_get_expression_parts

Breaks a string into the vector elements.

qc_get_fonts

Gets information about the fonts installed on the system.

qc_get_key_state

Returns the state of a particular key on the keyboard.

qc_get_languages

Returns a structure array of the languages available on the current (host) machine.

qc_get_loaded_models

Retrieves a list of the models that are loaded on a QUARC target.

qc_get_model_arguments

Returns the model arguments for the given model or configuration set.

qc_get_model_copy

Returns the filename to which to copy the given model for logging purposes.

qc_get_model_extension

Returns the extension used for generated code for the given model or configuration set.

qc_get_model_log

Returns the filename of the log for the given model or configuration set.

qc_get_model_uri

Returns the model URI for the given model or configuration set.

qc_get_models_loaded_at_boot

Retrieves a list of the models that configured to load on a QUARC target at boot time.

qc_get_network_interfaces

Gets a list of network interfaces available.

qc_get_num_cpus

Returns the number of CPUs on the current (host) machine.

qc_get_remote_target_type

Returns the type of QUARC target.

qc_get_step_size

Returns the step size of the model.

qc_get_simulation_mode

Gets the simulation mode of the model.

qc_get_simulation_status

Gets the simulation status of the model.

qc_get_target_description

Returns a description of the target for the given model or configuration set or target type.

qc_get_target_type

Returns the target type for the given model or configuration set.

qc_get_target_types

Returns a cell array of the valid target types for QUARC.

qc_get_target_uri

Returns the target URI for the given model or configuration set.

qc_get_target_uris

Returns a list of all the URIs that may be used to connect to a target.

qc_get_target_version

Returns the version of QUARC installed on a given target.

qc_get_uri_dialog

Open a dialog box to get a communications URI.

qc_get_valid_target_protocols

Returns a list of the communications protocols that may be used in a target URI.

qc_get_version

Returns the QUARC version as a structure.

qc_get_voices

Returns a structure array of the voices available for speech synthesis.

qc_is_big_endian

Returns true if MATLAB is running on a big endian platform and false otherwise.

qc_is_model

Returns true if the argument is a Simulink model. Otherwise returns false.

qc_is_model_loaded

Determines whether a particular model is loaded on a QUARC target.

qc_is_model_open

Returns true if the argument is a Simulink model that is loaded in MATLAB. Otherwise returns false.

qc_is_target_type

Returns true if the argument defines a valid QUARC target type.

qc_kill_model

Forcefully terminates a model on the target (NOT RECOMMENDED).

qc_load_model

Loads the generated code for a model on a QUARC target.

qc_load_model_at_boot

Configure a model to load on a QUARC target at boot time.

qc_model_console

Opens a console to monitor the model's standard I/O as it runs on a QUARC target.

qc_open_target_dialog

Opens a dialog for managing a target.

qc_perform_substitutions

Returns the format string after substituting for format specifiers.

qc_remove_downloaded_model

Deletes a previously downloaded model on a QUARC target.

qc_remove_model_loaded_at_boot

Removes the model from the list of models configured to load on a QUARC target at boot time.

qc_remove_target_uri

Stops a QUARC target from serving on a particular URI.

qc_run_script

Downloads and runs a script executable on a target.

qc_root

Returns the installation directory for QUARC.

qc_script_console

Opens a console to monitor a script executable's standard input and output.

qc_set_config_string

Sets the value in a configuration string corresponding to a configuration set.

qc_set_config_variable

Creates or updates a configuration-set variable.

qc_set_default_compiler

Sets the default compiler for the given target type.

qc_set_default_model_copy

Sets the default filename to which to copy a model.

qc_set_default_model_log

Sets the default filename for model logs.

qc_set_default_model_uri

Sets the default model URI for a particular target type.

qc_set_default_target_type

Sets the default target type for QUARC.

qc_set_default_target_uri

Sets the default URI for a particular protocol or model URL.

qc_set_model_arguments

Sets the model MEX-file arguments for the given model or configuration set.

qc_set_model_copy

Sets the filename to which to copy given model.

qc_set_model_log

Sets the filename of the log for the given model or configuration set.

qc_set_model_uri

Sets the model URI for the given model or configuration set.

qc_set_options

Sets the model options for QUARC.

qc_set_priority

Sets the priority of the MATLAB process and/or thread on the host.

qc_set_simulation_mode

Sets the simulation mode of the model.

qc_simulate_load_model

Simulates loading a model.

qc_simulate_switch_to_model

Simulates switching in one model while switching out another.

qc_speak

Speaks the given formatted string.

qc_start_model

Starts a model in normal or external mode.

qc_stop_model

Stops a model in normal or external mode.

qc_switch_to_model

Switches in one model on a target while switching out another.

qc_terminate_unconnected_ports

Terminate unconnected ports in a model or subsystem.

qc_update_model

Updates a model diagram, propagating workspace variable changes to real-time code.

qc_upgrade_blocks

Upgrades blocks in a model to the latest version of QUARC (fixes broken links).

qc_xml_to_struct

Read an XML file as a MATLAB structure.

qc_xml_write

Writes an XML document to a file, removing extraneous newlines.

quarc_setup

Sets up QUARC or removes QUARC from the current Matlab version.

S

stream_accept

Accepts a connection from a client.

stream_close

Closes the specified stream.

stream_close_all

Closes all open streams.

stream_connect

Connects to a server.

stream_flush

Flushes the stream buffer to the underlying communication channel.

stream_ignore

Reads and discards the given number of bytes from the stream.

stream_listen

Creates a listening stream.

stream_poll

Polls the stream for different conditions.

stream_print

Prints formatted text to a stream.

stream_print_array

Prints formatted text to a stream as an atomic unit.

stream_receive

Receives data over a stream.

stream_receive_array

Receives data over a stream as an atomic unit.

stream_receive_double

Receive a double over the stream.

stream_receive_double_array

Receive a double array over the stream as an atomic unit.

stream_receive_doubles

Receives an array of doubles over the stream.

stream_receive_int8

Receives a signed 8-bit integer over the stream.

stream_receive_int8_array

Receives an array of signed 8-bit integers over the stream as an atomic unit.

stream_receive_int8s

Receives an array of signed 8-bit integers over the stream.

stream_receive_int16

Receive a signed 16-bit integer over the stream.

stream_receive_int16_array

Receives an array of signed 16-bit integers over the stream as an atomic unit.

stream_receive_int16s

Receives an array of signed 16-bit integers over the stream.

stream_receive_int32

Receives a signed 32-bit integer over the stream.

stream_receive_int32_array

Receives an array of signed 32-bit integers over the stream as an atomic unit.

stream_receive_int32s

Receives an array of signed 32-bit integers.

stream_receive_int64

Receives a signed 64-bit integer over the stream.

stream_receive_int64_array

Receives an array of signed 64-bit integers as an atomic unit.

stream_receive_int64s

Receives an array of signed 64-bit integers.

stream_receive_single

Receives a single 32-bit real number of the stream.

stream_receive_single_array

Receives an array of single 32-bit real number of the stream as an atomic unit.

stream_receive_singles

Receives an array of single 32-bit real number of the stream.

stream_scan

Scans formatted text from the stream.

stream_scan_array

Scans formatted text from the stream as an atomic unit.

stream_send

Sends data to the stream.

stream_send_array

Sends data as an atomic unit to the stream.

stream_send_double

Sends a 64-bit real number to the stream.

stream_send_double_array

Sends an array of 64-bit real numbers to the stream as an atomic unit.

stream_send_doubles

Sends an array of 64-bit real numbers to the stream.

stream_send_int8

Sends a signed 8-bit integer to the stream.

stream_send_int8_array

Sends an array of signed 8-bit integers to the stream as an atomic unit.

stream_send_int8s

Sends an array of signed 8-bit integers to the stream.

stream_send_int16

Sends a signed 16-bit integer to the stream.

stream_send_int16_array

Sends an array of signed 16-bit integers to the stream as an atomic unit.

stream_send_int16s

Sends an array of signed 16-bit integers to the stream.

stream_send_int32

Sends a signed 32-bit integer to the stream.

stream_send_int32_array

Sends an array of signed 32-bit integers to the stream as an atomic unit.

stream_send_int32s

Sends an array of signed 32-bit integers to the stream.

stream_send_int64

Sends a signed 64-bit integer to the stream.

stream_send_int64_array

Sends an array of signed 64-bit integers to the stream as an atomic unit.

stream_send_int64s

Sends an array of signed 64-bit integers to the stream.

stream_send_single

Sends a single 32-bit real number to the stream.

stream_send_single_array

Sends an array of 32-bit real numbers to the stream as an atomic unit.

stream_send_singles

Sends an array of 32-bit real numbers to the stream.

stream_set_byte_order

Configure the byte order used by the stream for multi-byte data types.

stream_set_swap_bytes

Configures the stream to swap bytes in multibyte data types.

stream_shutdown

Shuts down the stream but does not close it.

V

visualization_get_frame_period

Returns the frame rate associated with a Visualization block as a period in seconds.

visualization_get_frame_rate

Returns the frame rate in Hz associated with a Visualization block.

 

navigation bar