Class CustomParamsConfigs

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Custom Params.

Custom paramaters that have no real impact on controller.

public class CustomParamsConfigs : IParentConfiguration, ISerializable, ICloneable

Inheritance

object

CustomParamsConfigs

Implements

IParentConfiguration

ISerializable

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

CustomParam0

Custom parameter 0. This is provided to allow end-applications to store persistent information in the device.

• Minimum Value-32768
• Maximum Value32767
• Default Value0
• Units

public int CustomParam0

Field Value

int

CustomParam1

Custom parameter 1. This is provided to allow end-applications to store persistent information in the device.

• Minimum Value-32768
• Maximum Value32767
• Default Value0
• Units

public int CustomParam1

Field Value

int

Methods

Clone()

Creates a copy of this config group.

public CustomParamsConfigs Clone()

Returns

CustomParamsConfigs

Deserialize(string)

Deserialize string and put values into this object

public StatusCode Deserialize(string to_deserialize)

Parameters

to_deserialize string

String to deserialize

Returns

StatusCode

OK if deserialization is OK

Serialize()

Serialize this object into a string

public string Serialize()

Returns

string

This object's data serialized into a string

ToString()

Provides the string representation of this object

public override string ToString()

Returns

string

WithCustomParam0(int)

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

Custom parameter 0. This is provided to allow end-applications to store persistent information in the device.

• Minimum Value-32768
• Maximum Value32767
• Default Value0
• Units

public CustomParamsConfigs WithCustomParam0(int newCustomParam0)

Parameters

newCustomParam0 int

Parameter to modify

Returns

CustomParamsConfigs

Itself

WithCustomParam1(int)

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

Custom parameter 1. This is provided to allow end-applications to store persistent information in the device.

• Minimum Value-32768
• Maximum Value32767
• Default Value0
• Units

public CustomParamsConfigs WithCustomParam1(int newCustomParam1)

Parameters

newCustomParam1 int

Parameter to modify

Returns

CustomParamsConfigs

Itself