sbg::ConfigApplier Class Reference

#include <config_applier.h>

Public Member Functions
void	applyConfiguration (const ConfigStore &ref_config_store)
	ConfigApplier (SbgEComHandle &ref_sbg_com_handle)
void	saveConfiguration (void)

Private Member Functions
void	checkConfigurationApplied (const SbgErrorCode &ref_sbg_error_code, const std::string &ref_conf_title)
void	checkConfigurationGet (const SbgErrorCode &ref_sbg_error_code, const std::string &ref_conf_title) const
void	configureAidingAssignement (const SbgEComAidingAssignConf &ref_aiding_assign)
void	configureGnssInstallation (const SbgEComGnssInstallation &ref_gnss_installation)
void	configureGnssModel (const SbgEComModelInfo &ref_gnss_model)
void	configureGnssRejection (const SbgEComGnssRejectionConf &ref_gnss_rejection)
void	configureImuAlignement (const SbgEComSensorAlignmentInfo &ref_sensor_align, const SbgVector3< float > &ref_level_arms)
void	configureInitCondition (const SbgEComInitConditionConf &ref_init_condition)
void	configureMagModel (const SbgEComModelInfo &ref_mag_model)
void	configureMagRejection (const SbgEComMagRejectionConf &ref_mag_rejection)
void	configureMotionProfile (const SbgEComModelInfo &ref_motion_profile)
void	configureOdometer (const SbgEComOdoConf &ref_odometer)
void	configureOdometerLevelArm (const SbgVector3< float > &odometer_level_arms)
void	configureOdometerRejection (const SbgEComOdoRejectionConf &ref_odometer_rejection)
void	configureOutput (SbgEComOutputPort output_port, const ConfigStore::SbgLogOutput &ref_log_output)

Private Attributes
bool	m_reboot_needed_
SbgEComHandle &	m_ref_sbg_com_handle

Detailed Description

Class to apply configuration to a device.

Definition at line 51 of file config_applier.h.

Constructor & Destructor Documentation

ConfigApplier()

ConfigApplier::ConfigApplier

(

SbgEComHandle &

ref_sbg_com_handle

)

Default constructor.

Parameters

[in]

ref_com_handle

SBG communication handle.

Class to apply configuration to a device.

Definition at line 13 of file config_applier.cpp.

Member Function Documentation

applyConfiguration()

void ConfigApplier::applyConfiguration

(

const ConfigStore &

ref_config_store

)

Apply a configuration to the SBG device.

Parameters

[in]

ref_config_store

Configuration to apply.

Definition at line 405 of file config_applier.cpp.

checkConfigurationApplied()

void ConfigApplier::checkConfigurationApplied ( const SbgErrorCode &  ref_sbg_error_code, const std::string &  ref_conf_title  )

private

Check if the configuration has been applied correctly. This function will log if the configuration has been applied. It will log a warning if the parameter is not available for this device. It will be the user responsability to check.

Parameters

[in]	ref_sbg_error_code	Error code from the configuration getter.
[in]	ref_conf_title	String to identify the configuration.

Exceptions

Unable

to configure.

Definition at line 41 of file config_applier.cpp.

checkConfigurationGet()

void ConfigApplier::checkConfigurationGet ( const SbgErrorCode &  ref_sbg_error_code, const std::string &  ref_conf_title  ) const

private

Check if the configuration getter worked properly. This function will log a warning information if the parameter is not available for this device.

Parameters

[in]	ref_sbg_error_code	Error code from the configuration getter.
[in]	ref_conf_title	String to identify the configuration.

Exceptions

Unable

to get the configuration.

Definition at line 24 of file config_applier.cpp.

configureAidingAssignement()

void ConfigApplier::configureAidingAssignement ( const SbgEComAidingAssignConf &  ref_aiding_assign )

private

Configure the aiding assignement.

Parameters

[in]

ref_aiding_assign

Aiding assignement configuration to apply.

Definition at line 139 of file config_applier.cpp.

configureGnssInstallation()

void ConfigApplier::configureGnssInstallation ( const SbgEComGnssInstallation &  ref_gnss_installation )

private

Configure the Gnss installation.

Parameters

[in]

ref_gnss_installation

Gnss installation configuration to apply.

