com.telelogic.rhapsody.core
Interface IRPApplication


public interface IRPApplication

The IRPApplication interface represents the Rhapsody application, and its methods reflect many of the commands that you can access from the Rhapsody menu bar.


Nested Class Summary
static class IRPApplication.AddToModel_Mode
          This class holds constant values to be used with addToModelEx method.
 
Method Summary
 IRPProject activeProject()
          Returns an IRPProject object representing the project currently open in Rhapsody
 IRPUnit addProfileToModel(java.lang.String profileName)
          addProfileToModel
 void addSelectedToFavorites()
          Adds the currently selected item to the Favorites list.
 void addToModel(java.lang.String filename, int withDescendant)
          add To Model
 void addToModelByReference(java.lang.String filename)
          add To Model by reference
 void addToModelEx(java.lang.String filename, int addToModelMode, int addSubUnits, int addDependents)
          Adds a unit to the model.
 void addToModelFromURL(java.lang.String purl)
          add To Model From URL
 void allowBrowserRefresh(int shouldRefresh)
          allowBrowserRefresh
 void allowGERefresh(int shouldRefresh)
          allowGERefresh
 void applyNewTermsProfile(java.lang.String profileName)
          Called to apply a NewTerms Profile to the active project
 void arcCheckOut(java.lang.String filename, java.lang.String label, int isLocked, int isRecursive)
          archive Check Out
 void bringWindowToTop()
          bring window to top
 void build()
          Builds an application using the active component and configuration.
 void buildEntireProject()
          buildEntireProject
 void buildWithDependencies()
          buildWithDependencies
 int canRedo()
          Check if Redo action is available
 int canUndo()
          Check if Undo action is available
 void checkIn(java.lang.String unitName, java.lang.String label, int isLocked, int isRecursive, java.lang.String description)
          check In
 void checkModel()
          check model
 void checkOut(java.lang.String unitName, java.lang.String label, int isLocked, int isRecursive)
          check Out
 void clean()
          clean
 void clearOutputWindow(java.lang.String title)
          clear output window
 void closeAllAnimatedSequenceDiagrams(int withSave)
          Close All Animated Sequence diagrams without save
 void compareSequenceDiagram(IRPSequenceDiagram leftDiagram, IRPSequenceDiagram rightDiagram)
          Compares the two sequence diagrams specified as parameters.
 void connectToArchive(java.lang.String archivePath)
          connect To Archive
 void connectToImportedModel(java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName)
          Used to connect to an externally-managed model.
 void connectToTarget(java.lang.String targetName)
          connectToTarget
 int createAndInsertProject(java.lang.String projectLocation, java.lang.String projectName)
          Create a new project and insert it into current workspace
 void createDomainFromProfile(IRPProfile profileArg, java.lang.String serverURL)
          Create Domain from Profile After Login
 IRPCollection createNewCollection()
          creates a new Rhapsody collection object
 void createNewProject(java.lang.String projectLocation, java.lang.String projectName)
          Creates a new Rhapsody project
 void dbgCheckComIn(short i)
          For debug - check communication in
 short dbgCheckComOut()
          For debug - check communication out
 void deferredAddToModel(java.lang.String filename, int withDescendants, java.lang.String origPrjId, int eraseDir)
          Add Rhapsody unit to current project
 int deleteProjectFromList(java.lang.String projectName)
          Delete specified project from current workspace
 void disconnectFromTarget()
          disconnectFromTarget
 void dMRefreshRecursive(IRPUnit pUnit)
          dMRefreshRecursive
 void dMSyncAndRefresh(IRPProject projectArg, int sync, int refresh)
          dMSyncAndRefresh
 void downloadToTarget(java.lang.String filename)
          downloadToTarget
 void endUndoTransaction()
          end undo transaction
 void enterAnimationCommand(java.lang.String command)
          enter Animation Command
 java.lang.String errorMessage()
          Returns error message for last method called.
 void executeCommand(java.lang.String commandType, IRPCollection pCommandInitialization, IRPCollection pCommandResult)
          method execute command
 int executeCommandLine(java.lang.String commandLine)
          Execute command line
 void executeTransformationSequence(java.lang.String transformationSequence, int showTransformedModelPackage)
          executeTransformationSequence
 java.lang.String expandStringKeywords(java.lang.String theString)
          expand environment-variable keywords in the provided string
 java.lang.String fixpack()
          Get Rhapsody fixpack
 void forceOutput2Console(int val)
          Force output to system console
 void forceRoundtrip()
          forceRoundtrip
 void forceRoundtripElements(IRPCollection elements)
          method forceRoundtripElements
 void generate()
          Generates code for the entire project, using the active component and configuration.
 void generateElements(IRPCollection elements)
          method generateElements
 void generateEntireProject()
          generateEntireProject
 void generateMainAndMakeFiles()
          Generate Main and Make Files
 void generateWithDependencies()
          generateWithDependencies
 java.lang.String getApplicationConnectionString()
          getApplicationConnectionString
 void getApplicationName(java.lang.String applicationName, java.lang.String productRCPName)
          Get application name
 int getApplicationStatus()
          getApplicationStatus
 java.lang.String getBuildNo()
          get property BuildNo
 IRPCodeGenSimplifiersRegistry getCodeGenSimplifiersRegistry()
          get the code generation simplifiers registry
 IRPDiagram getDiagramOfSelectedElement()
          get diagram of selected element
 IRPDiagSynthAPI getDiagSynthAPI(java.lang.String clientName)
          for internal use
 int getDMBoolProperty(java.lang.String pKey)
          Returns the value of the specified Design Manager boolean property
 java.lang.String getDMModelWorkspaceFolder()
          Returns the path of the workspace folder used for the DM model.
 java.lang.String getDMProperty(java.lang.String pKey)
          Returns the value of the specified Design Manager property
 java.lang.String getErrorMessage()
          Returns error message for last method called.
 java.lang.String getExecutableFolder()
          getExecutableFolder
 IRPExternalCheckRegistry getExternalCheckerRegistry()
          get the External Checker registry
 IRPExternalIDERegistry getExternalIDERegistry(java.lang.String clientID)
          get the External IDE registry
 IRPExternalRoundtripInvoker getExternalRoundtripInvoker()
          getExternalRoundtripInvoker
 java.lang.String getIniFileParameterValue(java.lang.String sectionName, java.lang.String paramName)
          getIniFileParameterValue
 java.lang.String getInterfaceName()
          get property interfaceName
 int getIsHiddenUI()
          get property isHiddenUI
 int getIsLoadOnDemand()
          get property isLoadOnDemand
 java.lang.String getLanguage()
          get property Language
 IRPCollection getListOfFactoryProperties()
          get list of factory properties
 IRPCollection getListOfSelectedElements()
          get list of selected elements
 IRPCollection getListOfSiteProperties()
          get list of site properties
 java.lang.String getLocaleName()
          Returns the locale for the version of Rhapsody running.
 IRPModelElement getModelElementFromSource(java.lang.String sourceData, int isSourceDataIsfileName, int lineNumber)
          Find model element from source code
 java.lang.String getOMROOT()
          get property OMROOT
 java.lang.String getOutputWindowText()
          Returns the text displayed in the output window.
 IRPowPaneMgr getOWPaneMgr(java.lang.String clientID)
          For internal use only.
 IRPPlugInWindow getPlugInWindow(int nPlugInID, int nWindowID, int nCreateNew)
          PlugIn window factory
 IRPCollection getProjects()
          get property projects
 long getRhapsodyHandleErrorFunction()
          getRhapsodyHandleErrorFunction
 long getRhapsodyHandleErrorFunctionLong()
          getRhapsodyHandleErrorFunctionLong
 IRPSearchManager getSearchManager()
          get Rhapsody search manager
 IRPModelElement getSelectedElement()
          get selected element
 IRPCollection getSelectedGraphElements()
          get selected graph elements
 IRPSelection getSelection()
          Get Selection Interface
 java.lang.String getSerialNo()
          get property SerialNo
 IRPCodeGenerator getTheCodeGeneratorInterface()
          get codegeneration interface
 IRPExternalCodeGeneratorInvoker getTheExternalCodeGeneratorInvoker()
          get external code generator invoker
 IRPIntegrator getTheIntegratorInterface()
          get integrator interface
 IRPJavaPlugins getTheJavaPluginsInterface()
          getTheJavaPluginsInterface
 IRPRoundTrip getTheRoundtripInterface()
          get roundtrip interface
 java.lang.String getToolSet()
          get property ToolSet
 void highlightByHandle(java.lang.String strHandle)
          highlight by handle
 void highLightElement(IRPModelElement val)
          highlight element
 void importClasses()
          import Classes
 void importSyncSimulinkBlock2(IRPModelElement simulinkBlock, java.lang.String matlabExePath, java.lang.String simMdlFile, java.lang.String simSrcFiles, java.lang.String sampleTime)
          Imports a Simulink model into a Rhapsody model.
 void importTlb(java.lang.String pPath)
          import tlb
 IRPProject insertProject(java.lang.String filename)
          Insert existing project into current workspace
 IRPProject insertProjectFromDesignManager(java.lang.String userName, java.lang.String passwd, java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName, java.lang.String modelName)
          insertProjectFromDesignManager
 void invokePluginsMethod(java.lang.String methodName)
          invoke Plugins Method
 void invokeRPE()
          Opens the IBM Rational Rhapsody Report Generator wizard.
 int isRhapsodyCL()
          Is RhapsodyCL
 int isRhapsodyFileType(java.lang.String extension)
          Check if specified extension corresponds to any Rhapsody unit type
 int loginToDesignManagerWithAlias(java.lang.String serverURL, java.lang.String alias)
          loginToDesignManagerWithAlias
 int loginToDesignManagerWithCertificate(java.lang.String serverURL, java.lang.String certificateLocation, java.lang.String password)
          loginToDesignManagerWithCertificate
 int loginToDesignManagerWithUsername(java.lang.String serverURL, java.lang.String userName, java.lang.String password)
          loginToDesignManagerWithUsername
 void make()
          make
 void mergeElements(IRPModelElement left, IRPModelElement right)
          mergeElements
 IRPProject newProjectOnDesignManager(java.lang.String userName, java.lang.String password, java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName, java.lang.String modelName)
          Creates a new project on the Design Manager server.
 void notifyFileChanged(java.lang.String filename, int contentChanged)
          File change notification
 IRPAXViewCtrl openActiveXView(java.lang.String viewType, IRPCollection pViewInitialization, IRPCollection pExtra)
          Open ActivexView
 void openAdvancedSearchAndReplaceDialog()
          Open Advanced Search and Replace dialog
 IRPAXViewCtrl openDiagramView(IRPDiagram diagram)
          method OpenDiagramView
 void openFileList(java.lang.String filename)
          method openFileList
 IRPProject openProject(java.lang.String filename)
          Opens an existing Rhapsody project
 IRPProject openProjectFromDesignManager(java.lang.String userName, java.lang.String password, java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName, java.lang.String modelName)
          openProjectFromDesignManager
 IRPProject openProjectFromDesignManagerAfterLogin(java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName, java.lang.String modelName)
          openProjectFromDesignManagerAfterLogin
 void openProjectFromURL(java.lang.String purl)
          open Project From URL
 IRPProject openProjectWithLastSession(java.lang.String filename)
          open project with last session
 IRPProject openProjectWithoutSubUnits(java.lang.String filename)
          open project without subunits
 void quit()
          quit application
 void rebuild()
          rebuild
 void rebuildEntireProject()
          rebuildEntireProject
 void rebuildWithDependencies()
          rebuildWithDependencies
 int redo()
          Perform Redo
 void refactorSelectedOperation(java.lang.String newName)
          Changes the name of the currently-selected operation and updates any references to the operation accordingly.
 void refreshAllViews()
          refresh all views
 void regenerate()
          regenerate
 void regenerateElements(IRPCollection elements)
          method regenerateElements
 void regenerateEntireProject()
          regenerateEntireProject
 void regenerateWithDependencies()
          regenerateWithDependencies
 void registerCOMClient(int processID, java.lang.String clientFilename, int magicNumber)
          register COM client
 void report(java.lang.String format, java.lang.String outputFileName)
          report
 void rhpCheckinLicense(java.lang.String feature)
          checkin license
 java.lang.String rhpCheckoutLicense(java.lang.String feature)
          checkout license
 void roundtrip()
          roundtrip
 void roundtripElements(IRPCollection elements)
          method roundtripElements
 void runApplication()
          Runs the application that was built for the project
 void runHelper(java.lang.String helperName)
          runHelper
 void runHelperWithParameters(java.lang.String helperName, java.lang.String params)
          runHelperWithParameters
 void saveAll()
          method saveAll
 void selectGraphElements(IRPCollection graphElements)
          Selects multiple elements in the most recently opened diagram.
 void selectModelElements(IRPCollection modelElements)
          Selects multiple items in the model browser.
 void setApplicationStatus(int nStatus)
          setApplicationStatus
 void setComponent(java.lang.String component)
          set Component
 void setConfiguration(java.lang.String configuration)
          set Configuration
 void setDMBoolProperty(java.lang.String pKey, int val)
          Sets the value of the specified boolean Design Manager property
 void setDMProperty(java.lang.String pKey, java.lang.String val)
          Sets the value of the specified Design Manager property
 void setHiddenUI(boolean pVal)
          set property hiddenUI
 void setIsLoadOnDemand(int isLoadOnDemand)
          set property isLoadOnDemand
 void setLanguage(java.lang.String language)
          set property Language
 void setLog(java.lang.String logFile)
          set log file
 void setToolSet(java.lang.String toolSet)
          set property ToolSet
 void setUpdateRecentFileList(int shouldUpdate)
          setUpdateRecentFileList
 void startUndoTransaction()
          start undo transaction
 void syncBuild()
          syncBuild
 void terminateApplication()
          Terminate the Application
 int undo()
          Perform Undo
 void unloadFromTarget()
          unloadFromTarget
 void unregisterCOMClient(int processID, java.lang.String clientFilename, int magicNumber)
          unregister COM client
 java.lang.String version()
          Get Rhapsody version
 java.lang.String versionNumberLong()
          Get Rhapsody versionNumberLong
 void writeToOutputWindow(java.lang.String title, java.lang.String outputStr)
          Writes text to Rhapsody's Output window.
 

