com.reticular.agentBuilder.agent.perception
Class SocketCommInfo

java.lang.Object
  |
  +--com.reticular.agentBuilder.agent.perception.CommInfo
        |
        +--com.reticular.agentBuilder.agent.perception.SocketCommInfo
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SocketCommInfo
extends CommInfo
implements java.lang.Cloneable, java.io.Serializable

The configuration data for setting up a socket based agent.

See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_KQMLCONVERTER_CLASS
          The default class for KqmlConverter.
 
Fields inherited from class com.reticular.agentBuilder.agent.perception.CommInfo
CORBA_COMM_TYPE, DEFAULT_CORBA_PORT, DEFAULT_ESPEAK_PORT, DEFAULT_RMI_PORT, DEFAULT_SOCKET_PORT, ESPEAK_COMM_TYPE, RMI_COMM_TYPE, SOCKET_COMM_TYPE
 
Constructor Summary
SocketCommInfo()
          DO NOT USE.
SocketCommInfo(int port)
          A full body construct that takes all of the data elements in its constructor.
SocketCommInfo(int port, java.lang.String kqmlConverterClass)
          A full body construct that takes all of the data elements in its constructor.
 
Method Summary
 java.lang.Object clone()
          Calls the super.clone() from lang.obj and catches the exceptions.
 boolean equals(java.lang.Object other)
          Returns true if the input object is a SocketCommInfo object and if the _port values match.
 java.lang.String getCommType()
          Get the comm type of this actual agent info object.
 boolean getIsSupported()
          Indicates whether this agent will support this comm type.
 java.lang.String getKqmlConverter()
          Description :
 int getPort()
          Get the port the registry is using.
 void setIsSupported(boolean isSupported)
          Sets the isSupported field for the agent's commType.
 void setKqmlConverter(java.lang.String newClass)
          Description :
 void setPort(int port)
          Sets the rmiregistry port.
 java.lang.String toBNFString()
          Encodes the SocketCommInfo object in a BNF compatible way.
 
Methods inherited from class com.reticular.agentBuilder.agent.perception.CommInfo
getRandomPort
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_KQMLCONVERTER_CLASS

public static final java.lang.String DEFAULT_KQMLCONVERTER_CLASS
The default class for KqmlConverter.
Constructor Detail

SocketCommInfo

public SocketCommInfo()
DO NOT USE. For persistent store use only.

SocketCommInfo

public SocketCommInfo(int port)
A full body construct that takes all of the data elements in its constructor.
Parameters:
int - The port to initialize the Socket with

SocketCommInfo

public SocketCommInfo(int port,
                      java.lang.String kqmlConverterClass)
A full body construct that takes all of the data elements in its constructor.
Parameters:
int - The port to initialize the Socket with
Method Detail

equals

public boolean equals(java.lang.Object other)
Returns true if the input object is a SocketCommInfo object and if the _port values match.
Overrides:
equals in class CommInfo
Parameters:
Object - An instance of a subclass of CommInfo
Returns:
boolean

toBNFString

public java.lang.String toBNFString()
Encodes the SocketCommInfo object in a BNF compatible way.
Overrides:
toBNFString in class CommInfo
Returns:
String The BNF encoding of the socket CommInfo object.

getCommType

public java.lang.String getCommType()
Get the comm type of this actual agent info object.
Overrides:
getCommType in class CommInfo
Returns:
String

getPort

public int getPort()
Get the port the registry is using.
Overrides:
getPort in class CommInfo
Returns:
int The port number.

setPort

public void setPort(int port)
Sets the rmiregistry port.
Parameters:
port - The port number.

setIsSupported

public void setIsSupported(boolean isSupported)
Sets the isSupported field for the agent's commType.
Parameters:
boolean -  
Returns:
void

getIsSupported

public boolean getIsSupported()
Indicates whether this agent will support this comm type.
Overrides:
getIsSupported in class CommInfo
Parameters:
boolean -  
Returns:
void

setKqmlConverter

public void setKqmlConverter(java.lang.String newClass)
Description :
Parameters:
-  
Returns:
void

getKqmlConverter

public java.lang.String getKqmlConverter()
Description :
Parameters:
-  
Returns:
String

clone

public java.lang.Object clone()
Calls the super.clone() from lang.obj and catches the exceptions.
Overrides:
clone in class CommInfo
Returns:
Object