Stash Software API  2.0.0
Static Public Attributes | List of all members
sStashPackage.packageLib.FolderStructure Class Reference

[ ENUM CLASS ] - Class contains package folder structure. More...

Inheritance diagram for sStashPackage.packageLib.FolderStructure:
sCore.enumAbs.Enum

Static Public Attributes

 kBin = FolderName.kBin
 [ str ] - Bin (executables) path. More...
 
string kBinDarwin = '{}/{}'.format(FolderName.kBin, FolderName.kDarwin)
 [ str ] - Bin (executables) path on Mac OS. More...
 
string kBinLinux = '{}/{}'.format(FolderName.kBin, FolderName.kLinux)
 [ str ] - Bin (executables) path on Linux OS. More...
 
string kBinWindows = '{}\\\\{}'.format(FolderName.kBin, FolderName.kWindows)
 [ str ] - Bin (executables) path on Microsoft Windows OS. More...
 
 kBuild = FolderName.kBuild
 [ str ] - Build path. More...
 
string kBuildDarwin = '{}/{}'.format(FolderName.kBuild, FolderName.kDarwin)
 [ str ] - Build path on Mac OS. More...
 
string kBuildLinux = '{}/{}'.format(FolderName.kBuild, FolderName.kLinux)
 [ str ] - Build path on Linux OS. More...
 
string kBuildWindows = '{}\\\\{}'.format(FolderName.kBuild, FolderName.kWindows)
 [ str ] - Build path on Windows OS. More...
 
 kConfig = FolderName.kConfig
 [ str ] - Configuration path. More...
 
 kData = FolderName.kData
 [ str ] - Data path. More...
 
string kDataSourceScope = '{}/{}'.format(FolderName.kData, FolderName.kSourceScope)
 [ str ] - Source scope path. More...
 
string kDataSourceScopePython = '{}/{}'.format(kDataSourceScope, FolderName.kPython)
 [ str ] - Source scope python path. More...
 
string kDataPackageList = '{}/{}'.format(FolderName.kData, FolderName.kPackageList)
 [ str ] - Package list path. More...
 
 kDoc = FolderName.kDoc
 [ str ] - Documentation path. More...
 
string kDocCPPAPIReference = '{}/{}/{}'.format(FolderName.kDoc, FolderName.kDeveloper, FolderName.kCPPAPIReference)
 [ str ] - Developer C++ API reference path. More...
 
string kDocPythonAPIReference = '{}/{}/{}'.format(FolderName.kDoc, FolderName.kDeveloper, FolderName.kPythonAPIReference)
 [ str ] - Developer Python API reference path. More...
 
string kDocUser = '{}/{}'.format(FolderName.kDoc, FolderName.kUser)
 [ str ] - User document path. More...
 
 kHoudini = FolderName.kHoudini
 [ str ] - Houdini path. More...
 
 kKatana = FolderName.kKatana
 [ str ] - Katana path. More...
 
 kLib = FolderName.kLib
 [ str ] - Library path. More...
 
string kLibDarwin = '{}/{}'.format(FolderName.kLib, FolderName.kDarwin)
 [ str ] - Library path on Mac OS. More...
 
string kLibLinux = '{}/{}'.format(FolderName.kLib, FolderName.kLinux)
 [ str ] - Library path on Linux OS. More...
 
string kLibWindows = '{}\\\\{}'.format(FolderName.kLib, FolderName.kWindows)
 [ str ] - Library path on Windows OS. More...
 
 kMari = FolderName.kMari
 [ str ] - Mari path. More...
 
 kMaya = FolderName.kMaya
 [ str ] - Maya path. More...
 
string kMayaVersion = '{}/2020'.format(FolderName.kMaya)
 [ str ] - Maya version path. More...
 
string kMayaMEL = '{}/{}'.format(kMayaVersion, FolderName.kMEL)
 [ str ] - Maya MEL script path. More...
 
string kMayaPlugin = '{}/{}'.format(kMayaVersion, FolderName.kPlugin)
 [ str ] - Maya plug-in path. More...
 
string kMayaPluginDarwin = '{}/{}'.format(kMayaPlugin, FolderName.kDarwin)
 [ str ] - Maya Mac OS plug-in path. More...
 
string kMayaPluginLinux = '{}/{}'.format(kMayaPlugin, FolderName.kLinux)
 [ str ] - Maya Linux plug-in path. More...
 
string kMayaPluginWindows = '{}\\\\{}'.format(kMayaPlugin, FolderName.kWindows)
 [ str ] - Maya windows plug-in path. More...
 
string kMayaShelves = '{}/{}'.format(kMayaVersion, FolderName.kShelves)
 [ str ] - Maya shelves path. More...
 
string kMayaXBM = '{}/{}'.format(kMayaVersion, FolderName.kXBM)
 [ str ] - Maya XMB path. More...
 
 kNuke = FolderName.kNuke
 [ str ] - Nuke path. More...
 
 kPython = FolderName.kPython
 [ str ] - Python path. More...
 
 kResources = FolderName.kResources
 [ str ] - Resource path. More...
 
