openvehicle-api/examples/system_demo_example/example_service/countersteering.idl

 /********************************************************************************
 * Copyright (c) 2025-2026 ZF Friedrichshafen AG
 *
 * This program and the accompanying materials are made available under the 
 * terms of the Apache License Version 2.0 which is available at
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * SPDX-License-Identifier: Apache-2.0 
 ********************************************************************************/

/**
 * @brief Counter steering example service interface. The interface provides functions for the
 * @details Counter steering example service interface definition.
 * counter steering example complex service.
 */
interface ICounterSteeringService
{
    /**
     * @brief Activate or deactivate the counter steering service.
     * @param[in] bActivate When set, the service will be activated; otherwise deactivated.
     */
    void ActivateService(in boolean bActivate);

    /**
     * @brief Is the counter steering service currently activated?
     * @return Returns whether the counter steering service is currently activated.
     */
    boolean IsActivated() const;

    /**
     * @brief Does counter steering currently take place (speed > 30 km/s)?
     * @return Returns whether counter steering currently takes place.
     */
    boolean CounterSteeringActive() const;

    /**
     * @brief The calculated rear steering axle position.
     * @return Returns the rear steering axle position in degrees (or 0 when not active).
     */
    double RearAxleAngle() const;
};