$project is a project reference enabling a template to return the project information. $project.getName()Returns a project name.
| Name | Type | Description |
---|
Parameter(s) | - | - | - | Return | - | java.lang.String | A project name. |
$project.getTitle()Gets a project title.
| Name | Type | Description |
---|
Parameter(s) | - | - | - | Return | - | java.lang.String | A project title. |
$project.getFileName()Gets a project filename.
| Name | Type | Description |
---|
Parameter(s) | - | - | - | Return | - | java.lang.String | A project filename. |
$project.getExtension()Gets a project filename extension. This function is only for local projects. |
| Name | Type | Description |
---|
Parameter(s) | - | - | - | Return | - | java.lang.String | A project filename extension. |
$project.getDirectory()Get a project directory name. This function is only for local projects. |
| Name | Type | Description |
---|
Parameter(s) | - | - | - | Return | - | java.lang.String | A project directory name. |
$project.getVersionList()Returns a list of version information from an open Server project. $project.getDiagrams()Returns all existing diagrams stored in a particular project, including diagrams in auxiliary resources.
| Name | Type | Description |
---|
Return | - | java.util.Collection | A collection of diagram instances. |
$project.getDiagrams() returns all the diagrams in the selected scope, including diagrams in auxiliary resources. |
$project.getDiagrams(type)Returns existing diagrams of a given type stored in a particular project.
| Name | Type | Description |
---|
Parameter(s) | type | java.lang.String | A diagram type. | Return | - | java.util.Collection | A collection of diagram instances. |
#set($classDiagram = $project.getDiagrams("Class Diagram"))
#foreach($cl in $classDiagram)
$cl.name
#end |
- “Class Diagram” is a diagram type.
$project.getPresentationDiagrams()Returns all existing presentation diagrams stored in a particular project.
| Name | Type | Description |
---|
Return | - | java.util.Collection | A collection of diagram views. |
$project.getPresentationDiagrams(type)Returns all existing presentation diagrams of a given type stored in a particular project.
| Name | Type | Description |
---|
Parameter(s) | type | java.lang.String | A diagram type. | Return | - | java.util.Collection | A collection of diagram views. |
#set($classDiagram = $project.getPresentationDiagrams("Class Diagram"))
#foreach($cl in $classDiagram)
$cl.name
#end |
- “Class Diagram” is a diagram type.
$project.isRemote()Returns the remote or non-remote state of a project.
| Name | Type | Description |
---|
Return | - | java.lang.Boolean | Return true if a project is a remote project, otherwise false. |
$project.isDirty()Returns true if that particular project was modified after it had been saved or loaded.
| Name | Type | Description |
---|
Return | - | java.lang.Boolean | Return true if a project was modified after it had been saved/loaded, otherwise false. |
$project.getElementByID(id)Returns an element with a given ID. | Name | Type | Description |
---|
Parameter(s) | ID | java.lang.String | An element ID. | Return | - | com.nomagic.magicdraw.uml.BaseElement | An element with a given ID or null if the element with such ID is not registered in the project. |
#set($ele = $project.getElementByID("_9_0_62a020a_1105704887361_983947_8206"))
$ele.name
$ele.humanType |
- “_9_0_62a020a_1105704887361_983947_8206” is the element’s ID number.
$project.getAllElementId()Returns a collection of all element IDs in a project.
| Name | Type | Description |
---|
Return | - | java.util.Collection | A collection of all element IDs in a project. |
$project.getXmiVersion()Returns the XMI version of a project.
| Name | Type | Description |
---|
Return | - | int | An XMI version. |
$project.getVersion()Return a project version number.
| Name | Type | Description |
---|
Return | - | long | A project version number. |
$project.getModel()Returns a model (the root container of all model structures).
| Name | Type | Description |
---|
Return | - | com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdmodels.Model | A model. |
$project.getModel() is deprecated since MagicDraw 18.2, please use $project.getPrimaryModel() instead |
$project.getPrimaryModel()Returns the primary (main) model of the project (not including the ones from modules (attached projects)).
| Name | Type | Description |
---|
Return | - | com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package | The primary model of the project. |
$project.getAllModels()Returns a list of models in the project (the primary model of the project and all the models of the modules(attached projects)).
| Name | Type | Description |
---|
Return | - | Java.util.List | A list of models. |
$project.getModuleList()Returns a list of used server and local modules from a current project. $project.getModuleList(includeAuxiliary)Returns a list of used server and local modules as well as auxiliary resources from a current project. $project.getSharedModule()Returns a list of shared modules from a current project. $project.getSharedModule(projectModule)Returns a list of shared modules from a specified project module. $project.getServerModule()Returns a list of used server modules. $project.getServerModule(includeAuxiliary)Returns a list of used server modules as well as auxiliary resources. $project.getLocalModule()Returns a list of used local modules. $project.getLocalModule(includeAuxiliary)Returns a list of used local modules as well as auxiliary resources. $project.getAuxiliaryResource()Returns a list of auxiliary resources.
Project VersionThe full class name is com.nomagic.magicdraw.magicreport.tools.ProjectVersion. ProjectVersion is a class that represents some version of the project or module. It contains date, user, number, etc. ProjectVersion contains the following properties:
Property | Return type | Description |
---|
comment | java.lang.String | Returns a version committed comment. | date | java.util.Date | Returns a committed date. | dateAsString | java.lang.String | Returns a committed date as text. | number | long | Returns a committed version. | numberAsString | java.lang.String | Returns a committed version as text. | user | java.lang.String | Returns a committer’s name. | version | java.lang.Object | Returns a version object com.nomagic.magicdraw.esi.project.project.IEsiVersionDescriptor for a Teamwork Cloud project. | tags | java.util.List<java.lang.String> | Returns all tags. |
Current version : $project.version
All version:
#foreach ($version in $project.getVersionList())
Date : $version.date
Number : $version.number
Number As String : $version.numberAsString
User : $version.user
Comment : $version.comment
Tags:
#foreach($tag in $version.tags)
- tag
#end
---
#end |
Project ModuleThe full class name is com.nomagic.magicdraw.magicreport.tools.ProjectModule. ProjectModule is a wrapper Class of an attached project (com.nomagic.ci.persistence.IAttachedProject) that represents a special kind of the project that is used as a component in the current project. The following are some properties and methods of ProjectModule:
Property / Method | Return type | Description |
---|
representationString | java.lang.String | Returns user-friendly representation string about the module. | description | java.lang.String | Returns project description of the module. | version | long | Returns a version number of the module. | remoteID | java.lang.String | Returns a remote ID for the module. | URI | java.net.URI | Converts EMF URI to java.net.URI. | versionList | java.util.List<ProjectVersion> | Returns a list of version descriptors of the module. | isRemote() | boolean | Checks if the module is remote - from Teamwork Cloud. |
#foreach($module in $project.getModuleList())
Name : $module.representationString
Description : $module.description
Version : $module.version
RemoteID : $module.remoteID
URI : $module.URI
#if($module.isRemote())
#set($version = $module.projectVersion)
Current module version :
date : $version.date
number : $version.number
numberAsString : $version.numberAsString
user : $version.user
comment : $version.comment
tags:
#foreach($tag in $version.tags)
- $tag
#end
All module versions :
#foreach($version in $module.versionList)
date : $version.date
number : $version.number
numberAsString : $version.numberAsString
user : $version.usercomment : $version.comment
tags:
#foreach($tag in $version.tags)
- $tag
#end
----------
#end
#end
Shared module:
#foreach ($child in $project.getSharedModule($module))
- $child.representationString
#end
#end |
|