Interface FmiBuilder.Port<PORT_SCALAR_TYPE,AST>
-
- Enclosing interface:
- FmiBuilder<AST,B,E,SETTINGS>
public static interface FmiBuilder.Port<PORT_SCALAR_TYPE,AST>
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classFmiBuilder.Port.PortLinkException
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidbreakLink()Break the source linkStringgetName()Get the port nameFmiBuilder.FmiSimulationInstance<AST,PORT_SCALAR_TYPE>getOwner()Get the owner of this port.LonggetPortReferenceValue()Get the port reference valueStringgetQualifiedName()Gets the fully qualified port name including its source reference.PORT_SCALAR_TYPEgetSourceObject()Gets the underlying objects from which the port is createdbooleanisLinked()Indicates if the current port is linkedbooleanisLinkedAsInputConsumer()Indicates if another @FmiBuilder.Portis linked into thisbooleanisLinkedAsOutputProvider()Indicates if this is linked into other @FmiBuilder.PortsvoidlinkTo(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... receiver)Link the current port to the receiving port.
-
-
-
Method Detail
-
getQualifiedName
String getQualifiedName()
Gets the fully qualified port name including its source reference. Often on the form source.name- Returns:
-
getOwner
FmiBuilder.FmiSimulationInstance<AST,PORT_SCALAR_TYPE> getOwner()
Get the owner of this port. This is the object that should be used to get/set its values- Returns:
- the instance owning the port
-
getSourceObject
PORT_SCALAR_TYPE getSourceObject()
Gets the underlying objects from which the port is created- Returns:
-
getName
String getName()
Get the port name- Returns:
-
getPortReferenceValue
Long getPortReferenceValue()
Get the port reference value- Returns:
-
linkTo
void linkTo(FmiBuilder.Port<PORT_SCALAR_TYPE,AST>... receiver) throws FmiBuilder.Port.PortLinkException
Link the current port to the receiving port. After this the receiving port will resolve its linked value to the value of this port- Parameters:
receiver-- Throws:
FmiBuilder.Port.PortLinkException
-
breakLink
void breakLink() throws FmiBuilder.Port.PortLinkExceptionBreak the source link
-
isLinked
boolean isLinked()
Indicates if the current port is linked- Returns:
- true if linked
-
isLinkedAsOutputProvider
boolean isLinkedAsOutputProvider()
Indicates if this is linked into other @FmiBuilder.Ports- Returns:
- true if linked
-
isLinkedAsInputConsumer
boolean isLinkedAsInputConsumer()
Indicates if another @FmiBuilder.Portis linked into this- Returns:
- true if linked
-
-