org.jmodelica.modelica.compiler.InstFunctionArgument Class Reference

Base class for function call arguments in the instance tree. More...

Inheritance diagram for org.jmodelica.modelica.compiler.InstFunctionArgument:

List of all members.

Public Member Functions
void	flushCache ()
	low-level
void	flushCollectionCache ()
	internal
InstFunctionArgument	clone () throws CloneNotSupportedException
	internal
boolean	generateUnbindableError (String desc, boolean genForPos)
	method InstanceErrorCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/ErrorCheck.jrag:853
void	typeCheck ()
	method FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:466
FExp	flatten (FQName prefix)
	method FlatExpressions /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/Flattening.jrag:1350
boolean	bindArgument (InstFunctionArgument[] arr, ArrayList< InstComponentDecl > inputs)
	Finds which, if any, of the inputs for its function a single argument should bind to, and adds it to an array in the corresponding place.
void	setBoundInput (InstComponentDecl input)
	Set the input component this argument is bound to.
void	setErrorArgLocation (ASTNode node)
	Argument nodes representing arguments that are missing or given multiple times do not get a location set when they are created.
FExp	getFExp ()
	Returns the FExp associated with this argument, if any.
	InstFunctionArgument ()
	method FlatModelica.ast:1
boolean	mayHaveRewrite ()
	internal method FlatModelica.ast:16
boolean	isCircular ()
	syn CircularExpressions /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/ConstantEvaluation.jrag:2484
boolean	isGiven ()
	Check if the argument was explicitly given in the call.
InstComponentDecl	getBoundInput ()
	Get the input component this argument is bound to.
boolean	isOKArg ()
	Returns false if this argument node represents an error, e.g.
String	functionCallDecription ()
	inh FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:460
boolean	argumentDefinedTypeValid ()
	Check if the type defined for this argument in the built-in function list is valid.
boolean	argumentTypeValid (FType type)
	Check if the type supplied is valid for this argument.
String	funcName ()
	inh FlatFunctionUtils /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/Util.jrag:1429
ASTNode	rewriteTo ()
	internal
Protected Member Functions
String	argumentDesc ()
	method FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:491
InstMultipleBoundArgument	addMultipleBoundArgument (InstFunctionArgument arg)
	Return an InstMultipleBoundArgument containing both this and arg.
int	findArgumentPosition (ArrayList< InstComponentDecl > inputs)
	Return the position of the input the argument corresponds to.
int	numChildren ()
	low-level method FlatModelica.ast:10
Protected Attributes
InstComponentDecl	boundInput = null
	The input component this argument is bound to.

---

Detailed Description

Base class for function call arguments in the instance tree.

node FlatModelica.ast:982

---

Constructor & Destructor Documentation

org.jmodelica.modelica.compiler.InstFunctionArgument.InstFunctionArgument

(

)

method FlatModelica.ast:1

---

Member Function Documentation

InstMultipleBoundArgument org.jmodelica.modelica.compiler.InstFunctionArgument.addMultipleBoundArgument

(

InstFunctionArgument

arg

)

[protected]

Return an InstMultipleBoundArgument containing both this and arg.

If this is an InstMultipleBoundArgument, arg is simply added to it. method InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:55

Reimplemented in org.jmodelica.modelica.compiler.InstMultipleBoundArgument.

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.argumentDefinedTypeValid

(

)

Check if the type defined for this argument in the built-in function list is valid.

inh FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:557

String org.jmodelica.modelica.compiler.InstFunctionArgument.argumentDesc

(

)

[protected]

method FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:491

Reimplemented in org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.argumentTypeValid

(

FType

type

)

Check if the type supplied is valid for this argument.

Only used if argumentDefinedTypeValid() returns false. inh FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:575

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.bindArgument	(	InstFunctionArgument[]	arr,
		ArrayList< InstComponentDecl >	inputs
	)

Finds which, if any, of the inputs for its function a single argument should bind to, and adds it to an array in the corresponding place.

If the place in the array is taken, an InstMultipleBoundArgument containing both arguments is placed there.

Parameters:

	arr	the array to place the argument in
	inputs	the list of inputs for the function

Returns:

true it the position for the argument could be found, false otherwise. method InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:35

InstFunctionArgument org.jmodelica.modelica.compiler.InstFunctionArgument.clone

(

)

throws CloneNotSupportedException

internal

Reimplemented from org.jmodelica.modelica.compiler.BaseNode.

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, org.jmodelica.modelica.compiler.InstMultipleBoundArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

int org.jmodelica.modelica.compiler.InstFunctionArgument.findArgumentPosition

(

ArrayList< InstComponentDecl >

inputs

)

[protected]

