ValueIn Class Reference

Defines a CAPS input Value Object. More...

Inheritance diagram for ValueIn:

Public Member Functions
def	value (self)
	Property getter returns a copy the values stored in the CAPS Value Object.
def	value (self, val)
	Property setter sets the value in the CAPS Value Object.
def	limits (self)
	Property getter returns a copy the limits of the CAPS Value Object.
def	limits (self, limit)
	Property setter sets the limits in the CAPS Value Object (if changable)
def	name (self)
	Property returns the name of the CAPS Value Object.
def	history (self)
	Returns the history list of the CAPS Value Object.
def	props (self)
	Returns the CAPS Value Object properties.
def	link (self, source, tmethod=caps.tMethod.Copy)
	Link this input value to an other CAPS Value Object. More...
def	unlink (self)
	Remove an existing link.
def	transferValue (self, tmethod, source)
	Transfer values from src to self. More...
def	stepSize (self)
	Property getter returns a copy the OpenCSM finite difference step sizes of the CAPS Value Object.
def	stepSize (self, sizes)
	Property setter sets and uses OpenCSM finite difference step sizes in the CAPS Value Object.

Detailed Description

Defines a CAPS input Value Object.

Member Function Documentation

link()

def link	(		self,
			source,
			tmethod = caps.tMethod.Copy
	)

Link this input value to an other CAPS Value Object.

Parameters

source	The source Value Object
tmethod	Transfter method: tMethod.Copy or "Copy", tMethod.Integrate or "Integrate", tMethod.Average or "Average"

transferValue()

def transferValue	(		self,
			tmethod,
			source
	)

Transfer values from src to self.

Parameters

tmethod	0 - copy, 1 - integrate, 2 - weighted average – (1 & 2 only for DataSet src)
source	the source value object

---

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

• pyCAPS/problem.py