Package org.ivoa.dm.proposal.prop

Class SpectralWindowSetup

java.lang.Object
org.ivoa.dm.proposal.prop.SpectralWindowSetup
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations
@Embeddable @VoDml(id="proposal:SpectralWindowSetup", role=dataType) public class SpectralWindowSetup extends Object implements org.ivoa.vodml.jpa.JPAManipulations
Science oriented definition of a spectral window. dataType: SpectralWindowSetup

  • Field Details

    • start

      @VoDml(id="proposal:SpectralWindowSetup.start", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity start
      The start of the spectral window. : Attribute start : multiplicity 1

    • end

      @VoDml(id="proposal:SpectralWindowSetup.end", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity end
      The end of the spectral window. : Attribute end : multiplicity 1

    • spectralResolution

      @VoDml(id="proposal:SpectralWindowSetup.spectralResolution", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity spectralResolution
      channel width. : Attribute spectralResolution : multiplicity 0..1

    • isSkyFrequency

      @VoDml(id="proposal:SpectralWindowSetup.isSkyFrequency", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean isSkyFrequency
      represents an observed frequency. : Attribute isSkyFrequency : multiplicity 1

    • polarization

      @VoDml(id="proposal:SpectralWindowSetup.polarization", role=attribute, type="coords:PolStateEnum", typeRole=enumeration) protected org.ivoa.dm.stc.coords.PolStateEnum polarization
      desired polarization. : Attribute polarization : multiplicity 1

  • Constructor Details

    • SpectralWindowSetup

      public SpectralWindowSetup()
      Creates a new SpectralWindowSetup

    • SpectralWindowSetup

      public SpectralWindowSetup(org.ivoa.dm.ivoa.RealQuantity start, org.ivoa.dm.ivoa.RealQuantity end, org.ivoa.dm.ivoa.RealQuantity spectralResolution, Boolean isSkyFrequency, org.ivoa.dm.stc.coords.PolStateEnum polarization)
      full parameter constructor.
      Parameters:
      start - The start of the spectral window.
      end - The end of the spectral window.
      spectralResolution - channel width.
      isSkyFrequency - represents an observed frequency.
      polarization - desired polarization.

    • SpectralWindowSetup

      public SpectralWindowSetup(SpectralWindowSetup other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • updateUsing

      public void updateUsing(SpectralWindowSetup other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getStart

      public org.ivoa.dm.ivoa.RealQuantity getStart()
      Returns start Attribute.
      Returns:
      start Attribute

    • setStart

      public void setStart(org.ivoa.dm.ivoa.RealQuantity pStart)
      Set start Attribute.
      Parameters:
      pStart - value to set

    • withStart

      public SpectralWindowSetup withStart(org.ivoa.dm.ivoa.RealQuantity pStart)
      fluent setter for start Attribute.
      Parameters:
      pStart - value to set
      Returns:
      SpectralWindowSetup

    • getEnd

      public org.ivoa.dm.ivoa.RealQuantity getEnd()
      Returns end Attribute.
      Returns:
      end Attribute

    • setEnd

      public void setEnd(org.ivoa.dm.ivoa.RealQuantity pEnd)
      Set end Attribute.
      Parameters:
      pEnd - value to set

    • withEnd

      public SpectralWindowSetup withEnd(org.ivoa.dm.ivoa.RealQuantity pEnd)
      fluent setter for end Attribute.
      Parameters:
      pEnd - value to set
      Returns:
      SpectralWindowSetup

    • getSpectralResolution

      public org.ivoa.dm.ivoa.RealQuantity getSpectralResolution()
      Returns spectralResolution Attribute.
      Returns:
      spectralResolution Attribute

    • setSpectralResolution

      public void setSpectralResolution(org.ivoa.dm.ivoa.RealQuantity pSpectralResolution)
      Set spectralResolution Attribute.
      Parameters:
      pSpectralResolution - value to set

    • withSpectralResolution

      public SpectralWindowSetup withSpectralResolution(org.ivoa.dm.ivoa.RealQuantity pSpectralResolution)
      fluent setter for spectralResolution Attribute.
      Parameters:
      pSpectralResolution - value to set
      Returns:
      SpectralWindowSetup

    • getIsSkyFrequency

      public Boolean getIsSkyFrequency()
      Returns isSkyFrequency Attribute.
      Returns:
      isSkyFrequency Attribute

    • setIsSkyFrequency

      public void setIsSkyFrequency(Boolean pIsSkyFrequency)
      Set isSkyFrequency Attribute.
      Parameters:
      pIsSkyFrequency - value to set

    • withIsSkyFrequency

      public SpectralWindowSetup withIsSkyFrequency(Boolean pIsSkyFrequency)
      fluent setter for isSkyFrequency Attribute.
      Parameters:
      pIsSkyFrequency - value to set
      Returns:
      SpectralWindowSetup

    • getPolarization

      public org.ivoa.dm.stc.coords.PolStateEnum getPolarization()
      Returns polarization Attribute.
      Returns:
      polarization Attribute

    • setPolarization

      public void setPolarization(org.ivoa.dm.stc.coords.PolStateEnum pPolarization)
      Set polarization Attribute.
      Parameters:
      pPolarization - value to set

    • withPolarization

      public SpectralWindowSetup withPolarization(org.ivoa.dm.stc.coords.PolStateEnum pPolarization)
      fluent setter for polarization Attribute.
      Parameters:
      pPolarization - value to set
      Returns:
      SpectralWindowSetup

    • createSpectralWindowSetup

      public static SpectralWindowSetup createSpectralWindowSetup(Consumer<SpectralWindowSetup.SpectralWindowSetupBuilder> f)
      create a SpectralWindowSetup in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations