CadSunStudy

Inheritance: java.lang.Object, CadBaseObject

Class describing SUNSTUDY object.

Constructors

ConstructorDescription
CadSunStudy()Initializes a new instance of the CadSunStudy class.

Methods

MethodDescription
getSunStudyDates()Gets or sets the sun study dates.
setSunStudyDates(List value)Gets or sets the sun study dates.
getSunSetupName()Gets or sets the name of the sun setup.
setSunSetupName(String value)Gets or sets the name of the sun setup.
getDescription()Gets or sets the description.
setDescription(String value)Gets or sets the description.
getOutputType()Gets or sets the type of the output.
setOutputType(short value)Gets or sets the type of the output.
getSheetSetName()Gets or sets the name of the sheet set.
setSheetSetName(String value)Gets or sets the name of the sheet set.
getUseSubsetFlag()Gets or sets the use subset flag.
setUseSubsetFlag(boolean value)Gets or sets the use subset flag.
getSheetSubsetName()Gets or sets the name of the sheet subset.
setSheetSubsetName(String value)Gets or sets the name of the sheet subset.
getSelectDates()Gets or sets the select dates.
setSelectDates(boolean value)Gets or sets the select dates.
getDateInputArraySize()Gets or sets the size of the date input array.
setDateInputArraySize(int value)Gets or sets the size of the date input array.
getDatesFlagSelectRange()Gets or sets the dates flag select range.
setDatesFlagSelectRange(boolean value)Gets or sets the dates flag select range.
getStartTime()Gets or sets the start time.
setStartTime(int value)Gets or sets the start time.
getEndTime()Gets or sets the end time.
setEndTime(int value)Gets or sets the end time.
getIntervalInSeconds()Gets or sets the interval in seconds.
setIntervalInSeconds(int value)Gets or sets the interval in seconds.
getHoursNumber()Gets or sets the hours number.
setHoursNumber(short value)Gets or sets the hours number.
getHoursList()Gets or sets the hours list.
setHoursList(List value)Gets or sets the hours list.
getPageSetupWizardHardPointerId()Gets or sets the page setup wizard hard pointer identifier.
setPageSetupWizardHardPointerId(String value)Gets or sets the page setup wizard hard pointer identifier.
getViewHardPointerId()Gets or sets the view hard pointer identifier.
setViewHardPointerId(String value)Gets or sets the view hard pointer identifier.
getVisualStyleId()Gets or sets the visual style identifier.
setVisualStyleId(String value)Gets or sets the visual style identifier.
getShadePlotType()Gets or sets the type of the shade plot.
setShadePlotType(short value)Gets or sets the type of the shade plot.
getViewportsPerPage()Gets or sets the viewports per page.
setViewportsPerPage(short value)Gets or sets the viewports per page.
getViewportDistributionRowsNumber()Gets or sets the viewport distribution rows number.
setViewportDistributionRowsNumber(short value)Gets or sets the viewport distribution rows number.
getViewportDistributionColumnsNumber()Gets or sets the viewport distribution columns number.
setViewportDistributionColumnsNumber(short value)Gets or sets the viewport distribution columns number.
getSpacing()Gets or sets the spacing.
setSpacing(double value)Gets or sets the spacing.
getLockViewportsFlag()Gets or sets the lock viewports flag.
setLockViewportsFlag(boolean value)Gets or sets the lock viewports flag.
getLabelViewportsFlag()Gets or sets the label viewports flag.
setLabelViewportsFlag(boolean value)Gets or sets the label viewports flag.
getTextStyleId()Gets or sets the text style identifier.
setTextStyleId(String value)Gets or sets the text style identifier.
getClassVersion()Gets or sets the class version.
setClassVersion(int value)Gets or sets the class version.

CadSunStudy()

public CadSunStudy()

Initializes a new instance of the CadSunStudy class.

getSunStudyDates()

public final List<CadSunStudyDate> getSunStudyDates()

Gets or sets the sun study dates.

Returns: List - The sun study dates.

setSunStudyDates(List value)

public final void setSunStudyDates(List<CadSunStudyDate> value)

Gets or sets the sun study dates.

Parameters:

ParameterTypeDescription
valueListThe sun study dates.

getSunSetupName()

public final String getSunSetupName()

