streams.ProcessingElement Class Reference

Class that represents a processing element. More...

Public Member Functions
def	hasDataDirectory (self)
	Determines if a data directory was specified at compile or submission time. More...
def	getDataDirectory (self)
	Returns the path to the data directory of the SPL application. More...
def	getCheckpointDirectory (self)
	Returns the path to the checkpointing directory of the PE. More...
def	getApplicationScope (self)
	Returns the application scope for the job the PE is running in. More...
def	getApplicationDirectory (self)
	Returns the path to the SPL application directory. More...
def	getOutputDirectory (self)
	Returns the path to the SPL application output directory. More...
def	getPEId (self)
	Returns the runtime identifier for this PE. More...
def	getJobId (self)
	Returns the runtime identifier for the job containing this PE. More...
def	getRelaunchCount (self)
	Returns the number of times this PE has been relaunched. More...
def	getNumberOfInputPorts (self)
	Returns the number of inputs for this PE. More...
def	getNumberOfOutputPorts (self)
	Returns the number of outputs for this PE. More...
def	isStandalone (self)
	Checks if the PE is running in standalone mode. More...
def	isOptimized (self)
	Checks if the PE is running under optimized mode. More...
def	isInFusedMode (self)
	Checks if the PE is running under fused mode. More...
def	isInDebugMode (self)
	Checks if the PE is running under debug mode. More...
def	getShutdownRequested (self)
	Checks if shutdown was requested. More...
def	getInstanceID (self)
	Returns the instance ID for the current processing element. More...
def	getDomainID (self)
	Returns the domain ID for the current processing element. More...
def	getApplicationName (self)
	Returns the name of the SPL application the PE is running. More...
def	getJobGroup (self)
	Returns the name of the job group for the job the processing element is running in. More...
def	getJobName (self)
	Returns the name of the job the processing element is running in. More...
def	getToolkitDirectory (self)
	Returns the absolute path of the toolkit containing the operator for this PE. More...
def	blockUntilShutdownRequest (self)
	Blocks until shutdown is requested. More...
def	getMetrics (self)
	Returns the PE metrics. More...
def	getOutputPortCongestionFactor
def	getOperatorRelativeCost

Detailed Description

Class that represents a processing element.

Member Function Documentation

hasDataDirectory()

def streams.ProcessingElement.hasDataDirectory	(		self,
			bool
	)

Determines if a data directory was specified at compile or submission time.

getDataDirectory()

def streams.ProcessingElement.getDataDirectory	(		self,
			str
	)

Returns the path to the data directory of the SPL application.

getCheckpointDirectory()

def streams.ProcessingElement.getCheckpointDirectory	(		self,
			str
	)

Returns the path to the checkpointing directory of the PE.

getApplicationScope()

def streams.ProcessingElement.getApplicationScope	(		self,
			str
	)

Returns the application scope for the job the PE is running in.

getApplicationDirectory()

def streams.ProcessingElement.getApplicationDirectory	(		self,
			str
	)

Returns the path to the SPL application directory.

getOutputDirectory()

def streams.ProcessingElement.getOutputDirectory	(		self,
			str
	)

Returns the path to the SPL application output directory.

getPEId()

def streams.ProcessingElement.getPEId	(		self,
			int
	)

Returns the runtime identifier for this PE.

getJobId()

def streams.ProcessingElement.getJobId	(		self,
			int
	)

Returns the runtime identifier for the job containing this PE.

getRelaunchCount()

def streams.ProcessingElement.getRelaunchCount	(		self,
			int
	)

Returns the number of times this PE has been relaunched.

For the first. execution, the value will be 0.

getNumberOfInputPorts()

def streams.ProcessingElement.getNumberOfInputPorts	(		self,
			int
	)

Returns the number of inputs for this PE.

getNumberOfOutputPorts()

def streams.ProcessingElement.getNumberOfOutputPorts	(		self,
			int
	)

Returns the number of outputs for this PE.

isStandalone()

def streams.ProcessingElement.isStandalone	(		self,
			bool
	)

Checks if the PE is running in standalone mode.

isOptimized()

def streams.ProcessingElement.isOptimized	(		self,
			bool
	)

Checks if the PE is running under optimized mode.

isInFusedMode()

def streams.ProcessingElement.isInFusedMode	(		self,
			bool
	)

Checks if the PE is running under fused mode.

isInDebugMode()

def streams.ProcessingElement.isInDebugMode	(		self,
			bool
	)

Checks if the PE is running under debug mode.

getShutdownRequested()

def streams.ProcessingElement.getShutdownRequested	(		self,
			bool
	)

Checks if shutdown was requested.

getInstanceID()

def streams.ProcessingElement.getInstanceID	(		self,
			str
	)

Returns the instance ID for the current processing element.

getDomainID()

def streams.ProcessingElement.getDomainID	(		self,
			str
	)

Returns the domain ID for the current processing element.

getApplicationName()

def streams.ProcessingElement.getApplicationName	(		self,
			str
	)

Returns the name of the SPL application the PE is running.

getJobGroup()

def streams.ProcessingElement.getJobGroup	(		self,
			str
	)

Returns the name of the job group for the job the processing element is running in.

getJobName()

def streams.ProcessingElement.getJobName	(		self,
			str
	)

Returns the name of the job the processing element is running in.

getToolkitDirectory()

def streams.ProcessingElement.getToolkitDirectory	(		self,
			str
	)

Returns the absolute path of the toolkit containing the operator for this PE.

blockUntilShutdownRequest()

def streams.ProcessingElement.blockUntilShutdownRequest	(		self,
			None
	)

Blocks until shutdown is requested.

getMetrics()

def streams.ProcessingElement.getMetrics	(		self,
			PEMetrics
	)

Returns the PE metrics.

getOutputPortCongestionFactor()

def streams.ProcessingElement.getOutputPortCongestionFactor	(		self,
			port
	)

getOperatorRelativeCost()

def streams.ProcessingElement.getOperatorRelativeCost	(		self,
			index
	)

---

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

• streams/__init__.py