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...
Public Member Functions inherited from mi::neuraylib::IMdl_info
virtual Kind	get_kind () const =0
	Returns the kind of the graph node. More...
virtual const char *	get_qualified_name () const =0
	Returns the qualified name of the graph node. More...
virtual const char *	get_simple_name () const =0
	Returns the simple_name (tail of the qualified_name) of the graph node. More...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x94d, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::neuraylib::IMdl_info
enum	Kind
	The kinds of the graph nodes. More...
Public Types inherited from mi::base::Interface_declare< 0xd2f50312, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	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...
Static Public Member Functions inherited from mi::base::Interface_declare< 0xd2f50312, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. 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).