Main Content

matlab.project.Project

プロジェクト オブジェクト

このページをすべて展開する

説明

matlab.project.Project オブジェクトは、現在読み込まれているプロジェクトを表します。このプロジェクト オブジェクトを使用して、プログラムによるプロジェクトの操作、ソース管理の操作、およびファイルの依存関係の特定を行います。

作成

matlab.project.Project オブジェクトを作成するには、関数 currentProject を使用して現在開かれているプロジェクトを取得します。以下に例を示します。

proj = currentProject;
現在開かれているプロジェクトがない場合は、関数 openProject を使用して既存のプロジェクトを読み込みます。以下に例を示します。
proj = openProject("C:/workSpace/project1/");
空のプロジェクトを作成して開き、プロジェクト オブジェクトを取得するには、関数 matlab.project.createProject を使用します。以下に例を示します。
proj = matlab.project.createProject;

プロパティ

すべて展開する

プロジェクト名。string スカラーとして指定します。

プロジェクトの説明。string スカラーとして指定します。

プロジェクトのルート フォルダーのパス。string スカラーとして指定します。

このプロパティは読み取り専用です。

最上位のステータス。プロジェクトが最上位プロジェクトの場合は、logical 1 (true) として返されます。

このプロパティは読み取り専用です。

プロジェクトのアクセス許可のステータス。オブジェクトの追加関数、削除関数、および作成関数の使用時にプロジェクトのアクセス許可が制限されている場合は、logical 1 (true) として返されます。参照プロジェクトのステータスは、変更を防ぐために常に読み取り専用となっています。

プロジェクト定義ファイルのタイプ。DefinitionFilesType オブジェクトの配列として指定します。現在のプロジェクト定義ファイルのタイプをプログラムで変更するには、matlab.project.convertDefinitionFiles を使用します。

このプロパティは読み取り専用です。

ソース管理情報。string 配列として指定します。

例: "Branch status: Normal" "No remote tracking branch" "Current branch: main"

このプロパティは読み取り専用です。

プロジェクト リポジトリの場所。string スカラーとして指定します。

このプロパティは読み取り専用です。

ソース管理の統合タイプ。string スカラーとして指定します。

例: "Git"

プロジェクト ファイルのパス。ProjectFile オブジェクトの配列として指定します。このプロパティは、プロジェクト ファイルの追加時または削除時に変更されます。プロジェクト ファイルを追加または削除するには、addFile、addFolderIncludingChildFiles または removeFile を使用できます。

プロジェクトのショートカット ファイル。Shortcut オブジェクトの配列として指定します。このプロパティは、ショートカット ファイルの追加時または削除時に変更されます。ショートカット ファイルをプログラムで作成または削除するには、addShortcut と removeShortcut を使用できます。

プロジェクトのラベル カテゴリ。Category オブジェクトの配列として指定します。このプロパティは、ラベル カテゴリの作成時または削除時に変更されます。ラベル カテゴリをプログラムで作成および削除するには、createCategory と removeCategory を使用できます。

プロジェクト ファイル間の依存関係のグラフ。digraph オブジェクトとして指定します。

プロジェクトの起動ファイル。string 配列として指定します。このプロパティは、起動ファイルの追加時または削除時に変更されます。起動ファイルをプログラムで追加または削除するには、addStartupFile と removeStartupFile を使用できます。

プロジェクトのシャットダウン ファイル。string 配列として指定します。このプロパティは、シャットダウン ファイルの追加時または削除時に変更されます。シャットダウン ファイルをプログラムで追加または削除するには、addShutdownFile と removeShutdownFile を使用できます。

MATLAB® パスに追加されるプロジェクト パス フォルダー。PathFolder オブジェクトの配列として指定します。

参照プロジェクトのパス。ProjectReference オブジェクトの配列として指定します。このプロパティは、参照プロジェクトの追加時または削除時に変更されます。参照プロジェクトをプログラムで追加または削除するには、addReference と removeReference を使用できます。

プロジェクトの起動フォルダーのパス。string スカラーとして指定します。

Simulink® キャッシュ フォルダーのパス。string スカラーとして指定します。

Simulink Coder™ コード生成フォルダーのパス。string スカラーとして指定します。

依存関係の分析のキャッシュ ファイルのパス。string スカラーとして指定します。

オブジェクト関数

すべて展開する

