Signals

Defined in dfx/api/SignalAPI.hpp

Used to obtain DeepAffex Signal information.

Retrieve

virtual CloudStatus dfx::api::SignalAPI::list(const CloudConfig &config, const std::unordered_map<SignalFilter, std::string> &filters, uint16_t offset, std::vector<Signal> &signals, int16_t &totalCount)

Lists the known signals.

Parameters

  • config – provides all the cloud configuration settings

  • filters –

  • offset – to start the retrieval of records up to config.listLimit

  • signals –

  • totalCount – the total number of records on the server

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::SignalAPI::retrieve(const CloudConfig &config, const std::string &signalID, Signal &signal)

Retrieves a single Signal specified by ID. If the record is found the other fields of the signal instance will be returned.

Parameters

  • config – provides all the cloud configuration settings

  • signalID –

  • signal –

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::SignalAPI::retrieveMultiple(const CloudConfig &config, const std::vector<std::string> &signalIDs, std::vector<Signal> &signals)

Retrieves details for multiple signals based on list of signal IDs.

Parameters

  • config – provides all the cloud configuration settings

  • signalIDs – list of signal IDs to obtain details for

  • signals – details for the requested signal IDs

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::SignalAPI::retrieveStudySignalIDs(const CloudConfig &config, const std::string &studyID, std::vector<std::string> &signalIDs)

retrieve signalIDs in study

Parameters

  • config – provides all the cloud configuration settings

  • studyID –

  • signalIDs –

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::SignalAPI::retrieveSignalDetail(const CloudConfig &config, const std::string &signalID, Signal &signalDetail)

retrieve signal detail

Parameters

  • config – provides all the cloud configuration settings

  • signalID –

  • signalDetail –

Returns

status of operation, CLOUD_OK on SUCCESS

virtual CloudStatus dfx::api::SignalAPI::retrieveSignalDetails(const CloudConfig &config, const std::list<std::string> &signalIDs, std::vector<Signal> &signalDetails)

Retrieves details for multiple signals.

Parameters

  • config – provides all the cloud configuration settings

  • signalIDs –

  • signalDetails –

Returns

status of operation, CLOUD_OK on SUCCESS