QDMI v1.1.0
Quantum Device Management Interface
Loading...
Searching...
No Matches
device.h File Reference

Description

Defines the QDMI Device Interface.

Go to the source code of this file.

Typedefs

typedef struct QDMI_Device_Session_impl_d * QDMI_Device_Session
 A handle for a device session.
 
typedef struct QDMI_Device_Job_impl_d * QDMI_Device_Job
 A handle for a device job.
 

Functions

int QDMI_device_initialize (void)
 Initialize a device.
 
int QDMI_device_finalize (void)
 Finalize a device.
 
int QDMI_device_session_alloc (QDMI_Device_Session *session)
 Allocate a new device session.
 
int QDMI_device_session_set_parameter (QDMI_Device_Session session, QDMI_Device_Session_Parameter param, size_t size, const void *value)
 Set a parameter for a device session.
 
int QDMI_device_session_init (QDMI_Device_Session session)
 Initialize a device session.
 
void QDMI_device_session_free (QDMI_Device_Session session)
 Free a QDMI device session.
 
int QDMI_device_session_query_device_property (QDMI_Device_Session session, QDMI_Device_Property prop, size_t size, void *value, size_t *size_ret)
 Query a device property.
 
int QDMI_device_session_query_site_property (QDMI_Device_Session session, QDMI_Site site, QDMI_Site_Property prop, size_t size, void *value, size_t *size_ret)
 Query a site property.
 
int QDMI_device_session_query_operation_property (QDMI_Device_Session session, QDMI_Operation operation, size_t num_sites, const QDMI_Site *sites, size_t num_params, const double *params, QDMI_Operation_Property prop, size_t size, void *value, size_t *size_ret)
 Query an operation property.
 
int QDMI_device_session_create_device_job (QDMI_Device_Session session, QDMI_Device_Job *job)
 Create a job.
 
int QDMI_device_job_set_parameter (QDMI_Device_Job job, QDMI_Device_Job_Parameter param, size_t size, const void *value)
 Set a parameter for a job.
 
int QDMI_device_job_submit (QDMI_Device_Job job)
 Submit a job to the device.
 
int QDMI_device_job_cancel (QDMI_Device_Job job)
 Cancel an already submitted job.
 
int QDMI_device_job_check (QDMI_Device_Job job, QDMI_Job_Status *status)
 Check the status of a job.
 
int QDMI_device_job_wait (QDMI_Device_Job job)
 Wait for a job to finish.
 
int QDMI_device_job_get_results (QDMI_Device_Job job, QDMI_Job_Result result, size_t size, void *data, size_t *size_ret)
 Retrieve the results of a job.
 
void QDMI_device_job_free (QDMI_Device_Job job)
 Free a job.