FBDirMap Class Reference

#include <mobu-python-api.h>

Class Description

See the C++ reference

Inheritance diagram for FBDirMap:

Public Member Functions
	__reduce__ ()
	__init__ (object arg1)
	Iterates through all the mapped directories. More...
	Add (FBDirMap arg1, str arg2, str arg3)
	Adds an entry in the map. More...
int	GetCount (FBDirMap arg1)
	Returns the number of items in the map. More...
str	GetSource (FBDirMap arg1, object arg2)
	Returns the source directory for the element at specified index. More...
str	GetTarget (FBDirMap arg1, object arg2)
	Returns the target directory for the element at specified index. More...
	Clear (FBDirMap arg1)
	Clears the map. More...
str	Map (FBDirMap arg1, str arg2)
	Iterates through all the mapped directories. More...

Member Function Documentation

__init__

(

object

arg1

)

Iterates through all the mapped directories.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

ORSDK2018::FBString Map(ORSDK2018::FBString pPath) 

If one of the mapped directory's source is found in the given path, that part of the path will be replaced by the mapped directory's target. Only the first occurrence is processed.

Parameters

pPath

The path to process

See the C++ reference

__reduce__

(

)

Add	(	FBDirMap	arg1,
		str	arg2,
		str	arg3
	)

Adds an entry in the map.

Python Docstring:

Add( (FBDirMap)arg1, (str)arg2, (str)arg3) -> None 

C++ Signature:

void Add(ORSDK2018::FBString pSourceDir, ORSDK2018::FBString pTargetDir) 

Environment variables can be specified for the target path using the syntax. Environment variables are expanded before the paths get added to the map. An error in the formatting of the paths (environment variable tokens) will abort the expansion and both given paths will remained unchanged.

\param  pSourceDir The source directory
\param  pTargetDir The target directory

See the C++ reference

Clear

(

FBDirMap

arg1

)

Clears the map.

Python Docstring:

Clear( (FBDirMap)arg1) -> None 

C++ Signature:

void Clear() 

See the C++ reference

int GetCount

(

FBDirMap

arg1

)

Returns the number of items in the map.

Python Docstring:

GetCount( (FBDirMap)arg1) -> int 

C++ Signature:

int GetCount() 

See the C++ reference

str GetSource	(	FBDirMap	arg1,
		object	arg2
	)

Returns the source directory for the element at specified index.

Python Docstring:

GetSource( (FBDirMap)arg1, (object)arg2) -> str 

C++ Signature:

ORSDK2018::FBString GetSource(int pIndex) 

See the C++ reference

str GetTarget	(	FBDirMap	arg1,
		object	arg2
	)

Returns the target directory for the element at specified index.

Python Docstring:

GetTarget( (FBDirMap)arg1, (object)arg2) -> str 

C++ Signature:

ORSDK2018::FBString GetTarget(int pIndex) 

See the C++ reference

str Map	(	FBDirMap	arg1,
		str	arg2
	)

Iterates through all the mapped directories.

Python Docstring:

Map( (FBDirMap)arg1, (str)arg2) -> str 

C++ Signature:

ORSDK2018::FBString Map(ORSDK2018::FBString pPath) 

If one of the mapped directory's source is found in the given path, that part of the path will be replaced by the mapped directory's target. Only the first occurrence is processed.

Parameters

pPath

The path to process

See the C++ reference