SORTIE Java Interface  1
Public Member Functions | Private Attributes | List of all members
sortie.data.funcgroups.BehaviorInstantiator Class Reference

Contains information for behavior instantiation. More...

Public Member Functions

 BehaviorInstantiator (Class<? extends Behavior > oClass, String sDescriptor, String sParFileTag, String sXMLRootString) throws ModelException
 Constructor. More...
 
Behavior createBehavior (GUIManager oManager, BehaviorTypeBase oParent) throws ModelException
 Creates an instance of this behavior's class. More...
 
String getDescriptor ()
 
String getParFileTag ()
 
String getXMLRootString ()
 
Class<? extends BehaviorgetBehaviorClass ()
 

Private Attributes

String m_sDescriptor
 This is what will be displayed as the name of a given behavior in the GUI. More...
 
String m_sParFileTag
 String which is used to identify this behavior in the parameter file. More...
 
String m_sXMLRootString
 XML tag to surround this behavior's data. More...
 
Class<? extends Behaviorm_oClass
 Behavior class. More...
 

Detailed Description

Contains information for behavior instantiation.

Author
LORA

Constructor & Destructor Documentation

◆ BehaviorInstantiator()

sortie.data.funcgroups.BehaviorInstantiator.BehaviorInstantiator ( Class<? extends Behavior oClass,
String  sDescriptor,
String  sParFileTag,
String  sXMLRootString 
) throws ModelException

Constructor.

Parameters
sDescriptorThe name of the behavior for the user.
sParFileTagString which is used to identify this behavior in the parameter file.
sXMLRootStringXML tag to surround this behavior's data.
oClassBehavior class.

Member Function Documentation

◆ createBehavior()

Behavior sortie.data.funcgroups.BehaviorInstantiator.createBehavior ( GUIManager  oManager,
BehaviorTypeBase  oParent 
) throws ModelException

Creates an instance of this behavior's class.

Parameters
oManagerGUI Manager.
oParentManaging behavior group object.
Returns
New behavior object.
Exceptions
ModelExceptionIf there is a problem with the instantiation.

◆ getBehaviorClass()

Class<? extends Behavior> sortie.data.funcgroups.BehaviorInstantiator.getBehaviorClass ( )
Returns
the Class

◆ getDescriptor()

String sortie.data.funcgroups.BehaviorInstantiator.getDescriptor ( )
Returns
the descriptor

◆ getParFileTag()

String sortie.data.funcgroups.BehaviorInstantiator.getParFileTag ( )
Returns
the ParFileTag

◆ getXMLRootString()

String sortie.data.funcgroups.BehaviorInstantiator.getXMLRootString ( )
Returns
the XMLRootString

Member Data Documentation

◆ m_oClass

Class<? extends Behavior> sortie.data.funcgroups.BehaviorInstantiator.m_oClass
private

Behavior class.

◆ m_sDescriptor

String sortie.data.funcgroups.BehaviorInstantiator.m_sDescriptor
private

This is what will be displayed as the name of a given behavior in the GUI.

Shouldn't be too long - max 5 words or so

◆ m_sParFileTag

String sortie.data.funcgroups.BehaviorInstantiator.m_sParFileTag
private

String which is used to identify this behavior in the parameter file.

◆ m_sXMLRootString

String sortie.data.funcgroups.BehaviorInstantiator.m_sXMLRootString
private

XML tag to surround this behavior's data.


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