string kResourcesFiles = '{}/{}'.format(FolderName.kResources, FolderName.kFiles)
 [ str ] - Files path. More...
 
string kResourcesFilesApp = '{}/{}/{}'.format(FolderName.kResources, FolderName.kFiles, FolderName.kApp)
 [ str ] - App files path. More...
 
string kResourcesIcons = '{}/{}'.format(FolderName.kResources, FolderName.kIcons)
 [ str ] - Icon path. More...
 
 kSource = FolderName.kSource
 [ str ] - Source directory for C++, C etc. More...
 
string kSourceCPP = '{}/{}'.format(FolderName.kSource, FolderName.kCPP)
 [ str ] - C++ source path. More...
 
 kTemp = FolderName.kTemp
 [ str ] - Temp path. More...
 
 kTest = FolderName.kTest
 [ str ] - Unit test path. More...
 

Additional Inherited Members

- Public Member Functions inherited from sCore.enumAbs.Enum
def listAttributes (cls, stringOnly=True, getValues=True, removeK=True, startAttrNamesLower=False)
 List static public attributes of the class. More...
 
def listAttributeElements (cls, attribute)
 List elements of a static public attribute. More...
 
def getAttributeNameFromValue (cls, value, removeK=True, defaultAttributeName=None, startLower=False)
 Get the name of the attribute for given value. More...
 
def getValueFromAttributeName (cls, attribute, removeK=False, defaultValue=None)
 Get value from attribute name. More...
 
def asDict (cls, removeK=True)
 Get all the attributes and their values in a dict instance. More...
 

Detailed Description

[ ENUM CLASS ] - Class contains package folder structure.

Member Data Documentation

◆ kBin

sStashPackage.packageLib.FolderStructure.kBin = FolderName.kBin
static

[ str ] - Bin (executables) path.

◆ kBinDarwin

string sStashPackage.packageLib.FolderStructure.kBinDarwin = '{}/{}'.format(FolderName.kBin, FolderName.kDarwin)
static

[ str ] - Bin (executables) path on Mac OS.

◆ kBinLinux

string sStashPackage.packageLib.FolderStructure.kBinLinux = '{}/{}'.format(FolderName.kBin, FolderName.kLinux)
static

[ str ] - Bin (executables) path on Linux OS.

◆ kBinWindows

string sStashPackage.packageLib.FolderStructure.kBinWindows = '{}\\\\{}'.format(FolderName.kBin, FolderName.kWindows)
static

[ str ] - Bin (executables) path on Microsoft Windows OS.

◆ kBuild

sStashPackage.packageLib.FolderStructure.kBuild = FolderName.kBuild
static

[ str ] - Build path.

◆ kBuildDarwin

string sStashPackage.packageLib.FolderStructure.kBuildDarwin = '{}/{}'.format(FolderName.kBuild, FolderName.kDarwin)
static

[ str ] - Build path on Mac OS.

◆ kBuildLinux

string sStashPackage.packageLib.FolderStructure.kBuildLinux = '{}/{}'.format(FolderName.kBuild, FolderName.kLinux)
static

[ str ] - Build path on Linux OS.

◆ kBuildWindows

string sStashPackage.packageLib.FolderStructure.kBuildWindows = '{}\\\\{}'.format(FolderName.kBuild, FolderName.kWindows)
static

[ str ] - Build path on Windows OS.

◆ kConfig

sStashPackage.packageLib.FolderStructure.kConfig = FolderName.kConfig
static

[ str ] - Configuration path.

◆ kData

sStashPackage.packageLib.FolderStructure.kData = FolderName.kData
static

[ str ] - Data path.

◆ kDataSourceScope

string sStashPackage.packageLib.FolderStructure.kDataSourceScope = '{}/{}'.format(FolderName.kData, FolderName.kSourceScope)
static

[ str ] - Source scope path.

◆ kDataSourceScopePython

string sStashPackage.packageLib.FolderStructure.kDataSourceScopePython = '{}/{}'.format(kDataSourceScope, FolderName.kPython)
static

[ str ] - Source scope python path.

◆ kDataPackageList

string sStashPackage.packageLib.FolderStructure.kDataPackageList = '{}/{}'.format(FolderName.kData, FolderName.kPackageList)
static

[ str ] - Package list path.

◆ kDoc

sStashPackage.packageLib.FolderStructure.kDoc = FolderName.kDoc
static

[ str ] - Documentation path.

◆ kDocCPPAPIReference

string sStashPackage.packageLib.FolderStructure.kDocCPPAPIReference = '{}/{}/{}'.format(FolderName.kDoc, FolderName.kDeveloper, FolderName.kCPPAPIReference)
static

[ str ] - Developer C++ API reference path.

◆ kDocPythonAPIReference

string sStashPackage.packageLib.FolderStructure.kDocPythonAPIReference = '{}/{}/{}'.format(FolderName.kDoc, FolderName.kDeveloper, FolderName.kPythonAPIReference)
static

[ str ] - Developer Python API reference path.

◆ kDocUser

