公開メンバ関数 | 全メンバ一覧
MaterialLibrary クラス

MaterialLibrary クラスは 材料データベースの操作に使用します
Application クラスから呼び出すことができます。
. [詳解]

公開メンバ関数

void AddBookmark (Variant &val)
 材料をブックマークへ追加します。 [詳解]
 
MaterialObjectCopyMaterial (Variant &val)
 材料をコピーします。 [詳解]
 
MaterialObjectCopyMaterialByObject (MaterialObject *original)
 MaterialObject から材料をコピーします。 [詳解]
 
MaterialObjectCreateCustomMaterial (String &name, String &libPath=String())
 カスタム材料を作成します。 [詳解]
 
void CreateNewFolder (String &name, String &libPath)
 材料のフォルダを作成します。 [詳解]
 
MaterialObjectCreateUserMagnet (String &name, String &jcfpath, String &libPath=String())
 ユーザー磁石を作成します。 [詳解]
 
void DeleteCustomMaterial (Variant &val, String &libPath=String())
 名前またはインデックスを指定して、そのカスタム材料を削除します。 [詳解]
 
void DeleteCustomMaterialByObject (MaterialObject *object)
 MaterialObject オブジェクトを指定して、カスタム材料を削除します。 [詳解]
 
void DeleteFolder (String &libPath)
 指定したフォルダを削除します。 [詳解]
 
void ExportAllMaterialXML (String &filename)
 XMLファイルに全カスタム材料データをエクスポートします。 [詳解]
 
void ExportFolderMaterialXML (String &filename, String &libPath)
 指定したフォルダ内の全カスタム材料データをXMLファイルにエクスポートします。 [詳解]
 
void ExportMaterialXML (String &filename, Variant &val, bool forceConfidential=false)
 XMLファイルに指定したカスタム材料データをエクスポートします。 [詳解]
 
MaterialObjectGetCustomMaterial (Variant &val, String &libPath=String())
 カスタム材料を取得します。 [詳解]
 
String GetFolderName (int folderIndex, String &libPath=String())
 指定したフォルダの名前を取得します。 [詳解]
 
String GetFolderPath (int folderIndex, String &libPath=String())
 指定したフォルダのパスを取得します。 [詳解]
 
MaterialObjectGetMaterial (Variant &val)
 材料を取得します。 [詳解]
 
MaterialGetUserMaterial (Variant &val)
 名称を指定して、カスタム材料のプロパティを取得します。 [詳解]
 
void ImportMaterial (String &filename)
 JMAG-Studioやその他のプログラムで作成された材料をインポートします。 [詳解]
 
void ImportMaterialXML (String &filename)
 XMLファイルからカスタム材料データをインポートします。 [詳解]
 
void ImportStudioMaterial ()
 JMAG-Studioで作成した材料をJMAG-Designerに一括でインポートします。
 
bool IsSingleton ()
 これは内部関数であるため、正式にサポートしていません。 [詳解]
 
bool IsValid ()
 オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
 
void MoveMaterial (Variant &val, String &libPath)
 カスタム材料またはユーザー着磁材料を別のフォルダに移動します。 [詳解]
 
int NumCustomMaterials (String &libPath=String())
 カスタム材料の数を取得します。 [詳解]
 
int NumFolders (String &libPath=String())
 指定したフォルダ下のフォルダ数を取得します。 [詳解]
 
int NumMaterials ()
 材料の総数を取得します。 [詳解]
 
void RemoveBookmark (Variant &val)
 材料をブックマークから削除します。 [詳解]
 
void RenameFolder (String &oldPath, String &newName)
 指定したフォルダの名称を変更します。 [詳解]
 
void SynchronizeMaterial ()
 カスタム材料を同期します。
 

詳解

MaterialLibrary クラスは 材料データベースの操作に使用します
Application クラスから呼び出すことができます。
.

このクラスのオブジェクトを取得する例:

app.GetMaterialLibrary()

関数詳解

void MaterialLibrary::AddBookmark ( Variant &  val)

材料をブックマークへ追加します。

引数
val材料の名称またはインデックス
MaterialObject * MaterialLibrary::CopyMaterial ( Variant &  val)

材料をコピーします。

引数
valコピー元の材料名
戻り値
MaterialObject オブジェクト
MaterialObject * MaterialLibrary::CopyMaterialByObject ( MaterialObject original)

MaterialObject から材料をコピーします。

引数
originalMaterialObject オブジェクト
戻り値
MaterialObject オブジェクト
MaterialObject * MaterialLibrary::CreateCustomMaterial ( String &  name,
String &  libPath = String() 
)

カスタム材料を作成します。

引数
name材料名
libPath[カスタム材料]フォルダ内でのパス(省略可)
戻り値
MaterialObject オブジェクト
void MaterialLibrary::CreateNewFolder ( String &  name,
String &  libPath 
)

材料のフォルダを作成します。

引数
nameフォルダ名
libPathフォルダのパス([カスタム材料]フォルダ内または[ユーザー着磁]フォルダ内)
MaterialObject * MaterialLibrary::CreateUserMagnet ( String &  name,
String &  jcfpath,
String &  libPath = String() 
)

