Skip to content
This repository was archived by the owner on Mar 16, 2022. It is now read-only.
This repository was archived by the owner on Mar 16, 2022. It is now read-only.

Proposal to add pretty print to ToString overrides #54

@sean-moore3

Description

@sean-moore3

I'd like to propose we add pretty print to result structs ToString() methods. This makes printing results to console very easy for the user if they are using pure .net.

public struct ModAccComponentCarrierResults
{
    public int PeakCompositeEvmSubcarrierIndex;
    public int PeakCompositeEvmSymbolIndex;
    public double MeanRmsCompositeEvm;
    public double MaxPeakCompositeEvm;
    public double MeanFrequencyError_Hz;
    public int PeakCompositeEvmSlotIndex;

    public override string ToString()
    {
        return string.Format("---ModAcc  Component Carrier Results\n" +
            "Peak Composite EVM Subcarrier Index: {1}\n" +
            "Peak Composite EVM Symbol Index: {2}\n" +
            "Mean RMS Composite EVM: {3:0.###}\n" +
            "Max Peak Composite EVM: {4:0.###}\n" +
            "Mean Frequency Error (Hz): {5:0.###}\n" +
            "Peak Composite EVM Slot Index: {6}",
            PeakCompositeEvmSubcarrierIndex,
            PeakCompositeEvmSymbolIndex,
            MeanRmsCompositeEvm,
            MaxPeakCompositeEvm,
            MeanFrequencyError_Hz,
            PeakCompositeEvmSlotIndex);
    }
}

The above example uses ModAcc, but the console looks something like this:

image

And all that is required is this:

Console.WriteLine(acpResults);

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestquestionFurther information is requested

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions