Catalog Class

The main class for accessing Carmenta Engine catalogs.

Syntax

public class Catalog : ResourceObject

Remarks

This is the central class of the Catalog mechanism in Carmenta Engine. It gives an application access to a catalog with map configurations and corresponding geodata. The application can use this class to query for available maps, globes and datasets, load them and add them to a Carmenta Engine view.

The following examples show how to load a background map and attach it to view, and how to load a catalog globe and attach it to a 3D globe view. Please see the Catalog Mechanism Overview for more information about the Catalog mechanism.

Example

// Load a WorldMap background map through a Catalog
public static void LoadBackgroundMapFromCatalog(View view)
{
    // Load the catalog
    Catalog catalog = new Catalog("rootDir");

    // This will find all metadata records with the name 'WorldMap'
    CatalogQuery query = new CatalogQuery("name = \"WorldMap\"");
    CatalogMetadataCollection meta = catalog.GetMaps(query);
    if (meta.Count == 0)
        throw new Exception("Could not find map 'WorldMap'");

    // Load the map
    CatalogMap map = catalog.LoadMap(meta[0]);

    // Add it to the view
    view.Layers.Insert(0, map);
}

// Load a catalog globe and add to a globe view
public static void LoadGlobeFromCatalog(GlobeView view)
{
    // Load the catalog
    Catalog catalog = new Catalog("rootDir");

    // This will find all metadata records with the name '3DGlobe'
    CatalogQuery query = new CatalogQuery("name = \"3DGlobe\"");
    CatalogMetadataCollection meta = catalog.GetGlobes(query);
    if (meta.Count == 0)
        throw new Exception("Could not find globe '3DGlobe'");

    // Load the globe
    CatalogGlobe globe = catalog.LoadGlobe(meta[0]);

    // Add it to the view, note that members may be null
	if (globe.Layers != null)
		view.Layers.Insert(0, globe.Layers);
	if (globe.SurfaceLayers != null)
		view.SurfaceLayers.Insert(0, globe.SurfaceLayers);
	if (globe.ElevationInput != null)
		view.ElevationInput = globe.ElevationInput;
	if (globe.AuxiliaryGroundInput != null)
		view.AuxiliaryGroundInput = globe.AuxiliaryGroundInput;
	view.SurfaceBackground = globe.SurfaceBackground;
}

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    ResourceObject
      Catalog

Platforms

Windows, Linux, Android

Catalog Members

The Catalog type has the following members.

Constructors

Name	Description
Catalog	Initializes a new instance of the Catalog class with the given root directory or directories.

Properties

Name	Description
IsDisposed	Gets a value that tells whether the current Catalog has been disposed. Inherited from EngineObject
Name	Gets or sets the name of the Catalog. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current Catalog represents. Inherited from EngineObject
PreferredLanguages	Gets or sets a list of preferred languages.
RootDirectory	Gets the root directory or directories of the catalog.
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
Clone	Creates a copy of an object. Inherited from EngineObject
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject
FlushCache	Flushes memory caches held by the catalog.
GetAllLanguages	Gets all languages used by maps and datasets in the catalog.
GetDataSets	Overloaded. Gets dataset metadata records in a Catalog.
GetGlobes	Overloaded. Gets globe metadata records in a Catalog.
GetMaps	Overloaded. Gets map metadata records in a Catalog.
LoadDataSet	Overloaded. Loads a dataset from a catalog.
LoadGlobe	Overloaded. Loads a globe from a catalog.
LoadMap	Overloaded. Loads a map from a catalog.
MonitorChanges	Starts a background thread that monitors the catalog directory for changes.

Events

Name	Description
CatalogChanged	Occurs when catalog has detected changes to any of the metadata files in the catalog.

Catalog Class

The main class for accessing Carmenta Engine catalogs.

Syntax

C++

class Catalog : public ResourceObject

C++ Smart Pointer Declaration

typedef Ptr<Catalog> CatalogPtr;

Remarks

Example

C++

// Load a WorldMap background map through a Catalog
static void loadBackgroundMapFromCatalog(ViewPtr view)
{
    // Load the catalog
    CatalogPtr catalog = new Catalog("rootDir");

    // This will find all metadata records with the name 'WorldMap'
    CatalogQueryPtr query = new CatalogQuery("name = \"WorldMap\"");
    CatalogMetadataCollectionPtr meta = catalog->getMaps(query);
    if (meta->size() == 0)
		throw std::runtime_error("Could not find map 'WorldMap'");

    // Load the map
    CatalogMapPtr map = catalog->loadMap(meta->get(0));

    // Add it to the view
    view->layers()->insert(0, map);
}