Method Detail

executeCommand

void executeCommand(java.lang.String commandType,
                    IRPCollection pCommandInitialization,
                    IRPCollection pCommandResult)
method execute command

Throws:
RhapsodyRuntimeException

getPlugInWindow

IRPPlugInWindow getPlugInWindow(int nPlugInID,
                                int nWindowID,
                                int nCreateNew)
PlugIn window factory

Throws:
RhapsodyRuntimeException

openActiveXView

IRPAXViewCtrl openActiveXView(java.lang.String viewType,
                              IRPCollection pViewInitialization,
                              IRPCollection pExtra)
Open ActivexView

Throws:
RhapsodyRuntimeException

openDiagramView

IRPAXViewCtrl openDiagramView(IRPDiagram diagram)
method OpenDiagramView

Throws:
RhapsodyRuntimeException

rhpCheckinLicense

void rhpCheckinLicense(java.lang.String feature)
checkin license

Throws:
RhapsodyRuntimeException

rhpCheckoutLicense

java.lang.String rhpCheckoutLicense(java.lang.String feature)
checkout license

Throws:
RhapsodyRuntimeException

activeProject

IRPProject activeProject()
Returns an IRPProject object representing the project currently open in Rhapsody

Returns:
IRPProject object that represents the project currently open in Rhapsody

