sCore.nameSpaceLib.NameSpace Class Reference

[ CLASS ] - Class to operate on namespaces. More...

Inheritance diagram for sCore.nameSpaceLib.NameSpace:

Public Member Functions
def	__init__ (self, nameSpace=None)
	Constructor. More...
def	head (self)
	Get name space portion of the name space. More...
def	tail (self)
	Get the tail portion of the name space. More...
def	isValid (cls, nameSpace)
	Determine whether given string is a valid name space. More...
def	removeNameSpace (cls, name)
	Remove name space from the given name. More...
def	addNameSpace (cls, nameSpace, name, removeExisting=True)
	Add given name space to given name. More...
Properties
def	nameSpace (self)
	NameSpace. More...
def	setNameSpace (self, nameSpace)
	Set name space. More...

Static Public Attributes
string	NAME_SPACE_DELIMITER = ':'
	[ str ] - Name space delimiter. More...
string	FULL_PATH_DELIMITER = '|'
	[ str ] - Full path delimiter. More...

Detailed Description

[ CLASS ] - Class to operate on namespaces.

import sys
import sCore.nameSpaceLib

_nameSpace = sCore.nameSpaceLib.NameSpace(nameSpace='asset:soldier:armA_01_jnt')

sys.stdout.write(_nameSpace.nameSpace())
 # asset:soldier:armA_01_jnt

sys.stdout.write(_nameSpace.head())
 # asset:soldier

sys.stdout.write(_nameSpace.tail())
 # armA_01_jnt

sys.stdout.write(sCore.nameSpaceLib.NameSpace.isValid('soldier'))
 # False

Constructor & Destructor Documentation

__init__()

def sCore.nameSpaceLib.NameSpace.__init__	(		self,
			nameSpace = None
	)

Constructor.

Parameters

nameSpace

[ str | None | in ] - NameSpace.

Exceptions

N/A

Returns

None

Member Function Documentation

nameSpace()

def sCore.nameSpaceLib.NameSpace.nameSpace

(

self

)

NameSpace.

Exceptions

N/A

Returns

str - NameSpace.

None - If name space is not set.

setNameSpace()

def sCore.nameSpaceLib.NameSpace.setNameSpace	(		self,
			nameSpace
	)

Set name space.

Parameters

nameSpace

[ str | None | in ] - NameSpace.

Returns

bool - Result.

head()

def sCore.nameSpaceLib.NameSpace.head

(

self

)

Get name space portion of the name space.

Exceptions

N/A

Returns

str - NameSpace portion.

tail()

def sCore.nameSpaceLib.NameSpace.tail

(

self

)

Get the tail portion of the name space.

Exceptions

N/A

Returns

str - Part portion of the name space.

isValid()

def sCore.nameSpaceLib.NameSpace.isValid	(		cls,
			nameSpace
	)

Determine whether given string is a valid name space.

Whether it has NameSpace.NAME_SPACE_DELIMITER in the given string.

Parameters

cls	[ object | None | in ] - Class object.
nameSpace	[ str | None | in ] - NameSpace.

Exceptions

N/A

Returns

bool - Result.

removeNameSpace()

def sCore.nameSpaceLib.NameSpace.removeNameSpace	(		cls,
			name
	)

Remove name space from the given name.

Parameters

cls	[ object | None | in ] - Class object.
name	[ str | None | in ] - Name.

Exceptions

N/A

Returns

str - Name without name space.

addNameSpace()

def sCore.nameSpaceLib.NameSpace.addNameSpace	(		cls,
			nameSpace,
			name,
			removeExisting = True
	)

Add given name space to given name.

Parameters

cls	[ object | None | in ] - Class object.
nameSpace	[ str | None | in ] - Name space to be added.
name	[ str | None | in ] - Name.
removeExisting	[ bool | True | in ] - Remove existing name space from the given name before adding the new one.

Exceptions

N/A

Returns

str - Name with name space.

Member Data Documentation

NAME_SPACE_DELIMITER

string sCore.nameSpaceLib.NameSpace.NAME_SPACE_DELIMITER = ':'

static

[ str ] - Name space delimiter.

FULL_PATH_DELIMITER

string sCore.nameSpaceLib.NameSpace.FULL_PATH_DELIMITER = '|'

static

[ str ] - Full path delimiter.

---

The documentation for this class was generated from the following file:

• sCore/python/sCore/nameSpaceLib.py