/////////////////////////////////////////////////////////////////////
//                                                                 //
// file: autoGen_MuxClass_CCA.h                                    //
//                                                                 //
/////////////////////////////////////////////////////////////////////
//                                                                 //
// Copyright (c) 2026 Acroname Inc. - All Rights Reserved          //
//                                                                 //
// This file is part of the BrainStem release. See the license.txt //
// file included with this package or go to                        //
// https://acroname.com/software/brainstem-development-kit         //
// for full license details.                                       //
/////////////////////////////////////////////////////////////////////

#ifndef __AUTOGEN_MUX_CCA_H__
#define __AUTOGEN_MUX_CCA_H__

// This file was auto-generated. Do not modify.

#include "CCA_Core.h"

#ifdef __GNUC__
#define DEPRECATED(...) __attribute__((deprecated(__VA_ARGS__)))
#elif defined(_MSC_VER)
#define DEPRECATED(...) __declspec(deprecated(__VA_ARGS__))
#else
#define DEPRECATED(...)
#pragma message("DEPRECATED is not defined for this compiler")
#endif

/// \defgroup MuxEntity Mux Entity
/// A MUX is a multiplexer that takes one or more similar inputs (bus, connection, or signal)
///   and allows switching to one or more outputs.
/// An analogy would be the switchboard of a telephone operator.
/// Calls (inputs) come in and by re-connecting the input to an output, the operator
///   (multiplexer) can direct that input to on or more outputs.
/// One possible output is to not connect the input to anything which essentially disables
///   that input's connection to anything.
/// Not every MUX has multiple inputs; some may simply be a single input that can be enabled
///   (connected to a single output) or disabled (not connected to anything).
///

#ifdef __cplusplus
extern "C" {
#endif

/// Get the mux enable/disable status
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: true: mux is enabled, false: the mux is disabled.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// 
aLIBEXPORT void __stdcall mux_getEnable(unsigned int* id, struct Result* result, const int index);

/// Enable the mux.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code.
/// \param index The index of the entity in question.
/// \param enable true: enables the mux for the selected channel.
/// 
aLIBEXPORT void __stdcall mux_setEnable(unsigned int* id, struct Result* result, const int index, const unsigned char enable);

/// Get the current selected mux channel.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: Indicates which chanel is selected.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// 
aLIBEXPORT void __stdcall mux_getChannel(unsigned int* id, struct Result* result, const int index);

/// Set the current mux channel.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code.
/// \param index The index of the entity in question.
/// \param channel mux channel to select.
/// 
aLIBEXPORT void __stdcall mux_setChannel(unsigned int* id, struct Result* result, const int index, const unsigned char channel);

/// Get the voltage of the indicated mux channel.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: 32 bit signed integer (in microvolts) based on the board's ground and
///              reference voltages.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// \param channel The channel in which voltage was requested.
/// 
/// \note Not all modules provide 32 bits of accuracy; Refer to the module's datasheet to
///       determine the analog bit depth and reference voltage.
/// 
aLIBEXPORT void __stdcall mux_getChannelVoltage(unsigned int* id, struct Result* result, const int index, const unsigned char channel);

/// Get the configuration of the mux.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: integer representing the mux configuration either default, or split-mode.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// 
aLIBEXPORT void __stdcall mux_getConfiguration(unsigned int* id, struct Result* result, const int index);

/// Set the configuration of the mux.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code.
/// \param index The index of the entity in question.
/// \param config integer representing the mux configuration either muxConfig_default, or
///        muxConfig_splitMode.
/// 
aLIBEXPORT void __stdcall mux_setConfiguration(unsigned int* id, struct Result* result, const int index, const int config);

/// Get the current split mode mux configuration.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: integer representing the channel selection for each sub-channel within the
///              mux.
///              See the data-sheet for the device for specific information.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// 
aLIBEXPORT void __stdcall mux_getSplitMode(unsigned int* id, struct Result* result, const int index);

/// Sets the mux's split mode configuration.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code.
/// \param index The index of the entity in question.
/// \param splitMode integer representing the channel selection for each sub-channel within
///        the mux.
///        See the data-sheet for the device for specific information.
/// 
aLIBEXPORT void __stdcall mux_setSplitMode(unsigned int* id, struct Result* result, const int index, const int splitMode);

/// Get the configured direction of data flow. This is only used for certain data protocols.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: Enumeration code for muxDataDirection definition.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// 
aLIBEXPORT void __stdcall mux_getDataDirection(unsigned int* id, struct Result* result, const int index);

/// Set the configured direction of data flow. This is only used for certain data protocols.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code.
/// \param index The index of the entity in question.
/// \param direction Enumeration code for muxDataDirection definition.
/// 
aLIBEXPORT void __stdcall mux_setDataDirection(unsigned int* id, struct Result* result, const int index, const unsigned char direction);

/// A bit mapped representation of the current state of the mux.
/// Reflects what the mux is actually doing, which may differ from what was requested.
/// 
/// The result parameter will output the following fields:
///     \li error: \ref EntityReturnValues common entity return value
///     \li value: Variable to be filled with the current state.
/// 
/// \param id ID assigned through "module_createStem"
/// \param result Output object containing result code and the requested value if successful.
/// \param index The index of the entity in question.
/// 
aLIBEXPORT void __stdcall mux_getState(unsigned int* id, struct Result* result, const int index);


#ifdef __cplusplus
}
#endif

#endif // __AUTOGEN_MUX_CCA_H__