Skip to content

Adding metadata for SpecAn Private APIs and generating gRPC Server code #1229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RahulBenaka merged 2 commits into from
Dec 12, 2025
Merged

Adding metadata for SpecAn Private APIs and generating gRPC Server code #1229

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c85e5b3
Adding metadata for SpecAn Private APIs and generating gRPC Server code
RahulNagaraju15 Dec 10, 2025
2b72b43
Locking mypy-protobuf version to 3.6.0 and reverting all the other ch…
RahulNagaraju15 Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions generated/nirfmxspecan_restricted/nirfmxspecan_restricted.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ service NiRFmxSpecAnRestricted {
rpc AMPMLoadReferenceWaveformFromTDMSFile(AMPMLoadReferenceWaveformFromTDMSFileRequest) returns (AMPMLoadReferenceWaveformFromTDMSFileResponse);
rpc CacheResult(CacheResultRequest) returns (CacheResultResponse);
rpc IQFetchDataOverrideBehavior(IQFetchDataOverrideBehaviorRequest) returns (IQFetchDataOverrideBehaviorResponse);
rpc DPDApplyDigitalPredistortionToWaveformFromTDMSFile(DPDApplyDigitalPredistortionToWaveformFromTDMSFileRequest) returns (DPDApplyDigitalPredistortionToWaveformFromTDMSFileResponse);
rpc DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile(DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileRequest) returns (DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileResponse);
rpc DPDLoadReferenceWaveformFromTDMSFile(DPDLoadReferenceWaveformFromTDMSFileRequest) returns (DPDLoadReferenceWaveformFromTDMSFileResponse);
rpc IDPDLoadReferenceWaveformFromTDMSFile(IDPDLoadReferenceWaveformFromTDMSFileRequest) returns (IDPDLoadReferenceWaveformFromTDMSFileResponse);
}