addProfileToModel

IRPUnit addProfileToModel(java.lang.String profileName)
addProfileToModel

Throws:
RhapsodyRuntimeException

addSelectedToFavorites

void addSelectedToFavorites()
Adds the currently selected item to the Favorites list.


addToModel

void addToModel(java.lang.String filename,
                int withDescendant)
add To Model

Throws:
RhapsodyRuntimeException

addToModelByReference

void addToModelByReference(java.lang.String filename)
add To Model by reference

Throws:
RhapsodyRuntimeException

addToModelEx

void addToModelEx(java.lang.String filename,
                  int addToModelMode,
                  int addSubUnits,
                  int addDependents)
Adds a unit to the model.

Parameters:
filename - the full path to the file to add to the model
addToModelMode - how the unit should be added to the model - see IRPApplication.AddToModel_Mode for the available values
addSubUnits - use 1 if you want to also add the sub-units of the unit, 0 otherwise (this parameter is ignored if the addToModelMode parameter equals IRPApplication.AddToModel_Mode.AS_UNIT_WITHOUT_COPY)
addDependents - use 1 if you want to also add the units that elements in the specified unit are dependent upon, 0 otherwise (this parameter is ignored if the addToModelMode parameter equals IRPApplication.AddToModel_Mode.AS_UNIT_WITHOUT_COPY)

