|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPComponent
The IRPComponent interface represents a code generation component defined in a Rhapsody model.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement |
---|
IRPModelElement.OSLCLink |
Method Summary | |
---|---|
IRPConfiguration |
addConfiguration(java.lang.String name)
Adds a new configuration to the component. |
IRPFile |
addFile(java.lang.String name)
Adds a new File to the component. |
IRPFile |
addFolder(java.lang.String name)
Adds a new Folder to the component. |
IRPComponent |
addNestedComponent(java.lang.String name)
Adds a new nested component to the component. |
void |
addScopeElement(IRPModelElement pVal)
Adds the specified model element to the scope of the component. |
void |
addScopeElementWithoutAggregates(IRPModelElement pVal)
method addScopeElementWithoutAggregates |
void |
addToScope(IRPFile file,
IRPCollection classes,
IRPCollection packages)
method addToScope |
void |
allElementsInScope()
Adds all the elements in the model to the scope of the component. |
void |
deleteConfiguration(IRPConfiguration configuration)
Deletes the specified configuration. |
void |
deleteFile(IRPFile file)
Deletes the specified File. |
IRPConfiguration |
findConfiguration(java.lang.String name)
Returns the configuration with the specified name. |
java.lang.String |
getAdditionalSources()
Returns the additional sources defined for the component. |
java.lang.String |
getBuildType()
Returns the build type of the component - Library, Executable, or Analysis. |
IRPConfiguration |
getConfigByDependency(IRPDependency o)
method getConfigByDependency |
IRPCollection |
getConfigurations()
Returns a collection of all the configurations in the component. |
IRPFile |
getFile(IRPClassifier c,
int spec)
method getFile |
java.lang.String |
getFileName(IRPClassifier c,
int spec,
int withExt)
method getFileName |
IRPCollection |
getFiles()
Returns a collection of all the Files in the component. |
java.lang.String |
getIncludePath()
Returns the include path defined for the component. |
java.lang.String |
getLibraries()
get property libraries |
java.lang.String |
getModelElementFileName(IRPModelElement c,
int spec,
int withExt)
method getModelElementFileName |
IRPCollection |
getNestedComponents()
Returns a collection of all the nested components in the component. |
IRPFile |
getPackageFile(IRPPackage c,
int spec)
method getPackageFile |
IRPCollection |
getPanelDiagrams()
Returns a collection of all the panel diagrams in the component. |
java.lang.String |
getPath(int fullPath)
get property path |
IRPCollection |
getPossibleVariants(IRPModelElement variationPoint)
method getPossibleVariants |
int |
getScopeBySelectedElements()
Checks whether the scope of the component has been set to include all elements or only specific elements. |
IRPCollection |
getScopeElements()
Returns a collection of all the model elements in the scope of the component. |
IRPCollection |
getScopeElementsByCategory(java.lang.String category)
method getScopeElementsByCategory |
java.lang.String |
getStandardHeaders()
Returns the standard headers defined for the component. |
IRPModelElement |
getVariant(IRPModelElement variationPoint)
method getVariant |
IRPCollection |
getVariationPoints()
Returns a collection of the variation points that are included in the scope of the component. |
int |
isDirectoryPerModelComponent(IRPModelElement o)
method isDirectoryPerModelComponent |
void |
removeScopeElement(IRPModelElement pVal)
Removes the specified model element from the scope of the component. |
void |
setAdditionalSources(java.lang.String additionalSources)
Specifies the additional sources to use for the component. |
void |
setBuildType(java.lang.String buildType)
Specifies the build type for the component. |
void |
setIncludePath(java.lang.String includePath)
Specifies the include path to use for the component. |
void |
setLibraries(java.lang.String libraries)
set property libraries |
void |
setPath(java.lang.String path)
method setPath |
void |
setScopeBySelectedElements(int scopeBySelectedElements)
set toggle the scope between selected and all-elements |
void |
setStandardHeaders(java.lang.String standardHeaders)
Specifies the standard headers for the component. |
void |
setVariant(IRPModelElement variationPoint,
IRPModelElement pVariant)
method setVariant |
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit |
---|
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload |
Method Detail |
---|
IRPConfiguration addConfiguration(java.lang.String name)
name
- the name to use for the new configuration
IRPFile addFile(java.lang.String name)
name
- the name to use for the new File
IRPFile addFolder(java.lang.String name)
name
- the name to use for the new Folder
IRPComponent addNestedComponent(java.lang.String name)
name
- the name to use for the new component
void addScopeElement(IRPModelElement pVal)
pVal
- the model element that should be added to the scope of the componentvoid addScopeElementWithoutAggregates(IRPModelElement pVal)
RhapsodyRuntimeException
void addToScope(IRPFile file, IRPCollection classes, IRPCollection packages)
RhapsodyRuntimeException
void allElementsInScope()
void deleteConfiguration(IRPConfiguration configuration)
configuration
- the configuration that should be deletedvoid deleteFile(IRPFile file)
file
- the File that should be deletedIRPConfiguration findConfiguration(java.lang.String name)
name
- the name of the configuration to return
java.lang.String getAdditionalSources()
java.lang.String getBuildType()
IRPConfiguration getConfigByDependency(IRPDependency o)
RhapsodyRuntimeException
IRPCollection getConfigurations()
IRPFile getFile(IRPClassifier c, int spec)
RhapsodyRuntimeException
java.lang.String getFileName(IRPClassifier c, int spec, int withExt)
RhapsodyRuntimeException
IRPCollection getFiles()
java.lang.String getIncludePath()
java.lang.String getLibraries()
RhapsodyRuntimeException
java.lang.String getModelElementFileName(IRPModelElement c, int spec, int withExt)
RhapsodyRuntimeException
IRPCollection getNestedComponents()
IRPFile getPackageFile(IRPPackage c, int spec)
RhapsodyRuntimeException
IRPCollection getPanelDiagrams()
java.lang.String getPath(int fullPath)
RhapsodyRuntimeException
IRPCollection getPossibleVariants(IRPModelElement variationPoint)
RhapsodyRuntimeException
int getScopeBySelectedElements()
IRPCollection getScopeElements()
IRPCollection getScopeElementsByCategory(java.lang.String category)
RhapsodyRuntimeException
java.lang.String getStandardHeaders()
IRPModelElement getVariant(IRPModelElement variationPoint)
RhapsodyRuntimeException
IRPCollection getVariationPoints()
int isDirectoryPerModelComponent(IRPModelElement o)
RhapsodyRuntimeException
void removeScopeElement(IRPModelElement pVal)
pVal
- the model element that should be removed from the scope of the componentvoid setAdditionalSources(java.lang.String additionalSources)
additionalSources
- the additional sources to use for the componentvoid setBuildType(java.lang.String buildType)
buildType
- the build type that should be used for the component. The valid strings for this parameter are: Executable, Library, and Analysis.void setIncludePath(java.lang.String includePath)
includePath
- the include path to use for the componentvoid setLibraries(java.lang.String libraries)
RhapsodyRuntimeException
void setPath(java.lang.String path)
RhapsodyRuntimeException
void setScopeBySelectedElements(int scopeBySelectedElements)
RhapsodyRuntimeException
void setStandardHeaders(java.lang.String standardHeaders)
standardHeaders
- a string consisting of a comma-separated list of the files that should be used as standard headers for the componentvoid setVariant(IRPModelElement variationPoint, IRPModelElement pVariant)
RhapsodyRuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |