CTRE Phoenix 6 C++ 25.4.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ctre::phoenix6::configs::DigitalInputsConfigs Class Reference

Configs related to the CANdi™ branded device's digital I/O settings. More...

#include <ctre/phoenix6/configs/Configs.hpp>

Inheritance diagram for ctre::phoenix6::configs::DigitalInputsConfigs:
ctre::phoenix6::configs::ParentConfiguration ctre::phoenix6::ISerializable

Public Member Functions

constexpr DigitalInputsConfigs ()=default
 
constexpr DigitalInputsConfigs & WithS1FloatState (signals::S1FloatStateValue newS1FloatState)
 Modifies this configuration's S1FloatState parameter and returns itself for method-chaining and easier to use config API.
 
constexpr DigitalInputsConfigs & WithS2FloatState (signals::S2FloatStateValue newS2FloatState)
 Modifies this configuration's S2FloatState parameter and returns itself for method-chaining and easier to use config API.
 
constexpr DigitalInputsConfigs & WithS1CloseState (signals::S1CloseStateValue newS1CloseState)
 Modifies this configuration's S1CloseState parameter and returns itself for method-chaining and easier to use config API.
 
constexpr DigitalInputsConfigs & WithS2CloseState (signals::S2CloseStateValue newS2CloseState)
 Modifies this configuration's S2CloseState parameter and returns itself for method-chaining and easier to use config API.
 
std::string ToString () const override
 
std::string Serialize () const override
 
ctre::phoenix::StatusCode Deserialize (const std::string &to_deserialize) override
 
- Public Member Functions inherited from ctre::phoenix6::configs::ParentConfiguration
- Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes

signals::S1FloatStateValue S1FloatState = signals::S1FloatStateValue::FloatDetect
 The floating state of the Signal 1 input (S1IN).
 
signals::S2FloatStateValue S2FloatState = signals::S2FloatStateValue::FloatDetect
 The floating state of the Signal 2 input (S2IN).
 
signals::S1CloseStateValue S1CloseState = signals::S1CloseStateValue::CloseWhenNotFloating
 What value the Signal 1 input (S1IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.
 
signals::S2CloseStateValue S2CloseState = signals::S2CloseStateValue::CloseWhenNotFloating
 What value the Signal 2 input (S2IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.
 

Detailed Description

Configs related to the CANdi™ branded device's digital I/O settings.

Contains float-state settings and when to assert the S1/S2 inputs.

Constructor & Destructor Documentation

◆ DigitalInputsConfigs()

ctre::phoenix6::configs::DigitalInputsConfigs::DigitalInputsConfigs ( )
constexprdefault

Member Function Documentation

◆ Deserialize()

ctre::phoenix::StatusCode ctre::phoenix6::configs::DigitalInputsConfigs::Deserialize ( const std::string & to_deserialize)
inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

◆ Serialize()

std::string ctre::phoenix6::configs::DigitalInputsConfigs::Serialize ( ) const
inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

◆ ToString()

std::string ctre::phoenix6::configs::DigitalInputsConfigs::ToString ( ) const
inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

◆ WithS1CloseState()

DigitalInputsConfigs & ctre::phoenix6::configs::DigitalInputsConfigs::WithS1CloseState ( signals::S1CloseStateValue newS1CloseState)
inlineconstexpr

Modifies this configuration's S1CloseState parameter and returns itself for method-chaining and easier to use config API.

What value the Signal 1 input (S1IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S1 input as a remote limit switch will treat the switch as closed when the S1 input is this state.

Parameters
newS1CloseStateParameter to modify
Returns
Itself

◆ WithS1FloatState()

DigitalInputsConfigs & ctre::phoenix6::configs::DigitalInputsConfigs::WithS1FloatState ( signals::S1FloatStateValue newS1FloatState)
inlineconstexpr

Modifies this configuration's S1FloatState parameter and returns itself for method-chaining and easier to use config API.

The floating state of the Signal 1 input (S1IN).

Parameters
newS1FloatStateParameter to modify
Returns
Itself

◆ WithS2CloseState()

DigitalInputsConfigs & ctre::phoenix6::configs::DigitalInputsConfigs::WithS2CloseState ( signals::S2CloseStateValue newS2CloseState)
inlineconstexpr

Modifies this configuration's S2CloseState parameter and returns itself for method-chaining and easier to use config API.

What value the Signal 2 input (S2IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.

Parameters
newS2CloseStateParameter to modify
Returns
Itself

◆ WithS2FloatState()

DigitalInputsConfigs & ctre::phoenix6::configs::DigitalInputsConfigs::WithS2FloatState ( signals::S2FloatStateValue newS2FloatState)
inlineconstexpr

Modifies this configuration's S2FloatState parameter and returns itself for method-chaining and easier to use config API.

The floating state of the Signal 2 input (S2IN).

Parameters
newS2FloatStateParameter to modify
Returns
Itself

Member Data Documentation

◆ S1CloseState

signals::S1CloseStateValue ctre::phoenix6::configs::DigitalInputsConfigs::S1CloseState = signals::S1CloseStateValue::CloseWhenNotFloating

What value the Signal 1 input (S1IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S1 input as a remote limit switch will treat the switch as closed when the S1 input is this state.

◆ S1FloatState

signals::S1FloatStateValue ctre::phoenix6::configs::DigitalInputsConfigs::S1FloatState = signals::S1FloatStateValue::FloatDetect

The floating state of the Signal 1 input (S1IN).

◆ S2CloseState

signals::S2CloseStateValue ctre::phoenix6::configs::DigitalInputsConfigs::S2CloseState = signals::S2CloseStateValue::CloseWhenNotFloating

What value the Signal 2 input (S2IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.

◆ S2FloatState

signals::S2FloatStateValue ctre::phoenix6::configs::DigitalInputsConfigs::S2FloatState = signals::S2FloatStateValue::FloatDetect

The floating state of the Signal 2 input (S2IN).

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