currentProject現在のプロジェクトを取得
openProject既存のプロジェクトの読み込み
isLoadedプロジェクトが読み込まれているかどうかを確認する
reloadプロジェクトの再読み込み
closeプロジェクトを閉じる
exportプロジェクトをアーカイブにエクスポート
matlab.project.createProject空のプロジェクトを作成
matlab.project.convertDefinitionFilesプロジェクトの定義ファイルのタイプを変更
matlab.project.deleteProjectフォルダーの管理を停止してプロジェクト定義ファイルを削除
matlab.project.loadProjectプロジェクトの読み込み
matlab.project.rootProjectルート プロジェクトの取得
addFileファイルまたはフォルダーをプロジェクトに追加
addFolderIncludingChildFilesフォルダーと子ファイルをプロジェクトに追加
removeFileファイルまたはフォルダーをプロジェクトから削除
addPathフォルダーをプロジェクト パスに追加
removePathプロジェクト パスからフォルダーを削除する
addReference参照プロジェクトをプロジェクトに追加
listAllProjectReferencesList all projects in reference hierarchy of current project
removeReferenceプロジェクト参照の削除
addStartupFileプロジェクトに起動ファイルを追加
addShutdownFileシャットダウン ファイルをプロジェクトに追加
removeStartupFileプロジェクトの起動リストから起動ファイルを削除する
removeShutdownFileプロジェクトのシャットダウン リストからシャットダウン ファイルを削除する
addShortcutショートカットをプロジェクトに追加
removeShortcutショートカットをプロジェクトから削除する
addLabelプロジェクト ファイルにラベルを追加
createLabelプロジェクト ラベルを作成
removeLabelプロジェクトからラベルを削除する
findLabelプロジェクト ファイルのラベルを取得する
createCategoryプロジェクト ラベルのカテゴリを作成
findCategoryラベルのプロジェクト カテゴリの検索
removeCategoryラベルのプロジェクト カテゴリの削除
findFile名前によるプロジェクト ファイルの検索
listModifiedFilesプロジェクトの変更済みファイルのリスト
listRequiredFiles指定したプロジェクト ファイルで必要なファイルの取得
listImpactedFiles指定したプロジェクト ファイルへの変更によって影響を受けるファイルの取得
listAllProjectReferencesList all projects in reference hierarchy of current project
refreshSourceControlプロジェクト ファイルのソース管理ステータスの更新
runChecksすべてのプロジェクト チェックを実行します
updateDependenciesプロジェクトの依存関係の更新
matlab.project.isUnderProjectRootDetermine whether file or folder is under project root folder
matlab.project.isFileInProjectDetermine whether file or folder belongs to project

例

すべて折りたたむ

プロジェクト Times Table App を開き、プログラムで操作できるプロジェクト オブジェクトを currentProject を使用して取得します。

openExample("matlab/TimesTableProjectExample")
proj = currentProject
proj = 

  Project with properties:

                        Name: "Times Table App"
    SourceControlIntegration: "Git"
          RepositoryLocation: "C:\workSpace\examples\repositories\TimesTableApp"
       SourceControlMessages: ["Branch status: Normal"    "Current branch: main"    "No remote tracking branch"]
                    ReadOnly: 0
                    TopLevel: 1
                Dependencies: [1×1 digraph]
                  Categories: [1×1 matlab.project.Category]
                       Files: [1×15 matlab.project.ProjectFile]
                   Shortcuts: [1×4 matlab.project.Shortcut]
                 ProjectPath: [1×3 matlab.project.PathFolder]
           ProjectReferences: [1×0 matlab.project.ProjectReference]
                StartupFiles: [1×0 string]
               ShutdownFiles: [1×0 string]
         DefinitionFilesType: FixedPathMultiFile
                 Description: "This example project contains the source code and tests for a simple educational app. ↵↵Use the "Project Shortcuts" toolstrip tab to find ways of getting started with this project."
                  RootFolder: "C:\workSpace\examples\TimesTableApp"
        ProjectStartupFolder: "C:\workSpace\examples\TimesTableApp"
         DependencyCacheFile: ""
       SimulinkCodeGenFolder: ""
         SimulinkCacheFolder: ""

プロジェクト Times Table App を開き、プロジェクト オブジェクトを作成します。

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

プロジェクト オブジェクトに対して実行できる関数を検索します。

methods(proj)

Methods for class matlab.project.Project:

addFile                       export                        removeCategory                
addFolderIncludingChildFiles  findCategory                  removeFile                    
addPath                       findFile                      removePath                    
addReference                  isLoaded                      removeReference               
addShortcut                   listAllProjectReferences      removeShortcut                
addShutdownFile               listImpactedFiles             removeShutdownFile            
addStartupFile                listModifiedFiles             removeStartupFile             
addprop                       listRequiredFiles             runChecks                     
close                         refreshSourceControl          updateDependencies            
createCategory                reload                        

Methods of matlab.project.Project inherited from handle.

プロジェクト オブジェクトを取得し、そのプロパティを確認します。

プロジェクト Times Table App を開きます。currentProject を使用して、現在読み込まれているプロジェクトからプロジェクト オブジェクトを作成します。

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

プロジェクト ファイルを確認します。

files = proj.Files

files = 

  1×14 ProjectFile array with properties:

    Path
    Labels
    Revision
    SourceControlStatus

13 番目のファイルのラベルを調べます。

proj.Files(13).Labels

ans = 

  Label with properties:

            File: "C:\workSpace\examples\TimesTableApp\utilities\runTheseTests.m"
        DataType: 'none'
            Data: []
            Name: "Design"
    CategoryName: "Classification"

名前を指定して、特定のファイルを取得します。

myfile = findFile(proj,"source/timesTableGame.m")
myfile = 

  ProjectFile with properties:

                   Path: "C:\workSpace\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×1 matlab.project.Label]
               Revision: ""
    SourceControlStatus: Unmodified

ファイルで何ができるか調べます。

methods(myfile)

Methods for class matlab.project.ProjectFile:

addLabel     findLabel    removeLabel

バージョン履歴

R2019a で導入

参考

|

トピック