Gets or sets the name of the sun setup.

Returns: String - The name of the sun setup.

setSunSetupName(String value)

public final void setSunSetupName(String value)

Gets or sets the name of the sun setup.

Parameters:

ParameterTypeDescription
valueStringThe name of the sun setup.

getDescription()

public final String getDescription()

Gets or sets the description.

Returns: String - The description.

setDescription(String value)

public final void setDescription(String value)

Gets or sets the description.

Parameters:

ParameterTypeDescription
valueStringThe description.

getOutputType()

public final short getOutputType()

Gets or sets the type of the output.

Returns: short - The type of the output.

setOutputType(short value)

public final void setOutputType(short value)

Gets or sets the type of the output.

Parameters:

ParameterTypeDescription
valueshortThe type of the output.

getSheetSetName()

public final String getSheetSetName()

Gets or sets the name of the sheet set.

Returns: String - The name of the sheet set.

setSheetSetName(String value)

public final void setSheetSetName(String value)

Gets or sets the name of the sheet set.

Parameters:

ParameterTypeDescription
valueStringThe name of the sheet set.

getUseSubsetFlag()

public final boolean getUseSubsetFlag()

Gets or sets the use subset flag.

Returns: boolean - The use subset flag.

setUseSubsetFlag(boolean value)

public final void setUseSubsetFlag(boolean value)

Gets or sets the use subset flag.

Parameters:

ParameterTypeDescription
valuebooleanThe use subset flag.

getSheetSubsetName()

public final String getSheetSubsetName()

Gets or sets the name of the sheet subset.

Returns: String - The name of the sheet subset.

setSheetSubsetName(String value)

public final void setSheetSubsetName(String value)

Gets or sets the name of the sheet subset.

Parameters:

ParameterTypeDescription
valueStringThe name of the sheet subset.

getSelectDates()

public final boolean getSelectDates()

Gets or sets the select dates.

Returns: boolean - The select dates.

setSelectDates(boolean value)

public final void setSelectDates(boolean value)

Gets or sets the select dates.

Parameters:

ParameterTypeDescription
valuebooleanThe select dates.

getDateInputArraySize()

public final int getDateInputArraySize()

Gets or sets the size of the date input array.

Returns: int - The size of the date input array.

setDateInputArraySize(int value)

public final void setDateInputArraySize(int value)

Gets or sets the size of the date input array.

Parameters:

ParameterTypeDescription
valueintThe size of the date input array.

getDatesFlagSelectRange()

public final boolean getDatesFlagSelectRange()

Gets or sets the dates flag select range.

Returns: boolean - The dates flag select range.

setDatesFlagSelectRange(boolean value)

public final void setDatesFlagSelectRange(boolean value)

Gets or sets the dates flag select range.

Parameters:

ParameterTypeDescription
valuebooleanThe dates flag select range.

getStartTime()

public final int getStartTime()

Gets or sets the start time.

Returns: int - The start time.

setStartTime(int value)

public final void setStartTime(int value)

Gets or sets the start time.

Parameters:

ParameterTypeDescription
valueintThe start time.

getEndTime()

public final int getEndTime()

Gets or sets the end time.

Returns: int - The end time.

setEndTime(int value)

public final void setEndTime(int value)

Gets or sets the end time.

Parameters:

ParameterTypeDescription
valueintThe end time.

getIntervalInSeconds()

public final int getIntervalInSeconds()

Gets or sets the interval in seconds.

Returns: int - The interval in seconds.

setIntervalInSeconds(int value)

public final void setIntervalInSeconds(int value)

Gets or sets the interval in seconds.

Parameters:

ParameterTypeDescription
valueintThe interval in seconds.

getHoursNumber()

public final short getHoursNumber()

Gets or sets the hours number.

Returns: short - The hours number.

setHoursNumber(short value)

public final void setHoursNumber(short value)

Gets or sets the hours number.

Parameters:

ParameterTypeDescription
valueshortThe hours number.

getHoursList()

public final List<Boolean> getHoursList()

Gets or sets the hours list.

Returns: List - The hours list.

setHoursList(List value)

public final void setHoursList(List<Boolean> value)

Gets or sets the hours list.

Parameters:

ParameterTypeDescription
valueListThe hours list.