addToModelFromURL

void addToModelFromURL(java.lang.String purl)
add To Model From URL

Throws:
RhapsodyRuntimeException

allowBrowserRefresh

void allowBrowserRefresh(int shouldRefresh)
allowBrowserRefresh

Throws:
RhapsodyRuntimeException

allowGERefresh

void allowGERefresh(int shouldRefresh)
allowGERefresh

Throws:
RhapsodyRuntimeException

applyNewTermsProfile

void applyNewTermsProfile(java.lang.String profileName)
Called to apply a NewTerms Profile to the active project

Throws:
RhapsodyRuntimeException

arcCheckOut

void arcCheckOut(java.lang.String filename,
                 java.lang.String label,
                 int isLocked,
                 int isRecursive)
archive Check Out

Throws:
RhapsodyRuntimeException

bringWindowToTop

void bringWindowToTop()
bring window to top

Throws:
RhapsodyRuntimeException

build

void build()
Builds an application using the active component and configuration. Use IRPProject.setActiveComponent and IRPProject.setActiveConfiguration to change the active component and configuration if necessary before calling the build method.


buildEntireProject

void buildEntireProject()
buildEntireProject

Throws:
RhapsodyRuntimeException

buildWithDependencies

void buildWithDependencies()
buildWithDependencies

Throws:
RhapsodyRuntimeException

canRedo

int canRedo()
Check if Redo action is available

Throws:
RhapsodyRuntimeException

canUndo

int canUndo()
Check if Undo action is available

Throws:
RhapsodyRuntimeException

checkIn

void checkIn(java.lang.String unitName,
             java.lang.String label,
             int isLocked,
             int isRecursive,
             java.lang.String description)
check In

Throws:
RhapsodyRuntimeException

checkModel

void checkModel()
check model

Throws:
RhapsodyRuntimeException

checkOut

void checkOut(java.lang.String unitName,
              java.lang.String label,
              int isLocked,
              int isRecursive)
check Out

Throws:
RhapsodyRuntimeException

clean

void clean()
clean

Throws:
RhapsodyRuntimeException

clearOutputWindow

void clearOutputWindow(java.lang.String title)
clear output window

Throws:
RhapsodyRuntimeException

closeAllAnimatedSequenceDiagrams

void closeAllAnimatedSequenceDiagrams(int withSave)
Close All Animated Sequence diagrams without save

Throws:
RhapsodyRuntimeException

compareSequenceDiagram

void compareSequenceDiagram(IRPSequenceDiagram leftDiagram,
                            IRPSequenceDiagram rightDiagram)
Compares the two sequence diagrams specified as parameters. Corresponds to the Sequence Diagram Compare option in the Tools menu.

Parameters:
leftDiagram - the first diagram to use for the comparison
rightDiagram - the second diagram to use for the comparison

connectToArchive

void connectToArchive(java.lang.String archivePath)
connect To Archive

Throws:
RhapsodyRuntimeException

connectToImportedModel

void connectToImportedModel(java.lang.String serverURL,
                            java.lang.String projectAreaName,
                            java.lang.String streamName)
Used to connect to an externally-managed model. The method assumes you have already logged in to the relevant server, using one of the loginToDesignManager* methods in IRPApplication.

Parameters:
serverURL - - the URL of the Design Manager server
projectAreaName - - the name of the Project Area where the model is located
streamName - the name of the Stream where the model is located

connectToTarget

void connectToTarget(java.lang.String targetName)
connectToTarget

Throws:
RhapsodyRuntimeException

createAndInsertProject

int createAndInsertProject(java.lang.String projectLocation,
                           java.lang.String projectName)
Create a new project and insert it into current workspace

Throws:
RhapsodyRuntimeException

createDomainFromProfile

void createDomainFromProfile(IRPProfile profileArg,
                             java.lang.String serverURL)
Create Domain from Profile After Login

Throws:
RhapsodyRuntimeException

createNewCollection

IRPCollection createNewCollection()
creates a new Rhapsody collection object

Returns:
IRPCollection object that represents the collection that was created. After creating a collection, you can add items to it by calling IRPCollection.addItem or by calling IRPCollection.setSize and then IRPCollection.setModelElement.

createNewProject

void createNewProject(java.lang.String projectLocation,
                      java.lang.String projectName)
Creates a new Rhapsody project

