__init__ (
        self,
        action="",
        type="",
        src="",
        hdr=-1,
        )

Constructor method initializing the object class variables.

action Action for the object. See documentation for FtuFttAction class for constants.

type Type of the Value Source.

src Reference of the Value Source. In case of a keyword the key name, in case of a constant, the constant value, in case of a function, the function name.

hdr Header related to a Keyword Value Source. "-1" indicates that the value should be taken from the default header (current header).

dumpBuf ( self,  action="" )

Dump contents of object into a PAF keyword line.

Returns: String object with the Value Source PAF keyword line.

getAction ( self )

Return the Translation Action for the object.

Returns: Translation Action.

getHdr ( self )

Return the header reference for a Key Value Source.

Returns: Header number. "-1" is returned is not used.

getSrc ( self )

Return the Value Source reference of the object.

Returns: Value Source.

getType ( self )

Return type of Value Source.

Returns: Type of Value Source.

setAction ( self,  action )

Set the Translation Action of the Value Source Object.

action Translation Action. See documentation for class FtuFttAction for definition of actions.

Returns: Reference to object itself.

setFromPaf (
        self,
        keyCount,
        fttPafObj,
        )

Set the information of the object from the keywords found in the PccPaf object containing an FTT, starting from the keyword indicated by "keyCount".

keyCount

fttPafObj

Returns: Updated keyword counter (index).

exceptions.Exception

setFromPafLine ( self,  pafLine )

Set the object class variables from a PAF keyword line.

pafLine PAF keyword line.

Returns: Reference to the object itself.

setHdr ( self,  hdr )

Set the header reference for a Key Value Source.

hdr Header number.

Returns: Reference to object itself.

setSrc ( self,  src )

Set the Value Source reference. I.e., from where to take the value (keyword name, constant value, function name).

src Value Source reference.

Returns: Reference to object itself.

setType ( self,  type )

Set type of the Value Source.

type Type of Value Source. Check documentation for this class for defined types.

Returns: Reference to object itself.

setValueSrc (
        self,
        type,
        src,
        action,
        )

Set the properties of the Value Source.

type Type of Value Source.

src Source Reference.

action Action in which context the Value Source is defined

Returns: Reference to the object itself.