com.phoenix_int.aserver.types
Interface IPHXRefPropInfo

All Superinterfaces:

IPHXDescription

All Known Implementing Classes:

PHXRefArrayProperty, PHXRefProperty

public interface IPHXRefPropInfo
extends IPHXDescription

This interface provides information about a reference property:

• name: String
• type: String
• enumValues: String[]
• description: String
• title: String
• input: boolean

where type may be any of the following:

• "long"
• "double"
• "boolean"
• "string"

Method Summary

void	enumValuesFromString(java.lang.String enumValues)
java.lang.String[]	getEnumValues() lists enum values
boolean	getInput() retrieves an indicator of whether the ref prop is an input or an output.
java.lang.String	getName() retrieves the name of the variable
java.lang.String	getTitle() retrieves a title of the ref prop.
java.lang.String	getType() retrieves the current type of the variable
void	setEnumValues(java.lang.String[] enumValues) sets the enum values
void	setInput(boolean value) sets an indicator for the ref prop
void	setTitle(java.lang.String value) sets a title of the ref prop

Methods inherited from interface com.phoenix_int.aserver.types.IPHXDescription

getDescription, setDescription

Method Detail

getName

java.lang.String getName()

retrieves the name of the variable

Returns:

the name of the variable

getType

java.lang.String getType()

retrieves the current type of the variable

Returns:

the value of the variable

getTitle

java.lang.String getTitle()

retrieves a title of the ref prop. Used by ModelCenter when displaying the variable in certain dialogs

Returns:

a title for the ref prop

setTitle

void setTitle(java.lang.String value)

sets a title of the ref prop

Parameters:

value - a title for the ref prop

getInput

boolean getInput()

retrieves an indicator of whether the ref prop is an input or an output. If it's an output, the driver component will calculate a value for it.

Returns:

an indicator if the ref prop is an input

setInput

void setInput(boolean value)

sets an indicator for the ref prop

Parameters:

value - an indicator for the ref prop

getEnumValues

java.lang.String[] getEnumValues()

lists enum values

Returns:

an array of enum values

setEnumValues

void setEnumValues(java.lang.String[] enumValues)

sets the enum values

Parameters:

enumValues - an array of enum values

enumValuesFromString

void enumValuesFromString(java.lang.String enumValues)