Parameters:
projectLocation - the directory where the project should be saved, for example, "l:\\temp\\_sample_code"
projectName - the name to use for the project. This will be the name used for the .rpy file.

dMRefreshRecursive

void dMRefreshRecursive(IRPUnit pUnit)
dMRefreshRecursive

Throws:
RhapsodyRuntimeException

dMSyncAndRefresh

void dMSyncAndRefresh(IRPProject projectArg,
                      int sync,
                      int refresh)
dMSyncAndRefresh

Throws:
RhapsodyRuntimeException

dbgCheckComIn

void dbgCheckComIn(short i)
For debug - check communication in

Throws:
RhapsodyRuntimeException

dbgCheckComOut

short dbgCheckComOut()
For debug - check communication out

Throws:
RhapsodyRuntimeException

deferredAddToModel

void deferredAddToModel(java.lang.String filename,
                        int withDescendants,
                        java.lang.String origPrjId,
                        int eraseDir)
Add Rhapsody unit to current project

Throws:
RhapsodyRuntimeException

deleteProjectFromList

int deleteProjectFromList(java.lang.String projectName)
Delete specified project from current workspace

Throws:
RhapsodyRuntimeException

disconnectFromTarget

void disconnectFromTarget()
disconnectFromTarget

Throws:
RhapsodyRuntimeException

downloadToTarget

void downloadToTarget(java.lang.String filename)
downloadToTarget

Throws:
RhapsodyRuntimeException

endUndoTransaction

void endUndoTransaction()
end undo transaction

Throws:
RhapsodyRuntimeException

enterAnimationCommand

void enterAnimationCommand(java.lang.String command)
enter Animation Command

Throws:
RhapsodyRuntimeException

errorMessage

java.lang.String errorMessage()
Returns error message for last method called. If the last method completed successfully, then this method returns an empty string. To get the correct error message for a method, errorMessage() must be called immediately after the method is called.

Returns:
the error message for the last method called

executeCommandLine

int executeCommandLine(java.lang.String commandLine)
Execute command line

Throws:
RhapsodyRuntimeException

executeTransformationSequence

void executeTransformationSequence(java.lang.String transformationSequence,
                                   int showTransformedModelPackage)
executeTransformationSequence

Throws:
RhapsodyRuntimeException

expandStringKeywords

java.lang.String expandStringKeywords(java.lang.String theString)
expand environment-variable keywords in the provided string

Throws:
RhapsodyRuntimeException

fixpack

java.lang.String fixpack()
Get Rhapsody fixpack

Throws:
RhapsodyRuntimeException

forceOutput2Console

void forceOutput2Console(int val)
Force output to system console

Throws:
RhapsodyRuntimeException

forceRoundtrip

void forceRoundtrip()
forceRoundtrip

Throws:
RhapsodyRuntimeException

forceRoundtripElements

void forceRoundtripElements(IRPCollection elements)
method forceRoundtripElements

Throws:
RhapsodyRuntimeException

generate

void generate()
Generates code for the entire project, using the active component and configuration. Use IRPProject.setActiveComponent and IRPProject.setActiveConfiguration to change the active component and configuration if necessary before calling the generate method.


generateElements

void generateElements(IRPCollection elements)
method generateElements

Throws:
RhapsodyRuntimeException

generateEntireProject

void generateEntireProject()
generateEntireProject

Throws:
RhapsodyRuntimeException

generateMainAndMakeFiles

void generateMainAndMakeFiles()
Generate Main and Make Files

Throws:
RhapsodyRuntimeException

generateWithDependencies

void generateWithDependencies()
generateWithDependencies

Throws:
RhapsodyRuntimeException

getApplicationConnectionString

java.lang.String getApplicationConnectionString()
getApplicationConnectionString

Throws:
RhapsodyRuntimeException

getApplicationName

void getApplicationName(java.lang.String applicationName,
                        java.lang.String productRCPName)
Get application name

Throws:
RhapsodyRuntimeException

getApplicationStatus

int getApplicationStatus()
getApplicationStatus

Throws:
RhapsodyRuntimeException

getBuildNo

java.lang.String getBuildNo()
get property BuildNo

Throws:
RhapsodyRuntimeException

getCodeGenSimplifiersRegistry

IRPCodeGenSimplifiersRegistry getCodeGenSimplifiersRegistry()
get the code generation simplifiers registry

Throws:
RhapsodyRuntimeException

getDMBoolProperty

int getDMBoolProperty(java.lang.String pKey)
Returns the value of the specified Design Manager boolean property

Parameters:
pKey - the name of the boolean property whose value should be returned
Returns:
the value of the specified Design Manager boolean property - 0 if the value of the property is False, 1 if the value of the property is True

getDMModelWorkspaceFolder

java.lang.String getDMModelWorkspaceFolder()
Returns the path of the workspace folder used for the DM model.

Returns:
the path of the workspace folder used for the DM model

getDMProperty

java.lang.String getDMProperty(java.lang.String pKey)
Returns the value of the specified Design Manager property

Parameters:
pKey - the name of the property whose value should be returned
Returns:
the value of the specified Design Manager property

getDiagSynthAPI

IRPDiagSynthAPI getDiagSynthAPI(java.lang.String clientName)
for internal use

Throws:
RhapsodyRuntimeException

getDiagramOfSelectedElement

IRPDiagram getDiagramOfSelectedElement()
get diagram of selected element

Throws:
RhapsodyRuntimeException

getErrorMessage