getPageSetupWizardHardPointerId()

public final String getPageSetupWizardHardPointerId()

Gets or sets the page setup wizard hard pointer identifier.

Returns: String - The page setup wizard hard pointer identifier.

setPageSetupWizardHardPointerId(String value)

public final void setPageSetupWizardHardPointerId(String value)

Gets or sets the page setup wizard hard pointer identifier.

Parameters:

ParameterTypeDescription
valueStringThe page setup wizard hard pointer identifier.

getViewHardPointerId()

public final String getViewHardPointerId()

Gets or sets the view hard pointer identifier.

Returns: String - The view hard pointer identifier.

setViewHardPointerId(String value)

public final void setViewHardPointerId(String value)

Gets or sets the view hard pointer identifier.

Parameters:

ParameterTypeDescription
valueStringThe view hard pointer identifier.

getVisualStyleId()

public final String getVisualStyleId()

Gets or sets the visual style identifier.

Returns: String - The visual style identifier.

setVisualStyleId(String value)

public final void setVisualStyleId(String value)

Gets or sets the visual style identifier.

Parameters:

ParameterTypeDescription
valueStringThe visual style identifier.

getShadePlotType()

public final short getShadePlotType()

Gets or sets the type of the shade plot.

Returns: short - The type of the shade plot.

setShadePlotType(short value)

public final void setShadePlotType(short value)

Gets or sets the type of the shade plot.

Parameters:

ParameterTypeDescription
valueshortThe type of the shade plot.

getViewportsPerPage()

public final short getViewportsPerPage()

Gets or sets the viewports per page.

Returns: short - The viewports per page.

setViewportsPerPage(short value)

public final void setViewportsPerPage(short value)

Gets or sets the viewports per page.

Parameters:

ParameterTypeDescription
valueshortThe viewports per page.

getViewportDistributionRowsNumber()

public final short getViewportDistributionRowsNumber()

Gets or sets the viewport distribution rows number.

Returns: short - The viewport distribution rows number.

setViewportDistributionRowsNumber(short value)

public final void setViewportDistributionRowsNumber(short value)

Gets or sets the viewport distribution rows number.

Parameters:

ParameterTypeDescription
valueshortThe viewport distribution rows number.

getViewportDistributionColumnsNumber()

public final short getViewportDistributionColumnsNumber()

Gets or sets the viewport distribution columns number.

Returns: short - The viewport distribution columns number.

setViewportDistributionColumnsNumber(short value)

public final void setViewportDistributionColumnsNumber(short value)

Gets or sets the viewport distribution columns number.

Parameters:

ParameterTypeDescription
valueshortThe viewport distribution columns number.

getSpacing()

public final double getSpacing()

Gets or sets the spacing.

Returns: double - The spacing.

setSpacing(double value)

public final void setSpacing(double value)

Gets or sets the spacing.

Parameters:

ParameterTypeDescription
valuedoubleThe spacing.

getLockViewportsFlag()

public final boolean getLockViewportsFlag()

Gets or sets the lock viewports flag.

Returns: boolean - The lock viewports flag.

setLockViewportsFlag(boolean value)

public final void setLockViewportsFlag(boolean value)

Gets or sets the lock viewports flag.

Parameters:

ParameterTypeDescription
valuebooleanThe lock viewports flag.

getLabelViewportsFlag()

public final boolean getLabelViewportsFlag()

Gets or sets the label viewports flag.

Returns: boolean - The label viewports flag.

setLabelViewportsFlag(boolean value)

public final void setLabelViewportsFlag(boolean value)

Gets or sets the label viewports flag.

Parameters:

ParameterTypeDescription
valuebooleanThe label viewports flag.

getTextStyleId()

public final String getTextStyleId()

Gets or sets the text style identifier.

Returns: String - The text style identifier.

setTextStyleId(String value)

public final void setTextStyleId(String value)

Gets or sets the text style identifier.

Parameters:

ParameterTypeDescription
valueStringThe text style identifier.

getClassVersion()

public final int getClassVersion()

Gets or sets the class version.

Returns: int - The class version.

setClassVersion(int value)

public final void setClassVersion(int value)

Gets or sets the class version.

Parameters:

ParameterTypeDescription
valueintThe class version.