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

Proposal to add pretty print to ToString overrides #54

Open
sean-moore3 opened this issue Sep 9, 2019 · 0 comments
Open

Proposal to add pretty print to ToString overrides #54

sean-moore3 opened this issue Sep 9, 2019 · 0 comments
Labels
enhancement New feature or request question Further information is requested
Milestone

Comments

@sean-moore3
Copy link
Contributor

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);
@sean-moore3 sean-moore3 added enhancement New feature or request question Further information is requested labels Sep 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants
@sean-moore3 and others