java.lang.String getErrorMessage()
Returns error message for last method called. If the last method completed successfully, then this method returns an empty string. To get the correct error message for a method, errorMessage() must be called immediately after the method is called.

Returns:
the error message for the last method called

getExecutableFolder

java.lang.String getExecutableFolder()
getExecutableFolder

Throws:
RhapsodyRuntimeException

getExternalCheckerRegistry

IRPExternalCheckRegistry getExternalCheckerRegistry()
get the External Checker registry

Throws:
RhapsodyRuntimeException

getExternalIDERegistry

IRPExternalIDERegistry getExternalIDERegistry(java.lang.String clientID)
get the External IDE registry

Throws:
RhapsodyRuntimeException

getExternalRoundtripInvoker

IRPExternalRoundtripInvoker getExternalRoundtripInvoker()
getExternalRoundtripInvoker

Throws:
RhapsodyRuntimeException

getIniFileParameterValue

java.lang.String getIniFileParameterValue(java.lang.String sectionName,
                                          java.lang.String paramName)
getIniFileParameterValue

Throws:
RhapsodyRuntimeException

getInterfaceName

java.lang.String getInterfaceName()
get property interfaceName

Throws:
RhapsodyRuntimeException

getIsHiddenUI

int getIsHiddenUI()
get property isHiddenUI

Throws:
RhapsodyRuntimeException

getIsLoadOnDemand

int getIsLoadOnDemand()
get property isLoadOnDemand

Throws:
RhapsodyRuntimeException

getLanguage

java.lang.String getLanguage()
get property Language

Throws:
RhapsodyRuntimeException

getListOfFactoryProperties

IRPCollection getListOfFactoryProperties()
get list of factory properties

Throws:
RhapsodyRuntimeException

getListOfSelectedElements

IRPCollection getListOfSelectedElements()
get list of selected elements

Throws:
RhapsodyRuntimeException

getListOfSiteProperties

IRPCollection getListOfSiteProperties()
get list of site properties

Throws:
RhapsodyRuntimeException

getLocaleName

java.lang.String getLocaleName()
Returns the locale for the version of Rhapsody running.

Returns:
the locale of the version of Rhapsody running, for example, EN for the English version or JA for the Japanese version

getModelElementFromSource

IRPModelElement getModelElementFromSource(java.lang.String sourceData,
                                          int isSourceDataIsfileName,
                                          int lineNumber)
Find model element from source code

Throws:
RhapsodyRuntimeException

getOMROOT

java.lang.String getOMROOT()
get property OMROOT

Throws:
RhapsodyRuntimeException

getOWPaneMgr

IRPowPaneMgr getOWPaneMgr(java.lang.String clientID)
For internal use only.


getOutputWindowText

java.lang.String getOutputWindowText()
Returns the text displayed in the output window.

Returns:
the text displayed in the output window

getProjects

IRPCollection getProjects()
get property projects

Throws:
RhapsodyRuntimeException

getRhapsodyHandleErrorFunction

long getRhapsodyHandleErrorFunction()
getRhapsodyHandleErrorFunction

Throws:
RhapsodyRuntimeException

getRhapsodyHandleErrorFunctionLong

long getRhapsodyHandleErrorFunctionLong()
getRhapsodyHandleErrorFunctionLong

Throws:
RhapsodyRuntimeException

getSearchManager

IRPSearchManager getSearchManager()
get Rhapsody search manager

Throws:
RhapsodyRuntimeException

getSelectedElement

IRPModelElement getSelectedElement()
get selected element

Throws:
RhapsodyRuntimeException

getSelectedGraphElements

IRPCollection getSelectedGraphElements()
get selected graph elements

Throws:
RhapsodyRuntimeException

getSelection

IRPSelection getSelection()
Get Selection Interface

Throws:
RhapsodyRuntimeException

getSerialNo

java.lang.String getSerialNo()
get property SerialNo

Throws:
RhapsodyRuntimeException

getTheCodeGeneratorInterface

IRPCodeGenerator getTheCodeGeneratorInterface()
get codegeneration interface

Throws:
RhapsodyRuntimeException

getTheExternalCodeGeneratorInvoker

IRPExternalCodeGeneratorInvoker getTheExternalCodeGeneratorInvoker()
get external code generator invoker

Throws:
RhapsodyRuntimeException

getTheIntegratorInterface

IRPIntegrator getTheIntegratorInterface()
get integrator interface

Throws:
RhapsodyRuntimeException

getTheJavaPluginsInterface

IRPJavaPlugins getTheJavaPluginsInterface()
getTheJavaPluginsInterface

Throws:
RhapsodyRuntimeException

getTheRoundtripInterface

IRPRoundTrip getTheRoundtripInterface()
get roundtrip interface

Throws:
RhapsodyRuntimeException

getToolSet

java.lang.String getToolSet()
get property ToolSet

Throws:
RhapsodyRuntimeException

highLightElement

void highLightElement(IRPModelElement val)
highlight element

Throws:
RhapsodyRuntimeException

highlightByHandle

void highlightByHandle(java.lang.String strHandle)
highlight by handle

Throws:
RhapsodyRuntimeException

importClasses

void importClasses()
import Classes

Throws:
RhapsodyRuntimeException

importSyncSimulinkBlock2

void importSyncSimulinkBlock2(IRPModelElement simulinkBlock,
                              java.lang.String matlabExePath,
                              java.lang.String simMdlFile,
                              java.lang.String simSrcFiles,
                              java.lang.String sampleTime)
Imports a Simulink model into a Rhapsody model.

Parameters:
simulinkBlock - the SimulinkBlock element that you created in your model (Object with SimulinkBlock stereotype applied to it)
matlabExePath - the full path to the Matlab executable
simMdlFile - the full path to the Simulink model file
simSrcFiles - the full path for each of the .cpp files generated for the Simulink model (except for ert_main.cpp). If there is one then more source file, the paths should be separated by a semi-colon.
sampleTime - the interval (in milliseconds) at which Rational Rhapsody should activate the Simulink engine

importTlb

void importTlb(java.lang.String pPath)
import tlb

Throws:
RhapsodyRuntimeException

insertProject

IRPProject insertProject(java.lang.String filename)
Insert existing project into current workspace

Throws:
RhapsodyRuntimeException

insertProjectFromDesignManager

IRPProject insertProjectFromDesignManager(java.lang.String userName,
                                          java.lang.String passwd,
                                          java.lang.String serverURL,
                                          java.lang.String projectAreaName,
                                          java.lang.String streamName,
                                          java.lang.String modelName)
insertProjectFromDesignManager

Throws:
RhapsodyRuntimeException

invokePluginsMethod

void invokePluginsMethod(java.lang.String methodName)
invoke Plugins Method

Throws:
RhapsodyRuntimeException

invokeRPE

void invokeRPE()
Opens the IBM Rational Rhapsody Report Generator wizard.


isRhapsodyCL

int isRhapsodyCL()
Is RhapsodyCL

Throws:
RhapsodyRuntimeException

isRhapsodyFileType

int isRhapsodyFileType(java.lang.String extension)
Check if specified extension corresponds to any Rhapsody unit type

Throws:
RhapsodyRuntimeException

loginToDesignManagerWithAlias

int loginToDesignManagerWithAlias(java.lang.String serverURL,
                                  java.lang.String alias)
loginToDesignManagerWithAlias

Throws:
RhapsodyRuntimeException

loginToDesignManagerWithCertificate

int loginToDesignManagerWithCertificate(java.lang.String serverURL,
                                        java.lang.String certificateLocation,
                                        java.lang.String password)
loginToDesignManagerWithCertificate

Throws:
RhapsodyRuntimeException

loginToDesignManagerWithUsername

int loginToDesignManagerWithUsername(java.lang.String serverURL,
                                     java.lang.String userName,
                                     java.lang.String password)
loginToDesignManagerWithUsername

Throws:
RhapsodyRuntimeException

make

void make()
make

Throws:
RhapsodyRuntimeException

mergeElements

void mergeElements(IRPModelElement left,
                   IRPModelElement right)
mergeElements

Throws:
RhapsodyRuntimeException

newProjectOnDesignManager

IRPProject newProjectOnDesignManager(java.lang.String userName,
                                     java.lang.String password,
                                     java.lang.String serverURL,
                                     java.lang.String projectAreaName,
                                     java.lang.String streamName,
                                     java.lang.String modelName)
Creates a new project on the Design Manager server.

Parameters:
userName - the username to use to log in to the DM server
password - the password to use to log in to the DM server
serverURL - the URL of the DM server
projectAreaName - the project area where the project should be created
streamName - the stream in which the project should be created
modelName - the name to use for the project
Returns:
the project that was created

notifyFileChanged

void notifyFileChanged(java.lang.String filename,
                       int contentChanged)
File change notification

Throws:
RhapsodyRuntimeException

openAdvancedSearchAndReplaceDialog

void openAdvancedSearchAndReplaceDialog()
Open Advanced Search and Replace dialog

Throws:
RhapsodyRuntimeException

openFileList

void openFileList(java.lang.String filename)
method openFileList

Throws:
RhapsodyRuntimeException

openProject

IRPProject openProject(java.lang.String filename)
Opens an existing Rhapsody project

Parameters:
filename - the name of the .rpy file, including the full path, for example, "l:\\temp\\_sample_code\\Class_Tricks.rpy"
Returns:
IRPProject object that represents the Rhapsody project

openProjectFromDesignManager

IRPProject openProjectFromDesignManager(java.lang.String userName,
                                        java.lang.String password,
                                        java.lang.String serverURL,
                                        java.lang.String projectAreaName,
                                        java.lang.String streamName,
                                        java.lang.String modelName)
openProjectFromDesignManager

Throws:
RhapsodyRuntimeException

openProjectFromDesignManagerAfterLogin

IRPProject openProjectFromDesignManagerAfterLogin(java.lang.String serverURL,
                                                  java.lang.String projectAreaName,
                                                  java.lang.String streamName,
                                                  java.lang.String modelName)
openProjectFromDesignManagerAfterLogin

Throws:
RhapsodyRuntimeException

openProjectFromURL

void openProjectFromURL(java.lang.String purl)
open Project From URL

Throws:
RhapsodyRuntimeException

openProjectWithLastSession

IRPProject openProjectWithLastSession(java.lang.String filename)
open project with last session

Throws:
RhapsodyRuntimeException

openProjectWithoutSubUnits

IRPProject openProjectWithoutSubUnits(java.lang.String filename)
open project without subunits

Throws:
RhapsodyRuntimeException

quit

void quit()
quit application

Throws:
RhapsodyRuntimeException

rebuild

void rebuild()
rebuild

Throws:
RhapsodyRuntimeException

