Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

require filter in ResponseStage #20

Open
crotwell opened this issue Jul 11, 2019 · 2 comments
Open

require filter in ResponseStage #20

crotwell opened this issue Jul 11, 2019 · 2 comments

Comments

@crotwell
Copy link
Collaborator

Currently the filters (PolesZeros, etc) have minOccurs=0 on each within ResponseStageType. This allows a Stage like:

          <fsx:Stage number="2">
            <fsx:StageGain>
              <fsx:Value>1.000000000000E+00</fsx:Value>
              <fsx:Frequency>1.000000000000E+00</fsx:Frequency>
            </fsx:StageGain>
          </fsx:Stage>

to be valid. However, the comments imply that this should not be allowed:

There should be one response per stage.

In addition, this also means that the Stage does not have input and output units, which are important in understanding the overall response.

I believe the minOccurs attributes are leftover from an earlier version and should be removed, disallowing a Stage with only a StageGain.

For cases where the stage really is only a gain, there should still be a placeholder, like a unity Coefficients filter to provide units and so it is clear what is meant.

@crotwell
Copy link
Collaborator Author

Obviously this would be a breaking change, so would need to be for version 2.0

@crotwell
Copy link
Collaborator Author

Obviously this would be a breaking change, so would need to be for version 2.0.

A non-breaking change that would at least make it clearer what is going on would be to move the minOccurs to the choice like

<xs:choice minOccurs="0">

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants