mi::neuraylib::IMdl_package_info Class Reference

Interface for a graph node representing an MDL package. More...

#include <imdl_discovery_api.h>

Inheritance diagram for mi::neuraylib::IMdl_package_info:

Public Member Functions
virtual Size	get_child_count () const =0
	Returns the number of modules and packages contained by this package. More...
virtual const IMdl_info *	get_child (Size index) const =0
	Returns a child of this package. More...
virtual Size	get_search_path_index_count () const =0
	Returns the number of search paths of this package. More...
virtual Size	get_search_path_index (Size index) const =0
	Returns the search path index in the current IMdl_discovery_result. More...
virtual const char *	get_search_path (Size index) const =0
	Returns a search path in the local file system where this package has been found. More...
virtual const IString *	get_resolved_path (Size index) const =0
	Returns an absolute path to package in the local file system. More...
virtual bool	in_archive (Size index) const =0
	Returns true if the package has been discovered inside of an archive, false if not. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x94d, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...
typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x94d, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

Interface for a graph node representing an MDL package.

Member Function Documentation

get_child()

virtual const IMdl_info * mi::neuraylib::IMdl_package_info::get_child ( Size  index ) const

pure virtual

Returns a child of this package.

Parameters

index

Index in the child list of this package.

get_child_count()

virtual Size mi::neuraylib::IMdl_package_info::get_child_count ( ) const

pure virtual

Returns the number of modules and packages contained by this package.

get_resolved_path()

virtual const IString * mi::neuraylib::IMdl_package_info::get_resolved_path ( Size  index ) const

pure virtual

Returns an absolute path to package in the local file system.

Parameters

index

Index in the resolved path list of this package.

get_search_path()

virtual const char * mi::neuraylib::IMdl_package_info::get_search_path ( Size  index ) const

pure virtual

Returns a search path in the local file system where this package has been found.

Parameters

index

Index in the search path list of this package.

get_search_path_index()

virtual Size mi::neuraylib::IMdl_package_info::get_search_path_index ( Size  index ) const

pure virtual

Returns the search path index in the current IMdl_discovery_result.

Parameters

index

Index in the IMdl_discovery_result search path list.

get_search_path_index_count()

virtual Size mi::neuraylib::IMdl_package_info::get_search_path_index_count ( ) const

pure virtual

Returns the number of search paths of this package.

in_archive()

virtual bool mi::neuraylib::IMdl_package_info::in_archive ( Size  index ) const

pure virtual

Returns true if the package has been discovered inside of an archive, false if not.

Parameters

index

Index in the interval [0, search_path_index_count).