string sStashPackage.packageLib.FolderStructure.kDocUser = '{}/{}'.format(FolderName.kDoc, FolderName.kUser)
static

[ str ] - User document path.

◆ kHoudini

sStashPackage.packageLib.FolderStructure.kHoudini = FolderName.kHoudini
static

[ str ] - Houdini path.

◆ kKatana

sStashPackage.packageLib.FolderStructure.kKatana = FolderName.kKatana
static

[ str ] - Katana path.

◆ kLib

sStashPackage.packageLib.FolderStructure.kLib = FolderName.kLib
static

[ str ] - Library path.

◆ kLibDarwin

string sStashPackage.packageLib.FolderStructure.kLibDarwin = '{}/{}'.format(FolderName.kLib, FolderName.kDarwin)
static

[ str ] - Library path on Mac OS.

◆ kLibLinux

string sStashPackage.packageLib.FolderStructure.kLibLinux = '{}/{}'.format(FolderName.kLib, FolderName.kLinux)
static

[ str ] - Library path on Linux OS.

◆ kLibWindows

string sStashPackage.packageLib.FolderStructure.kLibWindows = '{}\\\\{}'.format(FolderName.kLib, FolderName.kWindows)
static

[ str ] - Library path on Windows OS.

◆ kMari

sStashPackage.packageLib.FolderStructure.kMari = FolderName.kMari
static

[ str ] - Mari path.

◆ kMaya

sStashPackage.packageLib.FolderStructure.kMaya = FolderName.kMaya
static

[ str ] - Maya path.

◆ kMayaVersion

string sStashPackage.packageLib.FolderStructure.kMayaVersion = '{}/2020'.format(FolderName.kMaya)
static

[ str ] - Maya version path.

◆ kMayaMEL

string sStashPackage.packageLib.FolderStructure.kMayaMEL = '{}/{}'.format(kMayaVersion, FolderName.kMEL)
static

[ str ] - Maya MEL script path.

◆ kMayaPlugin

string sStashPackage.packageLib.FolderStructure.kMayaPlugin = '{}/{}'.format(kMayaVersion, FolderName.kPlugin)
static

[ str ] - Maya plug-in path.

◆ kMayaPluginDarwin

string sStashPackage.packageLib.FolderStructure.kMayaPluginDarwin = '{}/{}'.format(kMayaPlugin, FolderName.kDarwin)
static

[ str ] - Maya Mac OS plug-in path.

◆ kMayaPluginLinux

string sStashPackage.packageLib.FolderStructure.kMayaPluginLinux = '{}/{}'.format(kMayaPlugin, FolderName.kLinux)
static

[ str ] - Maya Linux plug-in path.

◆ kMayaPluginWindows

string sStashPackage.packageLib.FolderStructure.kMayaPluginWindows = '{}\\\\{}'.format(kMayaPlugin, FolderName.kWindows)
static

[ str ] - Maya windows plug-in path.

◆ kMayaShelves

string sStashPackage.packageLib.FolderStructure.kMayaShelves = '{}/{}'.format(kMayaVersion, FolderName.kShelves)
static

[ str ] - Maya shelves path.

◆ kMayaXBM

string sStashPackage.packageLib.FolderStructure.kMayaXBM = '{}/{}'.format(kMayaVersion, FolderName.kXBM)
static

[ str ] - Maya XMB path.

◆ kNuke

sStashPackage.packageLib.FolderStructure.kNuke = FolderName.kNuke
static

[ str ] - Nuke path.

◆ kPython

sStashPackage.packageLib.FolderStructure.kPython = FolderName.kPython
static

[ str ] - Python path.

◆ kResources

sStashPackage.packageLib.FolderStructure.kResources = FolderName.kResources
static

[ str ] - Resource path.

◆ kResourcesFiles

string sStashPackage.packageLib.FolderStructure.kResourcesFiles = '{}/{}'.format(FolderName.kResources, FolderName.kFiles)
static

[ str ] - Files path.

◆ kResourcesFilesApp

string sStashPackage.packageLib.FolderStructure.kResourcesFilesApp = '{}/{}/{}'.format(FolderName.kResources, FolderName.kFiles, FolderName.kApp)
static

[ str ] - App files path.

◆ kResourcesIcons

string sStashPackage.packageLib.FolderStructure.kResourcesIcons = '{}/{}'.format(FolderName.kResources, FolderName.kIcons)
static

[ str ] - Icon path.

◆ kSource

sStashPackage.packageLib.FolderStructure.kSource = FolderName.kSource
static

[ str ] - Source directory for C++, C etc.

code.

◆ kSourceCPP

string sStashPackage.packageLib.FolderStructure.kSourceCPP = '{}/{}'.format(FolderName.kSource, FolderName.kCPP)
static

[ str ] - C++ source path.

◆ kTemp

sStashPackage.packageLib.FolderStructure.kTemp = FolderName.kTemp
static

[ str ] - Temp path.

◆ kTest

sStashPackage.packageLib.FolderStructure.kTest = FolderName.kTest
static

[ str ] - Unit test path.


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