enum IQDeleteOnFetch {
Expand All @@ -38,6 +42,26 @@ enum AmpmSignalType {
AMPM_SIGNAL_TYPE_TONES = 1;
}

enum DpdReferenceWaveformIdleDurationPresent {
DPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_FALSE = 0;
DPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_TRUE = 1;
}

enum DpdSignalType {
DPD_SIGNAL_TYPE_MODULATED = 0;
DPD_SIGNAL_TYPE_TONES = 1;
}

enum IdpdReferenceWaveformIdleDurationPresent {
IDPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_FALSE = 0;
IDPD_REFERENCE_WAVEFORM_IDLE_DURATION_PRESENT_TRUE = 1;
}

enum IdpdSignalType {
IDPD_SIGNAL_TYPE_MODULATED = 0;
IDPD_SIGNAL_TYPE_TONES = 1;
}

message AMPMLoadReferenceWaveformFromTDMSFileRequest {
nidevice_grpc.Session instrument = 1;
string selector_string = 2;
Expand Down Expand Up @@ -88,3 +112,83 @@ message IQFetchDataOverrideBehaviorResponse {
int32 actual_array_size = 5;
}

message DPDApplyDigitalPredistortionToWaveformFromTDMSFileRequest {
nidevice_grpc.Session instrument_handle = 1;
string selector_string = 2;
string waveform_file_path = 3;
oneof idle_duration_present_enum {
DpdReferenceWaveformIdleDurationPresent idle_duration_present = 4;
int32 idle_duration_present_raw = 5;
}
double measurement_timeout = 6;
int32 waveform_index = 7;
}

message DPDApplyDigitalPredistortionToWaveformFromTDMSFileResponse {
int32 status = 1;
double x0_out = 2;
double dx_out = 3;
repeated nidevice_grpc.NIComplexNumberF32 waveform_out = 4;
int32 actual_array_size = 5;
double papr = 6;
double power_offset = 7;
}

message DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileRequest {
nidevice_grpc.Session instrument_handle = 1;
string selector_string = 2;
string waveform_file_path = 3;
oneof idle_duration_present_enum {
DpdReferenceWaveformIdleDurationPresent idle_duration_present = 4;
int32 idle_duration_present_raw = 5;
}
int32 waveform_index = 6;
}

message DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileResponse {
int32 status = 1;
double x0_out = 2;
double dx_out = 3;
repeated nidevice_grpc.NIComplexNumberF32 waveform_out = 4;
int32 actual_array_size = 5;
double papr = 6;
}

message DPDLoadReferenceWaveformFromTDMSFileRequest {
nidevice_grpc.Session instrument_handle = 1;
string selector_string = 2;
string waveform_file_path = 3;
oneof idle_duration_present_enum {
DpdReferenceWaveformIdleDurationPresent idle_duration_present = 4;
int32 idle_duration_present_raw = 5;
}
oneof signal_type_enum {
DpdSignalType signal_type = 6;
int32 signal_type_raw = 7;
}
int32 waveform_index = 8;
}

message DPDLoadReferenceWaveformFromTDMSFileResponse {
int32 status = 1;
}

message IDPDLoadReferenceWaveformFromTDMSFileRequest {
nidevice_grpc.Session instrument_handle = 1;
string selector_string = 2;
string waveform_file_path = 3;
oneof idle_duration_present_enum {
IdpdReferenceWaveformIdleDurationPresent idle_duration_present = 4;
int32 idle_duration_present_raw = 5;
}
oneof signal_type_enum {
IdpdSignalType signal_type = 6;
int32 signal_type_raw = 7;
}
int32 waveform_index = 8;
}

message IDPDLoadReferenceWaveformFromTDMSFileResponse {
int32 status = 1;
}

129 changes: 129 additions & 0 deletions generated/nirfmxspecan_restricted/nirfmxspecan_restricted_client.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,5 +101,134 @@ iq_fetch_data_override_behavior(const StubPtr& stub, const nidevice_grpc::Sessio
return response;
}

DPDApplyDigitalPredistortionToWaveformFromTDMSFileResponse
dpd_apply_digital_predistortion_to_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<DpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const double& measurement_timeout, const pb::int32& waveform_index)
{
::grpc::ClientContext context;

auto request = DPDApplyDigitalPredistortionToWaveformFromTDMSFileRequest{};
request.mutable_instrument_handle()->CopyFrom(instrument_handle);
request.set_selector_string(selector_string);
request.set_waveform_file_path(waveform_file_path);
const auto idle_duration_present_ptr = idle_duration_present.get_if<DpdReferenceWaveformIdleDurationPresent>();
const auto idle_duration_present_raw_ptr = idle_duration_present.get_if<pb::int32>();
if (idle_duration_present_ptr) {
request.set_idle_duration_present(*idle_duration_present_ptr);
}
else if (idle_duration_present_raw_ptr) {
request.set_idle_duration_present_raw(*idle_duration_present_raw_ptr);
}
request.set_measurement_timeout(measurement_timeout);
request.set_waveform_index(waveform_index);

auto response = DPDApplyDigitalPredistortionToWaveformFromTDMSFileResponse{};

raise_if_error(
stub->DPDApplyDigitalPredistortionToWaveformFromTDMSFile(&context, request, &response),
context);

return response;
}

DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileResponse
dpd_apply_pre_dpd_signal_conditioning_to_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<DpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const pb::int32& waveform_index)
{
::grpc::ClientContext context;

auto request = DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileRequest{};
request.mutable_instrument_handle()->CopyFrom(instrument_handle);
request.set_selector_string(selector_string);
request.set_waveform_file_path(waveform_file_path);
const auto idle_duration_present_ptr = idle_duration_present.get_if<DpdReferenceWaveformIdleDurationPresent>();
const auto idle_duration_present_raw_ptr = idle_duration_present.get_if<pb::int32>();
if (idle_duration_present_ptr) {
request.set_idle_duration_present(*idle_duration_present_ptr);
}
else if (idle_duration_present_raw_ptr) {
request.set_idle_duration_present_raw(*idle_duration_present_raw_ptr);
}
request.set_waveform_index(waveform_index);

auto response = DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileResponse{};

raise_if_error(
stub->DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile(&context, request, &response),
context);

return response;
}

DPDLoadReferenceWaveformFromTDMSFileResponse
dpd_load_reference_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<DpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const simple_variant<DpdSignalType, pb::int32>& signal_type, const pb::int32& waveform_index)
{
::grpc::ClientContext context;

auto request = DPDLoadReferenceWaveformFromTDMSFileRequest{};
request.mutable_instrument_handle()->CopyFrom(instrument_handle);
request.set_selector_string(selector_string);
request.set_waveform_file_path(waveform_file_path);
const auto idle_duration_present_ptr = idle_duration_present.get_if<DpdReferenceWaveformIdleDurationPresent>();
const auto idle_duration_present_raw_ptr = idle_duration_present.get_if<pb::int32>();
if (idle_duration_present_ptr) {
request.set_idle_duration_present(*idle_duration_present_ptr);
}
else if (idle_duration_present_raw_ptr) {
request.set_idle_duration_present_raw(*idle_duration_present_raw_ptr);
}
const auto signal_type_ptr = signal_type.get_if<DpdSignalType>();
const auto signal_type_raw_ptr = signal_type.get_if<pb::int32>();
if (signal_type_ptr) {
request.set_signal_type(*signal_type_ptr);
}
else if (signal_type_raw_ptr) {
request.set_signal_type_raw(*signal_type_raw_ptr);
}
request.set_waveform_index(waveform_index);

auto response = DPDLoadReferenceWaveformFromTDMSFileResponse{};

raise_if_error(
stub->DPDLoadReferenceWaveformFromTDMSFile(&context, request, &response),
context);

return response;
}

