SDDS.java.SDDS

Class SDDSParameter

java.lang.Object

SDDS.java.SDDS.SDDSParameter

public class SDDSParameter
extends java.lang.Object

The SDDS Parameter object is used by the SDDS File object. It was not the intention of the author to use this object directly but it is still supported. After initializing the SDDS Parameter the setupParameter method must be used to give the parameter a name and a valid data type (long, short, float, double, string, character). The setValue method is used next to give the parameter values for different pages. The writeValue method can be used to print the value for a particular page.

Since:

JDK 1.2

Version:

1.0 (November 1, 1999)

Author:

Robert Soliday soliday@aps.anl.gov

Constructor Summary

Constructors

Constructor and Description
SDDSParameter() Create a new SDDS parameter that can be used to store parameter information for SDDS files.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deletePage(int page) Delete a page at the specified index
java.lang.String	getDescription() Returns the description of the parameter
java.lang.String	getFixed_Value() Returns the fixed value of the parameter
java.lang.String	getFormat_String() Returns the format string of the parameter
java.lang.String	getName() Returns the name of the parameter
int	getPageCount() Returns the number of pages that the parameter contains
java.lang.String	getSymbol() Returns the symbol of the parameter
int	getType() Returns the type of the parameter
java.lang.String	getUnits() Returns the units of the parameter
java.lang.Object	getValue(int page, boolean string_quotes) Get the values of the parameter for a chosen page
boolean	insertPage(int page) Inserts a blank page at the specified index
void	makeBlankPages(int lastpage) Create blank pages up to the last page specified
void	setDescription(java.lang.String description) Set the parameter description
void	setFixed_Value(java.lang.String fixed_value) Set the fixed value of the parameter
void	setFormat_String(java.lang.String format_string) Set the parameter format string
void	setName(java.lang.String name) Set the parameter name
void	setSymbol(java.lang.String symbol) Set the parameter symbol
void	setUnits(java.lang.String units) Set the parameter units
void	setupParameter(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, int type, java.lang.String fixed_value) Set up the parameter information.
void	setValue(double value, int page) Set the value of the parameter at a chosen page
void	setValue(long value, int page) Set the value of the parameter at a chosen page
void	setValue(java.lang.String value, int page) Set the value of the parameter at a chosen page
boolean	writeHeader(java.io.DataOutputStream dos) Write the header to a file.
boolean	writeValue(java.io.DataOutputStream dos, int page, boolean ascii) Write the value of the parameter for a chosen page
boolean	writeValue(LEDataOutputStream ledos, int page) Write the little endian binary value of the parameter for a chosen page

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SDDSParameter

public SDDSParameter()

Create a new SDDS parameter that can be used to store parameter information for SDDS files.

Method Detail

setupParameter

public void setupParameter(java.lang.String name,
                  java.lang.String symbol,
                  java.lang.String units,
                  java.lang.String description,
                  java.lang.String format_string,
                  int type,
                  java.lang.String fixed_value)

Set up the parameter information.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for ulong
• 5 for short
• 6 for ushort
• 7 for string
• 8 for character

fixed_value - may be null

getName

public java.lang.String getName()

Returns the name of the parameter

Returns:

The String value of the parameter name.

setName

public void setName(java.lang.String name)

Set the parameter name

Parameters:

name - name of the parameter

getSymbol

public java.lang.String getSymbol()

Returns the symbol of the parameter

Returns:

The String value of the parameter symbol.

setSymbol

public void setSymbol(java.lang.String symbol)

Set the parameter symbol

Parameters:

symbol - symbol of the parameter

getUnits

public java.lang.String getUnits()

Returns the units of the parameter

Returns:

The String value of the parameter units.

setUnits

public void setUnits(java.lang.String units)

Set the parameter units

Parameters:

units - units of the parameter

getDescription

public java.lang.String getDescription()

Returns the description of the parameter

Returns:

The String value of the parameter description.

setDescription

public void setDescription(java.lang.String description)

Set the parameter description

Parameters:

description - description of the parameter

getFormat_String

public java.lang.String getFormat_String()

Returns the format string of the parameter

Returns:

The String value of the parameter format string.

setFormat_String

public void setFormat_String(java.lang.String format_string)

Set the parameter format string

Parameters:

format_string - format string of the parameter

getType

public int getType()

Returns the type of the parameter

Returns:

The int value of the parameter type.

getFixed_Value

public java.lang.String getFixed_Value()

Returns the fixed value of the parameter

Returns:

The String value of the parameter fixed value.

setFixed_Value

public void setFixed_Value(java.lang.String fixed_value)

Set the fixed value of the parameter

Parameters:

fixed_value - fixed_value of the parameter

getPageCount

public int getPageCount()

Returns the number of pages that the parameter contains

Returns:

The int value of the number of pages the parameter contains.

insertPage

public boolean insertPage(int page)

Inserts a blank page at the specified index

Parameters:

page - index of page to create insert

Returns:

true on success
false on error.

deletePage

public boolean deletePage(int page)

Delete a page at the specified index

Parameters:

page - index of page to delete

Returns:

true on success
false on error.

makeBlankPages

public void makeBlankPages(int lastpage)

Create blank pages up to the last page specified

Parameters:

lastpage - last page to create blank page

setValue

public void setValue(long value,
            int page)

Set the value of the parameter at a chosen page

Parameters:

value - a long precision number

page - the page of the parameter, must be greater then 0

setValue

public void setValue(double value,
            int page)

Set the value of the parameter at a chosen page

Parameters:

value - a double precision floating-point number

page - the page of the parameter, must be greater then 0

setValue

public void setValue(java.lang.String value,
            int page)

Set the value of the parameter at a chosen page

Parameters:

value - a string value

page - the page of the parameter, must be greater then 0

writeHeader

public boolean writeHeader(java.io.DataOutputStream dos)

Write the header to a file.

Parameters:

dos - a valid DataOutputStream

Returns:

true if the header was successfully written
false if an error occured

writeValue

public boolean writeValue(java.io.DataOutputStream dos,
                 int page,
                 boolean ascii)

Write the value of the parameter for a chosen page

Parameters:

dos - a valid DataOutputStream

page - the page of the parameter, must be greater then 0

ascii - set true to write ascii parameters, false to write big endian binary parameters

Returns:

true if the value was successfully written
false if an invalid page was encountered or if the parameter type is undefined.

writeValue

public boolean writeValue(LEDataOutputStream ledos,
                 int page)

Write the little endian binary value of the parameter for a chosen page

Parameters:

ledos - a valid LEDataOutputStream

page - the page of the parameter, must be greater then 0

Returns:

true if the value was successfully written
false if an invalid page was encountered or if the parameter type is undefined.

getValue

public java.lang.Object getValue(int page,
                        boolean string_quotes)

Get the values of the parameter for a chosen page

Parameters:

page - the page of the parameter, must be greater then 0

string_quotes - true if quotes are to be added around strings
false if raw strings are to be outputed.

Returns:

Object containing parameter data