nxopen

Class RuleManager.FunctionInformation

java.lang.Object

nxopen.RuleManager.FunctionInformation

All Implemented Interfaces:

Serializable

Enclosing interface:

RuleManager

public static class RuleManager.FunctionInformation
extends Object
implements Serializable

Used to return information about a function.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	briefDescription Brief description of function
boolean	designLogic TRUE if usable in Design Logic
String	fullDescription Full description of function
boolean	isDynamic TRUE for dynamic methods
int	numArguments Number of arguments
String	returnDescription Full description of return value
String	returnType Return type of function
String	seeAlso Other related functions, comma-separated list

Constructor Summary

Constructors

Constructor and Description
FunctionInformation()
FunctionInformation(String returnTypeInitial, int numArgumentsInitial, String briefDescriptionInitial, String fullDescriptionInitial, String returnDescriptionInitial, boolean isDynamicInitial, boolean designLogicInitial, String seeAlsoInitial) Constructor for the FunctionInformation object.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

returnType

public String returnType

Return type of function

numArguments

public int numArguments

Number of arguments

briefDescription

public String briefDescription

Brief description of function

fullDescription

public String fullDescription

Full description of function

returnDescription

public String returnDescription

Full description of return value

isDynamic

public boolean isDynamic

TRUE for dynamic methods

designLogic

public boolean designLogic

TRUE if usable in Design Logic

seeAlso

public String seeAlso

Other related functions, comma-separated list

Constructor Detail

FunctionInformation

public FunctionInformation()

FunctionInformation

public FunctionInformation(String returnTypeInitial,
                           int numArgumentsInitial,
                           String briefDescriptionInitial,
                           String fullDescriptionInitial,
                           String returnDescriptionInitial,
                           boolean isDynamicInitial,
                           boolean designLogicInitial,
                           String seeAlsoInitial)

Constructor for the FunctionInformation object.

Parameters:

returnTypeInitial - Return type of function

numArgumentsInitial - Number of arguments

briefDescriptionInitial - Brief description of function

fullDescriptionInitial - Full description of function

returnDescriptionInitial - Full description of return value

isDynamicInitial - TRUE for dynamic methods

designLogicInitial - TRUE if usable in Design Logic

seeAlsoInitial - Other related functions, comma-separated list