Return the position of the input the argument corresponds to.

method InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:67

Reimplemented in org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

FExp org.jmodelica.modelica.compiler.InstFunctionArgument.flatten

(

FQName

prefix

)

method FlatExpressions /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/Flattening.jrag:1350

void org.jmodelica.modelica.compiler.InstFunctionArgument.flushCache

(

)

low-level

Reimplemented from org.jmodelica.modelica.compiler.BaseNode.

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, org.jmodelica.modelica.compiler.InstMultipleBoundArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

void org.jmodelica.modelica.compiler.InstFunctionArgument.flushCollectionCache

(

)

internal

Reimplemented from org.jmodelica.modelica.compiler.BaseNode.

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, org.jmodelica.modelica.compiler.InstMultipleBoundArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

String org.jmodelica.modelica.compiler.InstFunctionArgument.funcName

(

)

inh FlatFunctionUtils /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/Util.jrag:1429

String org.jmodelica.modelica.compiler.InstFunctionArgument.functionCallDecription

(

)

inh FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:460

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.generateUnbindableError	(	String	desc,
		boolean	genForPos
	)

method InstanceErrorCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/ErrorCheck.jrag:853

Reimplemented in org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

InstComponentDecl org.jmodelica.modelica.compiler.InstFunctionArgument.getBoundInput

(

)

Get the input component this argument is bound to.

syn InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:113

FExp org.jmodelica.modelica.compiler.InstFunctionArgument.getFExp

(

)

Returns the FExp associated with this argument, if any.

method InstanceTreeConstruction /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstanceTree.jrag:1133

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.isCircular

(

)

syn CircularExpressions /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/ConstantEvaluation.jrag:2484

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.isGiven

(

)

Check if the argument was explicitly given in the call.

syn InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:88

Reimplemented in org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.isOKArg

(

)

Returns false if this argument node represents an error, e.g.

a missing argument. syn InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:128

Reimplemented in org.jmodelica.modelica.compiler.InstMissingArgument, and org.jmodelica.modelica.compiler.InstMultipleBoundArgument.

boolean org.jmodelica.modelica.compiler.InstFunctionArgument.mayHaveRewrite

(

)

internal method FlatModelica.ast:16

Reimplemented from org.jmodelica.modelica.compiler.BaseNode.

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, org.jmodelica.modelica.compiler.InstMultipleBoundArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

int org.jmodelica.modelica.compiler.InstFunctionArgument.numChildren

(

)

[protected]

low-level method FlatModelica.ast:10

Reimplemented from org.jmodelica.modelica.compiler.BaseNode.

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, org.jmodelica.modelica.compiler.InstMultipleBoundArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

ASTNode org.jmodelica.modelica.compiler.InstFunctionArgument.rewriteTo

(

)

internal

Reimplemented from org.jmodelica.modelica.compiler.BaseNode.

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, org.jmodelica.modelica.compiler.InstMultipleBoundArgument, org.jmodelica.modelica.compiler.InstNamedArgument, and org.jmodelica.modelica.compiler.InstPositionalArgument.

void org.jmodelica.modelica.compiler.InstFunctionArgument.setBoundInput

(

InstComponentDecl

input

)

Set the input component this argument is bound to.

method InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:100

Reimplemented in org.jmodelica.modelica.compiler.InstMultipleBoundArgument.

void org.jmodelica.modelica.compiler.InstFunctionArgument.setErrorArgLocation

(

ASTNode

node

)

Argument nodes representing arguments that are missing or given multiple times do not get a location set when they are created.

Set the location for those nodes, do nothing for other nodes. method InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:120

Reimplemented in org.jmodelica.modelica.compiler.InstMissingArgument, and org.jmodelica.modelica.compiler.InstMultipleBoundArgument.

void org.jmodelica.modelica.compiler.InstFunctionArgument.typeCheck

(

)

method FlatTypeCheck /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/FlatTypeCheck.jrag:466

Reimplemented in org.jmodelica.modelica.compiler.InstDefaultArgument, org.jmodelica.modelica.compiler.InstMissingArgument, and org.jmodelica.modelica.compiler.InstMultipleBoundArgument.

---

Member Data Documentation

InstComponentDecl org.jmodelica.modelica.compiler.InstFunctionArgument.boundInput = null [protected]

The input component this argument is bound to.

method InstFunctionBinding /tmp/JModelica/Compiler/ModelicaFrontEnd/src/jastadd/InstFunctionBinding.jrag:95 The input component this argument is bound to.

---

The documentation for this class was generated from the following file:

• Compiler/ModelicaCompiler/src/java-generated/org/jmodelica/modelica/compiler/InstFunctionArgument.java