$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.
Name
Type
Description
Parameter(s)
-
-
-
Return
-
java.lang.String
A project filename extension.
$project.getDirectory()
Get a project directory name.
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.
Name
Type
Description
Return
-
java.util.List<ProjectVersion>
A list of com.nomagic.magicdraw.magicreport.tools.ProjectsVersion.
Info
title
Info
Version information consists of the following attributes:
comment: a version committed comment
date: a committed date
dateAsString: a committed date as text
number: a committed version
numberAsString: a committed version as text
user: a committer’s name
version: a version object that can be com.nomagic.teamwork.common.projects.Version for Teamwork project or com.nomagic.magicdraw.esi.project.project.IEsiVersionDescriptor for Teamwork Cloud project.
Following is the sample code.
Code Block
language
text
Current version : $project.version
All version:
----------------
#foreach ($version in $project.versionList)
Date : $version.date
Number : $version.number
Number as String : $version.numberAsString
User : $version.user
Comment : $version.comment
----------------
#end
$project.getType()
Returns a file type. A file type is one of the following values:
0 – UNDEF
2 – XML_NATIVE
3 – UNSIYS_XMI
Name
Type
Description
Return
-
int
The value of a file type.
$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.
Note
title
Note
$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.
Code Block
language
text
title
Sample code
#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.
Code Block
language
text
title
Sample code
#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.