ptserver.util

Class ProxyModelBuilder

java.lang.Object

ptserver.util.ProxyModelBuilder

public class ProxyModelBuilder
extends java.lang.Object

ProxyModelGenerator splices up CompositeActor to support distribution execution. The splicing would be done slightly differently depending where the model runs, client or server. The builder would modify original model by injecting proxy actors that facilitate distributed communication with another instance of proxy model running remotely.

Since:

Ptolemy II 10.0

Version:

$Id: ProxyModelBuilder.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Anar Huseynov

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyModelBuilder.ProxyModelType An enumerations that specifies the proxy model type: client or server.

Constructor Summary

Constructors

Constructor and Description
ProxyModelBuilder(ProxyModelBuilder.ProxyModelType modelType, CompositeActor topLevelActor) Create a new instance of the builder for the provided model.

Method Summary

Modifier and Type	Method and Description
void	build() Build the ProxyModel that supports distributed execution.
java.util.HashMap<java.lang.String,java.lang.String>	getModelTypes() Return the mapping from the typeable named object's full name to its type string.
java.util.HashMap<java.lang.String,ProxySink>	getProxySinkMap() Return the mapping from the target actor's full name to the ProxySink associated with it.
java.util.HashMap<java.lang.String,ProxySourceData>	getProxySourceMap() Return the mapping from the target actor's full name to the ProxySource associated with it.
java.util.HashMap<java.lang.String,Settable>	getRemoteAttributesMap() Return the mapping from the attribute full name's to the attribute instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyModelBuilder

public ProxyModelBuilder(ProxyModelBuilder.ProxyModelType modelType,
                         CompositeActor topLevelActor)

Create a new instance of the builder for the provided model.

Parameters:

modelType - The type of the model the builder should build.

topLevelActor - The target model on which builder would perform its operations.

Method Detail

build

public void build()
           throws IllegalActionException,
                  TypeConflictException,
                  NameDuplicationException,
                  java.lang.CloneNotSupportedException

Build the ProxyModel that supports distributed execution. In the case of the server model type, sinks and sources marked to run on the client would be replaced with a proxy sinks and sources that facilitate communication with a remote instance of the proxy model. In the case of the client model type, all actors directly connected to sinks and sources marked with a "_remote" attribute would replaced with proxy sources and sinks respectively. All others actor would be removed.

Throws:

IllegalActionException - if there is a problem setting a manager or capturing certain type information.

TypeConflictException - if there is a problem resolving types on the model.

NameDuplicationException - if there is a problem creating proxy sinks or sources.

java.lang.CloneNotSupportedException - if there is a problem cloning ports or attributes.

getModelTypes

public java.util.HashMap<java.lang.String,java.lang.String> getModelTypes()

Return the mapping from the typeable named object's full name to its type string. The type string is obtained by calling .toString() method on the type instance.

Returns:

Return the mapping from the typeable named object's full name to its type string.

getProxySinkMap

public java.util.HashMap<java.lang.String,ProxySink> getProxySinkMap()

Return the mapping from the target actor's full name to the ProxySink associated with it.

Returns:

Return the mapping from the target actor's full name to the ProxySink associated with it.

getProxySourceMap

public java.util.HashMap<java.lang.String,ProxySourceData> getProxySourceMap()

Return the mapping from the target actor's full name to the ProxySource associated with it.

Returns:

Return the mapping from the target actor's full name to the ProxySource associated with it.

getRemoteAttributesMap

public java.util.HashMap<java.lang.String,Settable> getRemoteAttributesMap()

Return the mapping from the attribute full name's to the attribute instance. The mapping only contains attributes that have ServerUtility.REMOTE_OBJECT_TAG attribute within them.

Returns:

the _remoteAttributesMap