// Load a catalog globe and add to a globe view
static void loadGlobeFromCatalog(GlobeViewPtr view)
{
    // Load the catalog
    CatalogPtr catalog = new Catalog("rootDir");

    // This will find all metadata records with the name '3DGlobe'
    CatalogQueryPtr query = new CatalogQuery("name = \"3DGlobe\"");
    CatalogMetadataCollectionPtr meta = catalog.getGlobes(query);
    if (meta->size() == 0)
        throw std::runtime_error("Could not find globe '3DGlobe'");

    // Load the globe
    CatalogGlobePtr globe = catalog->loadGlobe(meta->get(0));

    // Add it to the view, note that members may be null
	if (globe->layers())
		view->layers()->insert(0, globe->layers());
	if (globe->surfaceLayers())
		view->surfaceLayers()->insert(0, globe->surfaceLayers());
	if (globe->elevationInput())
		view->elevationInput(globe->elevationInput());
	if (globe->auxiliaryGroundInput())
		view->auxiliaryGroundInput(globe->auxiliaryGroundInput());
	view->surfaceBackground(globe->surfaceBackground());
}

Inheritance Hierarchy

EngineObject
ResourceObject
Catalog

Platforms

Windows, Linux, Android

Catalog Members

The Catalog type has the following members.

Constructors

Name	Description
Catalog	Initializes a new instance of the Catalog class with the given root directory or directories.

Properties

Name	Description
name	Gets or sets the name of the Catalog. Inherited from ResourceObject
preferredLanguages	Gets or sets a list of preferred languages.
rootDirectory	Gets the root directory or directories of the catalog.
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
flushCache	Flushes memory caches held by the catalog.
getAllLanguages	Gets all languages used by maps and datasets in the catalog.
getDataSets	Overloaded. Gets dataset metadata records in a Catalog.
getGlobes	Overloaded. Gets globe metadata records in a Catalog.
getMaps	Overloaded. Gets map metadata records in a Catalog.
loadDataSet	Overloaded. Loads a dataset from a catalog.
loadGlobe	Overloaded. Loads a globe from a catalog.
loadMap	Overloaded. Loads a map from a catalog.
monitorChanges	Starts a background thread that monitors the catalog directory for changes.

Events

Name	Description
catalogChanged	Occurs when catalog has detected changes to any of the metadata files in the catalog.

Catalog Class

The main class for accessing Carmenta Engine catalogs.

Syntax

Java

public class Catalog extends ResourceObject

Remarks

Example

Java

// Load a WorldMap background map through a Catalog
public static void loadBackgroundMapFromCatalog(View view)
{
    // Load the catalog
    Catalog catalog = new Catalog("rootDir");

    // This will find all metadata records with the name 'WorldMap'
    CatalogQuery query = new CatalogQuery("name = \"WorldMap\"");
    CatalogMetadataCollection meta = catalog.getMaps(query);
    if (meta.size() == 0)
        throw new RuntimeException("Could not find map 'WorldMap'");

    // Load the map
    CatalogMap map = catalog.loadMap(meta.get(0));

    // Add it to the view
    view.getLayers().add(0, map);
}


// Load a catalog globe and add to a globe view
public static void loadGlobeFromCatalog(GlobeView view)
{
    // Load the catalog
    Catalog catalog = new Catalog("rootDir");

    // This will find all metadata records with the name '3DGlobe'
    CatalogQuery query = new CatalogQuery("name = \"3DGlobe\"");
    CatalogMetadataCollection meta = catalog.getGlobes(query);
    if (meta.size() == 0)
        throw new RuntimeException("Could not find globe '3DGlobe'");

    // Load the globe
    CatalogGlobe globe = catalog.loadGlobe(meta.get(0));

    // Add it to the view, note that members may be null
	if (globe.getLayers() != null)
		view.getLayers().add(0, globe.getLayers());
	if (globe.getSurfaceLayers() != null)
		view.getSurfaceLayers().add(0, globe.getSurfaceLayers());
	if (globe.getElevationInput() != null)
		view.setElevationInput(globe.getElevationInput());
	if (globe.getAuxiliaryGroundInput() != null)
		view.setAuxiliaryGroundInput(globe.getAuxiliaryGroundInput());
	view.setSurfaceBackground(globe.getSurfaceBackground());
}