rebuildEntireProject

void rebuildEntireProject()
rebuildEntireProject

Throws:
RhapsodyRuntimeException

rebuildWithDependencies

void rebuildWithDependencies()
rebuildWithDependencies

Throws:
RhapsodyRuntimeException

redo

int redo()
Perform Redo

Throws:
RhapsodyRuntimeException

refactorSelectedOperation

void refactorSelectedOperation(java.lang.String newName)
Changes the name of the currently-selected operation and updates any references to the operation accordingly. Corresponds to the Refactor option in the pop-up menu for operations.

Parameters:
newName - the new name to use for the operation

refreshAllViews

void refreshAllViews()
refresh all views

Throws:
RhapsodyRuntimeException

regenerate

void regenerate()
regenerate

Throws:
RhapsodyRuntimeException

regenerateElements

void regenerateElements(IRPCollection elements)
method regenerateElements

Throws:
RhapsodyRuntimeException

regenerateEntireProject

void regenerateEntireProject()
regenerateEntireProject

Throws:
RhapsodyRuntimeException

regenerateWithDependencies

void regenerateWithDependencies()
regenerateWithDependencies

Throws:
RhapsodyRuntimeException

registerCOMClient

void registerCOMClient(int processID,
                       java.lang.String clientFilename,
                       int magicNumber)
register COM client

Throws:
RhapsodyRuntimeException

report

void report(java.lang.String format,
            java.lang.String outputFileName)
report

Throws:
RhapsodyRuntimeException

roundtrip

void roundtrip()
roundtrip

Throws:
RhapsodyRuntimeException

roundtripElements

void roundtripElements(IRPCollection elements)
method roundtripElements

Throws:
RhapsodyRuntimeException

runApplication

void runApplication()
Runs the application that was built for the project


runHelper

void runHelper(java.lang.String helperName)
runHelper

Throws:
RhapsodyRuntimeException

runHelperWithParameters

void runHelperWithParameters(java.lang.String helperName,
                             java.lang.String params)
runHelperWithParameters

Throws:
RhapsodyRuntimeException

saveAll

void saveAll()
method saveAll

Throws:
RhapsodyRuntimeException

selectGraphElements

void selectGraphElements(IRPCollection graphElements)
Selects multiple elements in the most recently opened diagram.

Parameters:
graphElements - collection of the graphical elements that should be selected

selectModelElements

void selectModelElements(IRPCollection modelElements)
Selects multiple items in the model browser.

Parameters:
modelElements - collection of the model elements that should be selected

setApplicationStatus

void setApplicationStatus(int nStatus)
setApplicationStatus

Throws:
RhapsodyRuntimeException

setComponent

void setComponent(java.lang.String component)
set Component

Throws:
RhapsodyRuntimeException

setConfiguration

void setConfiguration(java.lang.String configuration)
set Configuration

Throws:
RhapsodyRuntimeException

setDMBoolProperty

void setDMBoolProperty(java.lang.String pKey,
                       int val)
Sets the value of the specified boolean Design Manager property

Parameters:
pKey - the name of the boolean property whose value should be set
val - the value to use for the property - use 0 for False, 1 for True

setDMProperty

void setDMProperty(java.lang.String pKey,
                   java.lang.String val)
Sets the value of the specified Design Manager property

Parameters:
pKey - the name of the property whose value should be set
val - the value to use for the property

setHiddenUI

void setHiddenUI(boolean pVal)
set property hiddenUI

Throws:
RhapsodyRuntimeException

setIsLoadOnDemand

void setIsLoadOnDemand(int isLoadOnDemand)
set property isLoadOnDemand

Throws:
RhapsodyRuntimeException

setLanguage

void setLanguage(java.lang.String language)
set property Language

Throws:
RhapsodyRuntimeException

setLog

void setLog(java.lang.String logFile)
set log file

Throws:
RhapsodyRuntimeException

setToolSet

void setToolSet(java.lang.String toolSet)
set property ToolSet

Throws:
RhapsodyRuntimeException

setUpdateRecentFileList

void setUpdateRecentFileList(int shouldUpdate)
setUpdateRecentFileList

Throws:
RhapsodyRuntimeException

startUndoTransaction

void startUndoTransaction()
start undo transaction

Throws:
RhapsodyRuntimeException

syncBuild

void syncBuild()
syncBuild

Throws:
RhapsodyRuntimeException

terminateApplication

void terminateApplication()
Terminate the Application

Throws:
RhapsodyRuntimeException

undo

int undo()
Perform Undo

Throws:
RhapsodyRuntimeException

unloadFromTarget

void unloadFromTarget()
unloadFromTarget

Throws:
RhapsodyRuntimeException

unregisterCOMClient

void unregisterCOMClient(int processID,
                         java.lang.String clientFilename,
                         int magicNumber)
unregister COM client

Throws:
RhapsodyRuntimeException

version

java.lang.String version()
Get Rhapsody version

Throws:
RhapsodyRuntimeException

versionNumberLong

java.lang.String versionNumberLong()
Get Rhapsody versionNumberLong

Throws:
RhapsodyRuntimeException

writeToOutputWindow

void writeToOutputWindow(java.lang.String title,
                         java.lang.String outputStr)
Writes text to Rhapsody's Output window.

Parameters:
title - the name of the tab to which the text should be written. The possible values are Log, Build, Configuration Management, Animation.
outputStr - the text to display in the Output window