ユーザー磁石を作成します。

引数
name材料名
jcfpathJCFファイルパス
libPath[ユーザー着磁]フォルダ内でのパス(省略可)
戻り値
MaterialObject オブジェクト
void MaterialLibrary::DeleteCustomMaterial ( Variant &  val,
String &  libPath = String() 
)

名前またはインデックスを指定して、そのカスタム材料を削除します。

引数
val材料の名称またはインデックス
libPath[カスタム材料]フォルダ内でのパス(省略可)
void MaterialLibrary::DeleteCustomMaterialByObject ( MaterialObject object)

MaterialObject オブジェクトを指定して、カスタム材料を削除します。

引数
objectMaterialObject オブジェクト
void MaterialLibrary::DeleteFolder ( String &  libPath)

指定したフォルダを削除します。

引数
libPathフォルダのパス([カスタム材料]フォルダ内または[ユーザー着磁]フォルダ内)
void MaterialLibrary::ExportAllMaterialXML ( String &  filename)

XMLファイルに全カスタム材料データをエクスポートします。

引数
filenameファイルパス
void MaterialLibrary::ExportFolderMaterialXML ( String &  filename,
String &  libPath 
)

指定したフォルダ内の全カスタム材料データをXMLファイルにエクスポートします。

引数
filenameファイルパス
libPath[カスタム材料]フォルダ内でのパス
void MaterialLibrary::ExportMaterialXML ( String &  filename,
Variant &  val,
bool  forceConfidential = false 
)

XMLファイルに指定したカスタム材料データをエクスポートします。

引数
filenameファイルパス
val材料名
MaterialObject * MaterialLibrary::GetCustomMaterial ( Variant &  val,
String &  libPath = String() 
)

カスタム材料を取得します。

引数
val材料の名称またはインデックス
libPath[カスタム材料]フォルダ内でのパス(省略可)
戻り値
MaterialObject オブジェクト
String MaterialLibrary::GetFolderName ( int  folderIndex,
String &  libPath = String() 
)

指定したフォルダの名前を取得します。

引数
folderIndexフォルダのインデックス
libPathフォルダのパス([カスタム材料]フォルダ内または[ユーザー着磁]フォルダ内、省略可)
戻り値
フォルダ名
String MaterialLibrary::GetFolderPath ( int  folderIndex,
String &  libPath = String() 
)

指定したフォルダのパスを取得します。

引数
folderIndexフォルダのインデックス
libPathフォルダのパス([カスタム材料]フォルダ内または[ユーザー着磁]フォルダ内、省略可)
戻り値
フォルダパス
MaterialObject * MaterialLibrary::GetMaterial ( Variant &  val)

材料を取得します。

引数
val材料の名称またはインデックス
戻り値
MaterialObject オブジェクト
Material * MaterialLibrary::GetUserMaterial ( Variant &  val)

名称を指定して、カスタム材料のプロパティを取得します。

引数
val名前
戻り値
Material オブジェクト
void MaterialLibrary::ImportMaterial ( String &  filename)

JMAG-Studioやその他のプログラムで作成された材料をインポートします。

引数
filenameファイルパス 次のファイルのインポートに対応してます。
HBファイル(磁化特性)
HBPファイル(温度依存性および不可逆減磁特性)
HBSファイル(応力依存性磁化特性)
IRONファイル(鉄損特性)
IRONSファイル(応力依存性鉄損特性)
JCMファイル(材料特性(磁化特性、鉄損特性などを含む))
Textファイル(材料特性(磁化特性、鉄損特性などを含む))
void MaterialLibrary::ImportMaterialXML ( String &  filename)

XMLファイルからカスタム材料データをインポートします。

引数
filenameファイルパス
bool MaterialLibrary::IsSingleton ( )

これは内部関数であるため、正式にサポートしていません。

非推奨:
bool MaterialLibrary::IsValid ( )

オブジェクトが有効であるとき、戻り値として True を取得します。

戻り値
MaterialLibrary オブジェクトの有効・無効
void MaterialLibrary::MoveMaterial ( Variant &  val,
String &  libPath 
)

カスタム材料またはユーザー着磁材料を別のフォルダに移動します。

引数
val材料の名称またはインデックス
libPath移動先のフォルダパス
int MaterialLibrary::NumCustomMaterials ( String &  libPath = String())

カスタム材料の数を取得します。

引数
libPath[カスタム材料]フォルダ内でのパス(省略可)
戻り値
カスタム材料の数
int MaterialLibrary::NumFolders ( String &  libPath = String())

指定したフォルダ下のフォルダ数を取得します。

引数
libPathフォルダのパス([カスタム材料]フォルダ内または[ユーザー着磁]フォルダ内、省略可)
戻り値
フォルダ数
int MaterialLibrary::NumMaterials ( )

材料の総数を取得します。

戻り値
材料の総数
void MaterialLibrary::RemoveBookmark ( Variant &  val)

材料をブックマークから削除します。

引数
val材料の名称またはインデックス
void MaterialLibrary::RenameFolder ( String &  oldPath,
String &  newName 
)

指定したフォルダの名称を変更します。

引数
oldPathフォルダパス
newName新しいフォルダ名