sStash.stashLib.Flag Class Reference

[ CLASS ] - Flag class used by sStash.stashLib.Request class. More...

Inheritance diagram for sStash.stashLib.Flag:

Classes
class	DataType
	[ ENUM CLASS ] - Data types accepted by the Flag class. More...

Public Member Functions
def	__init__ (self, name, value=None, dataType=DataType.kStr, defaultValue=None, acceptedValues=None)
	Constructor. More...
def	resetValue (self)
	Sets value to flag's default value. More...
Properties
def	name (self)
	Name. More...
def	value (self)
	Value. More...
def	setValue (self, value)
	Sets value. More...
def	dataType (self)
	Data type from sStash.stashLib.Flag.DataType enum class. More...
def	defaultValue (self)
	Default value of the flag, Python object. More...
def	acceptedValues (self)
	Accepted values of the flag. More...
def	flagName (self)
	Flag name with –, as it would appear in command line. More...
def	flagValue (self)
	Flag value, as it would appear in command line. More...

Detailed Description

[ CLASS ] - Flag class used by sStash.stashLib.Request class.

Constructor & Destructor Documentation

__init__()

def sStash.stashLib.Flag.__init__	(		self,
			name,
			value = None,
			dataType = DataType.kStr,
			defaultValue = None,
			acceptedValues = None
	)

Constructor.

Parameters

name	[ str | None | in ] - Name of the flag, actual name.
value	[ variant | None | in ] - Value of the flag, Python object.
dataType	[ sStash.stashLib.Flag.DataType | None | in ] - Data type from sStash.stashLib.Flag.DataType enum class.
defaultValue	[ variant | None | in ] - Default value of the flag, Python object.
acceptedValues	[ list | None | in ] - Accepted values of the flag.

Exceptions

N/A

Returns

None - None.

Member Function Documentation

name()

def sStash.stashLib.Flag.name

(

self

)

Name.

Exceptions

N/A

Returns

str - Name of the flag, actual name.

value()

def sStash.stashLib.Flag.value

(

self

)

Value.

Exceptions

N/A

Returns

variant - Value of the flag, Python object.

setValue()

def sStash.stashLib.Flag.setValue	(		self,
			value
	)

Sets value.

Parameters

value

[ variant | None | in ] - Value to be set.

Exceptions

N/A

Returns

None - None.

dataType()

def sStash.stashLib.Flag.dataType

(

self

)

Data type from sStash.stashLib.Flag.DataType enum class.

Exceptions

N/A

Returns

sStash.stashLib.Flag.DataType - Data type.

defaultValue()

def sStash.stashLib.Flag.defaultValue

(

self

)

Default value of the flag, Python object.

Exceptions

N/A

Returns

variant - Default value.

acceptedValues()

def sStash.stashLib.Flag.acceptedValues

(

self

)

Accepted values of the flag.

Exceptions

N/A

Returns

list of variant - Accepted values.

flagName()

def sStash.stashLib.Flag.flagName

(

self

)

Flag name with –, as it would appear in command line.

Exceptions

N/A

Returns

str - Flag name.

flagValue()

def sStash.stashLib.Flag.flagValue

(

self

)

Flag value, as it would appear in command line.

Exceptions

N/A

Returns

variant - Flag value.

resetValue()

def sStash.stashLib.Flag.resetValue

(

self

)

Sets value to flag's default value.

Exceptions

N/A

Returns

None - None.

---

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

• sStash/python/sStash/stashLib.py