MECO™ API Reference
Public Member Functions | List of all members
mMecoRelease.releaseCnt.Release Class Reference

[ CLASS ] - Class to release packages. More...

Inheritance diagram for mMecoRelease.releaseCnt.Release:
mProcess.containerAbs.Container

Public Member Functions

def __init__ (self, parent=None, data=None, packageRoot=os.getcwd(), **kwargs)
 Constructor. More...
 
def shouldInitialize (self)
 Whether this container should be initialized. More...
 
- Public Member Functions inherited from mProcess.containerAbs.Container
def __str__ (self)
 String representation. More...
 
def asStr (self)
 String representation. More...
 
def run (self)
 Run the container meaning running all processes and their dependencies. More...
 
def runInCommandLine (cls)
 Class method which can be used to run child classes of this class in command line. More...
 
def data (self)
 Data. More...
 
def dataFile (self)
 Class instance that operates on data file. More...
 
def setDataFile (self, dataFile)
 Set data file. More...
 
def kwargs (self)
 Keyword arguments. More...
 
def processList (self)
 Process list. More...
 
def hasInitialized (self)
 Whether this class has been initialized. More...
 
def setInitialized (self)
 Set this class initialized. More...
 
def haveProcessesInitialized (self)
 Whether process classes have been initialized. More...
 
def setProcessesInitialized (self)
 Set process classes initialized. More...
 
def userDescription (self)
 User description. More...
 
def setUserDescription (self, userDescription)
 Set user description. More...
 
def ignoreDescription (self)
 Ignore description. More...
 
def setIgnoreDescription (self, ignoreDescription)
 Set ignore description. More...
 
def name (self)
 Name of the container. More...
 
def description (self)
 Description about the container. More...
 
def processListModule (self)
 Process list module. More...
 
def requiresUserDescription (self)
 Whether this container requires user description to run. More...
 

Additional Inherited Members

- Static Public Attributes inherited from mProcess.containerAbs.Container
 signalInfoOccurred = QtCore.Signal(str)
 [ Signal ] - Signal emitted by _setInfo method.
 
 signalSuccessOccurred = QtCore.Signal(str)
 [ Signal ] - Signal emitted by _setSuccess method.
 
 signalWarningOccurred = QtCore.Signal(str)
 [ Signal ] - Signal emitted by _setWarning method.
 
 signalFailureOccurred = QtCore.Signal(str)
 [ Signal ] - Signal emitted by _setFailure method.
 
 signalDisplayHeader = QtCore.Signal(str)
 [ Signal ] - Signal should be used when a header needs to be displayed.
 

Detailed Description

[ CLASS ] - Class to release packages.

Constructor & Destructor Documentation

◆ __init__()

def mMecoRelease.releaseCnt.Release.__init__ (   self,
  parent = None,
  data = None,
  packageRoot = os.getcwd(),
**  kwargs 
)

Constructor.

Parameters
parent[ QObject | None | in ] - Parent.
data[ mProcess.dataLib.Data | None | in ] - Data.
packageRoot[ str | os.getcwd | in ] - Root of a package to be released.
kwargs[ dict | None | in ] - Keyword arguments.
Exceptions
N/A
Returns
None - None.

Reimplemented from mProcess.containerAbs.Container.

Member Function Documentation

◆ shouldInitialize()

def mMecoRelease.releaseCnt.Release.shouldInitialize (   self)

Whether this container should be initialized.

Implement this method to prevent child class instance from being initialized by raising mProcess.exceptionLib.ContainerError exception. Method must return True explicitly otherwise.

Exceptions
N/A
Returns
bool - Result.

Reimplemented from mProcess.containerAbs.Container.


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