Project tool

On this page

$project is a project reference enabling a template to return the project information.

$project.getName()

Returns a project name.

$project.getTitle()

Gets a project title.

$project.getFileName()

Gets a project filename.

$project.getExtension()

Gets a project filename extension.

$project.getDirectory()

Get 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.

$project.getDiagrams(type)

Returns existing diagrams of a given type stored in a particular project.

#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.

$project.getPresentationDiagrams(type)

Returns all existing presentation diagrams of a given type stored in a particular project.

#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.

$project.isDirty()

Returns true if that particular project was modified after it had been saved or loaded.

$project.getElementByID(id)

Returns an element with a given ID.

#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.

$project.getXmiVersion()

Returns the XMI version of a project.

$project.getVersion()

Return a project version number.

$project.getModel()

Returns a model (the root container of all model structures).

$project.getPrimaryModel()

Returns the primary (main) model of the project (not including the ones from modules (attached projects)).

$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)).

$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 Version

The 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:

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 Module

The 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:

#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