System Explorer - Material Catalogs Data. This interface can be accessed via the ISystemData interface. More...

Public Member Functions
string[]	GetCatalogsInUse ()

string[]	GetAvailableCatalogs ()

string[]	GetMaterialsInCatalog (string catalog)

bool	IsCatalogInUse (string catalog)

bool	RemoveCatalog (string catalog)
	Removes the specified material catalog from the system.

bool	AddCatalog (string catalog)
	Adds the specified material to the system.

Detailed Description

System Explorer - Material Catalogs Data. This interface can be accessed via the ISystemData interface.

Examples: CSharpStandalone_12_Seq_SystemExplorer.cs.

Member Function Documentation

◆ AddCatalog()

bool ZOSAPI.SystemData.ISDMaterialCatalogData.AddCatalog ( string catalog )

Adds the specified material to the system.

Usage (see Example 12 for a full sample)

C#

            // Add Corning catalog and remove Schott catalog
            ZOSAPI.SystemData.ISDMaterialCatalogData sysCat = TheSystem.SystemData.MaterialCatalogs;
            sysCat.AddCatalog("Corning");
            sysCat.RemoveCatalog("Schott");

C++

    // Add Corning catalog and remove Schott catalog
    ZOSAPI_Interfaces::ISDMaterialCatalogDataPtr sysCat = TheSystem->SystemData->MaterialCatalogs;
    sysCat->AddCatalog("Corning");
    sysCat->RemoveCatalog("Schott");

Matlab

    % Add Corning catalog and remove Schott catalog
    sysCat = TheSystem.SystemData.MaterialCatalogs;
    sysCat.AddCatalog('Corning');
    sysCat.RemoveCatalog('Schott');

Python

    # Add Corning Catalog and remove Schott Catalog
    sysCat = TheSystem.SystemData.MaterialCatalogs
    sysCat.AddCatalog("Corning")
    sysCat.RemoveCatalog("Schott")

Parameters

catalog The material catalog to add.

Returns

Examples: CSharpStandalone_12_Seq_SystemExplorer.cs.

◆ GetAvailableCatalogs()

string[] ZOSAPI.SystemData.ISDMaterialCatalogData.GetAvailableCatalogs ( )

◆ GetCatalogsInUse()

string[] ZOSAPI.SystemData.ISDMaterialCatalogData.GetCatalogsInUse ( )

◆ GetMaterialsInCatalog()

string[] ZOSAPI.SystemData.ISDMaterialCatalogData.GetMaterialsInCatalog ( string catalog )

◆ IsCatalogInUse()

bool ZOSAPI.SystemData.ISDMaterialCatalogData.IsCatalogInUse ( string catalog )

◆ RemoveCatalog()

bool ZOSAPI.SystemData.ISDMaterialCatalogData.RemoveCatalog ( string catalog )

Removes the specified material catalog from the system.