Definition at line 226 of file config_applier.cpp.

configureGnssModel()

void ConfigApplier::configureGnssModel ( const SbgEComModelInfo &  ref_gnss_model )

private

Configure the Gnss model.

Parameters

[in]

ref_gnss_model

Gnss model configuration to apply.

Definition at line 205 of file config_applier.cpp.

configureGnssRejection()

void ConfigApplier::configureGnssRejection ( const SbgEComGnssRejectionConf &  ref_gnss_rejection )

private

Configure the Gnss rejection.

Parameters

[in]

ref_gnss_rejection

Gnss rejection configuration to apply.

Definition at line 259 of file config_applier.cpp.

configureImuAlignement()

void ConfigApplier::configureImuAlignement ( const SbgEComSensorAlignmentInfo &  ref_sensor_align, const SbgVector3< float > &  ref_level_arms  )

private

Configure the IMU alignement.

Parameters

[in]	ref_sensor_align	Sensor IMU alignement configuration to apply.
[in]	ref_level_arms	X, Y, Z level arms to apply.

Definition at line 110 of file config_applier.cpp.

configureInitCondition()

void ConfigApplier::configureInitCondition ( const SbgEComInitConditionConf &  ref_init_condition )

private

Configure the initial condition parameters.

Parameters

[in]

ref_init_condition

Initial condition conf to apply.

Definition at line 63 of file config_applier.cpp.

configureMagModel()

void ConfigApplier::configureMagModel ( const SbgEComModelInfo &  ref_mag_model )

private

Configure the magnetometers model.

Parameters

[in]

ref_mag_model

Magnetometers model configuration to apply.

Definition at line 163 of file config_applier.cpp.

configureMagRejection()

void ConfigApplier::configureMagRejection ( const SbgEComMagRejectionConf &  ref_mag_rejection )

private

Configure the magnetometers rejection.

Parameters

[in]

ref_mag_rejection

Magnetometers rejection configuration to apply.

Definition at line 184 of file config_applier.cpp.

configureMotionProfile()

void ConfigApplier::configureMotionProfile ( const SbgEComModelInfo &  ref_motion_profile )

private

Configure the motion profile.

Parameters

[in]

ref_motion_profile

Motion profile configuration to apply.

Definition at line 89 of file config_applier.cpp.

configureOdometer()

void ConfigApplier::configureOdometer ( const SbgEComOdoConf &  ref_odometer )

private

Configure the odometer.

Parameters

[in]

ref_odometer

Odometer configuration to apply.

Definition at line 282 of file config_applier.cpp.

configureOdometerLevelArm()

void ConfigApplier::configureOdometerLevelArm ( const SbgVector3< float > &  odometer_level_arms )

private

Configure the odometer level arm.

Parameters

[in]

odometer_level_arms

X,Y,Z odometer level arms to apply.

Definition at line 305 of file config_applier.cpp.

configureOdometerRejection()

void ConfigApplier::configureOdometerRejection ( const SbgEComOdoRejectionConf &  ref_odometer_rejection )

private

Configure the odometer rejection.

Parameters

[in]

ref_odometer_rejection

Odometer rejection configuration to apply.

Definition at line 328 of file config_applier.cpp.

configureOutput()

void ConfigApplier::configureOutput ( SbgEComOutputPort  output_port, const ConfigStore::SbgLogOutput &  ref_log_output  )

private

Configure the output for the SBG log. If a Log is not available for the connected device, a warning will be logged. It will be user responsability to check.

Parameters

[in]	output_port	Output communication port.
[in]	ref_log_output	Log output to configure.

Exceptions

Unable

to configure the output.

Definition at line 349 of file config_applier.cpp.

saveConfiguration()

void ConfigApplier::saveConfiguration

(

void

)

Save the configuration to the device.

Definition at line 442 of file config_applier.cpp.

Member Data Documentation

m_reboot_needed_

bool sbg::ConfigApplier::m_reboot_needed_

private

Definition at line 55 of file config_applier.h.

m_ref_sbg_com_handle

SbgEComHandle& sbg::ConfigApplier::m_ref_sbg_com_handle

private

Definition at line 56 of file config_applier.h.

---

The documentation for this class was generated from the following files:

• config_applier.h
• config_applier.cpp