IDPDLoadReferenceWaveformFromTDMSFileResponse
idpd_load_reference_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<IdpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const simple_variant<IdpdSignalType, pb::int32>& signal_type, const pb::int32& waveform_index)
{
::grpc::ClientContext context;

auto request = IDPDLoadReferenceWaveformFromTDMSFileRequest{};
request.mutable_instrument_handle()->CopyFrom(instrument_handle);
request.set_selector_string(selector_string);
request.set_waveform_file_path(waveform_file_path);
const auto idle_duration_present_ptr = idle_duration_present.get_if<IdpdReferenceWaveformIdleDurationPresent>();
const auto idle_duration_present_raw_ptr = idle_duration_present.get_if<pb::int32>();
if (idle_duration_present_ptr) {
request.set_idle_duration_present(*idle_duration_present_ptr);
}
else if (idle_duration_present_raw_ptr) {
request.set_idle_duration_present_raw(*idle_duration_present_raw_ptr);
}
const auto signal_type_ptr = signal_type.get_if<IdpdSignalType>();
const auto signal_type_raw_ptr = signal_type.get_if<pb::int32>();
if (signal_type_ptr) {
request.set_signal_type(*signal_type_ptr);
}
else if (signal_type_raw_ptr) {
request.set_signal_type_raw(*signal_type_raw_ptr);
}
request.set_waveform_index(waveform_index);

auto response = IDPDLoadReferenceWaveformFromTDMSFileResponse{};

raise_if_error(
stub->IDPDLoadReferenceWaveformFromTDMSFile(&context, request, &response),
context);

return response;
}


} // namespace nirfmxspecan_restricted_grpc::experimental::client
4 changes: 4 additions & 0 deletions generated/nirfmxspecan_restricted/nirfmxspecan_restricted_client.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ using namespace nidevice_grpc::experimental::client;
AMPMLoadReferenceWaveformFromTDMSFileResponse ampm_load_reference_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<AmpmReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const simple_variant<AmpmSignalType, pb::int32>& signal_type, const pb::int32& waveform_index);
CacheResultResponse cache_result(const StubPtr& stub, const nidevice_grpc::Session& instrument, const std::string& selector_string, const pb::int32& selector_string_out_size);
IQFetchDataOverrideBehaviorResponse iq_fetch_data_override_behavior(const StubPtr& stub, const nidevice_grpc::Session& instrument, const std::string& selector_string, const double& timeout, const pb::int32& record_to_fetch, const pb::int64& samples_to_read, const simple_variant<IQDeleteOnFetch, pb::int32>& delete_on_fetch);
DPDApplyDigitalPredistortionToWaveformFromTDMSFileResponse dpd_apply_digital_predistortion_to_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<DpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const double& measurement_timeout, const pb::int32& waveform_index);
DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFileResponse dpd_apply_pre_dpd_signal_conditioning_to_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<DpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const pb::int32& waveform_index);
DPDLoadReferenceWaveformFromTDMSFileResponse dpd_load_reference_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<DpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const simple_variant<DpdSignalType, pb::int32>& signal_type, const pb::int32& waveform_index);
IDPDLoadReferenceWaveformFromTDMSFileResponse idpd_load_reference_waveform_from_tdms_file(const StubPtr& stub, const nidevice_grpc::Session& instrument_handle, const std::string& selector_string, const std::string& waveform_file_path, const simple_variant<IdpdReferenceWaveformIdleDurationPresent, pb::int32>& idle_duration_present, const simple_variant<IdpdSignalType, pb::int32>& signal_type, const pb::int32& waveform_index);

} // namespace nirfmxspecan_restricted_grpc::experimental::client

Expand Down
36 changes: 36 additions & 0 deletions generated/nirfmxspecan_restricted/nirfmxspecan_restricted_library.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ NiRFmxSpecAnRestrictedLibrary::NiRFmxSpecAnRestrictedLibrary(std::shared_ptr<nid
function_pointers_.GetError = reinterpret_cast<GetErrorPtr>(shared_library_->get_function_pointer("RFmxSpecAn_GetError"));
function_pointers_.GetErrorString = reinterpret_cast<GetErrorStringPtr>(shared_library_->get_function_pointer("RFmxSpecAn_GetErrorString"));
function_pointers_.IQFetchDataOverrideBehavior = reinterpret_cast<IQFetchDataOverrideBehaviorPtr>(shared_library_->get_function_pointer("RFmxSpecAn_IQFetchDataOverrideBehavior"));
function_pointers_.DPDApplyDigitalPredistortionToWaveformFromTDMSFile = reinterpret_cast<DPDApplyDigitalPredistortionToWaveformFromTDMSFilePtr>(shared_library_->get_function_pointer("RFmxSpecAn_DPDApplyDigitalPredistortionToWaveformFromTDMSFile"));
function_pointers_.DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile = reinterpret_cast<DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFilePtr>(shared_library_->get_function_pointer("RFmxSpecAn_DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile"));
function_pointers_.DPDLoadReferenceWaveformFromTDMSFile = reinterpret_cast<DPDLoadReferenceWaveformFromTDMSFilePtr>(shared_library_->get_function_pointer("RFmxSpecAn_DPDLoadReferenceWaveformFromTDMSFile"));
function_pointers_.IDPDLoadReferenceWaveformFromTDMSFile = reinterpret_cast<IDPDLoadReferenceWaveformFromTDMSFilePtr>(shared_library_->get_function_pointer("RFmxSpecAn_IDPDLoadReferenceWaveformFromTDMSFile"));
}