Inheritance Hierarchy

System::Object (not available in Java)
  EngineObject
    ResourceObject
      Catalog

Platforms

Windows, Linux, Android

Catalog Members

The Catalog type has the following members.

Constructors

Name	Description
Catalog	Initializes a new instance of the Catalog class with the given root directory or directories.

Properties

Name	Description
isDisposed	Gets a value that tells whether the current Catalog has been disposed. Inherited from EngineObject
name	Gets or sets the name of the Catalog. Inherited from ResourceObject
preferredLanguages	Gets or sets a list of preferred languages.
rootDirectory	Gets the root directory or directories of the catalog.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
flushCache	Flushes memory caches held by the catalog.
getAllLanguages	Gets all languages used by maps and datasets in the catalog.
getDataSets	Overloaded. Gets dataset metadata records in a Catalog.
getGlobes	Overloaded. Gets globe metadata records in a Catalog.
getMaps	Overloaded. Gets map metadata records in a Catalog.
loadDataSet	Overloaded. Loads a dataset from a catalog.
loadGlobe	Overloaded. Loads a globe from a catalog.
loadMap	Overloaded. Loads a map from a catalog.
monitorChanges	Starts a background thread that monitors the catalog directory for changes.

Events

Name	Description
catalogChanged	Occurs when catalog has detected changes to any of the metadata files in the catalog.

Catalog Class

The main class for accessing Carmenta Engine catalogs.

Syntax

Python

class Catalog ( ResourceObject )

Remarks

Example

Python

# Load a WorldMap background map through a Catalog
def LoadBackgroundMapFromCatalog(view):

    # Load the catalog
    catalog = Catalog("rootDir")

    # This will find all metadata records with the name 'WorldMap'
    query = CatalogQuery("name = \"WorldMap\"")
    meta = catalog.getMaps(query)
    if len(meta) == 0:
        raise Exception("Could not find map 'WorldMap'")

    # Load the map
    map = catalog.loadMap(meta[0])

    # Add it to the view
    view.layers.insert(0, map)


# Load a catalog globe and add to a globe view
def LoadGlobeFromCatalog(view):
    # Load the catalog
    catalog = Catalog("rootDir")

    # This will find all metadata records with the name '3DGlobe'
    query = ("name = \"3DGlobe\"")
    meta = catalog.getGlobes(query)
    if len(meta) == 0:
        raise Exception("Could not find globe '3DGlobe'")

    # Load the globe
    globe = catalog.loadGlobe(meta[0])

    # Add it to the view, note that members may be null
    if globe.layers is not None:
        view.layers.insert(0, globe.Layers)
    if globe.surfaceLayers is not None:
        view.surfaceLayers.insert(0, globe.surfaceLayers)
    if globe.elevationInput is not None:
        view.elevationInput = globe.elevationInput
    if globe.auxiliaryGroundInput is not None:
        view.auxiliaryGroundInput = globe.auxiliaryGroundInput

    view.surfaceBackground = globe.surfaceBackground

Inheritance Hierarchy

EngineObject
ResourceObject
Catalog

Platforms

Windows, Linux, Android

Catalog Members

The Catalog type has the following members.

Constructors

Name	Description
Catalog	Initializes a new instance of the Catalog class with the given root directory or directories.

Properties

Name	Description
name	Gets or sets the name of the Catalog. Inherited from ResourceObject
preferredLanguages	Gets or sets a list of preferred languages.
rootDirectory	Gets the root directory or directories of the catalog.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
flushCache	Flushes memory caches held by the catalog.
getAllLanguages	Gets all languages used by maps and datasets in the catalog.
getDataSets	Overloaded. Gets dataset metadata records in a Catalog.
getGlobes	Overloaded. Gets globe metadata records in a Catalog.
getMaps	Overloaded. Gets map metadata records in a Catalog.
loadDataSet	Overloaded. Loads a dataset from a catalog.
loadGlobe	Overloaded. Loads a globe from a catalog.
loadMap	Overloaded. Loads a map from a catalog.
monitorChanges	Starts a background thread that monitors the catalog directory for changes.

Events

Name	Description

Catalog Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

Catalog Members

Catalog Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

Catalog Members

Catalog Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

Catalog Members

Catalog Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

Catalog Members