NiRFmxSpecAnRestrictedLibrary::~NiRFmxSpecAnRestrictedLibrary()
Expand Down Expand Up @@ -85,4 +89,36 @@ int32 NiRFmxSpecAnRestrictedLibrary::IQFetchDataOverrideBehavior(niRFmxInstrHand
return function_pointers_.IQFetchDataOverrideBehavior(instrumentHandle, selectorString, timeout, recordToFetch, samplesToRead, deleteOnFetch, t0, dt, data, arraySize, actualArraySize);
}

int32 NiRFmxSpecAnRestrictedLibrary::DPDApplyDigitalPredistortionToWaveformFromTDMSFile(niRFmxInstrHandle instrumentHandle, char selectorString[], char waveformFilePath[], int32 idleDurationPresent, float64 measurementTimeout, int32 waveformIndex, float64* x0Out, float64* dxOut, NIComplexSingle waveformOut[], int32 arraySizeOut, int32* actualArraySize, float64* PAPR, float64* powerOffset)
{
if (!function_pointers_.DPDApplyDigitalPredistortionToWaveformFromTDMSFile) {
throw nidevice_grpc::LibraryLoadException("Could not find RFmxSpecAn_DPDApplyDigitalPredistortionToWaveformFromTDMSFile.");
}
return function_pointers_.DPDApplyDigitalPredistortionToWaveformFromTDMSFile(instrumentHandle, selectorString, waveformFilePath, idleDurationPresent, measurementTimeout, waveformIndex, x0Out, dxOut, waveformOut, arraySizeOut, actualArraySize, PAPR, powerOffset);
}

int32 NiRFmxSpecAnRestrictedLibrary::DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile(niRFmxInstrHandle instrumentHandle, char selectorString[], char waveformFilePath[], int32 idleDurationPresent, int32 waveformIndex, float64* x0Out, float64* dxOut, NIComplexSingle waveformOut[], int32 arraySizeOut, int32* actualArraySize, float64* PAPR)
{
if (!function_pointers_.DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile) {
throw nidevice_grpc::LibraryLoadException("Could not find RFmxSpecAn_DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile.");
}
return function_pointers_.DPDApplyPreDPDSignalConditioningToWaveformFromTDMSFile(instrumentHandle, selectorString, waveformFilePath, idleDurationPresent, waveformIndex, x0Out, dxOut, waveformOut, arraySizeOut, actualArraySize, PAPR);
}

int32 NiRFmxSpecAnRestrictedLibrary::DPDLoadReferenceWaveformFromTDMSFile(niRFmxInstrHandle instrumentHandle, char selectorString[], char waveformFilePath[], int32 idleDurationPresent, int32 signalType, int32 waveformIndex)
{
if (!function_pointers_.DPDLoadReferenceWaveformFromTDMSFile) {
throw nidevice_grpc::LibraryLoadException("Could not find RFmxSpecAn_DPDLoadReferenceWaveformFromTDMSFile.");
}
return function_pointers_.DPDLoadReferenceWaveformFromTDMSFile(instrumentHandle, selectorString, waveformFilePath, idleDurationPresent, signalType, waveformIndex);
}

int32 NiRFmxSpecAnRestrictedLibrary::IDPDLoadReferenceWaveformFromTDMSFile(niRFmxInstrHandle instrumentHandle, char selectorString[], char waveformFilePath[], int32 idleDurationPresent, int32 signalType, int32 waveformIndex)
{
if (!function_pointers_.IDPDLoadReferenceWaveformFromTDMSFile) {
throw nidevice_grpc::LibraryLoadException("Could not find RFmxSpecAn_IDPDLoadReferenceWaveformFromTDMSFile.");
}
return function_pointers_.IDPDLoadReferenceWaveformFromTDMSFile(instrumentHandle, selectorString, waveformFilePath, idleDurationPresent, signalType, waveformIndex);
}

} // namespace nirfmxspecan_restricted_grpc
Loading
Loading