util.attitunes.Attitune.Attitune Class Reference

Inheritance diagram for util.attitunes.Attitune.Attitune:

Collaboration diagram for util.attitunes.Attitune.Attitune:

Public Member Functions
def	__init__ (self, parent, dictionary, attFile, workingPath, observerName)
def	getWorkingPath (self)
def	getAttFile (self)
def	getDictionary (self)
def	getContainer (self)
def	getObserverName (self)
def	getDescription (self)
def	getMacro (self, begin=0.0)

Private Member Functions
def	__buildPreMacro (self)

Private Attributes
	__parent
	__dictionary
	__workingPath
	__attFile
	__observerName
	__description
	__wavs
	__blocksStruct
	__blocksKeys
	__macroStruct

Detailed Description

Attitune class.

Constructor & Destructor Documentation

__init__()

def util.attitunes.Attitune.Attitune.__init__	(		self,
			parent,
			dictionary,
			attFile,
			workingPath,
			observerName
	)

Constructor of the class.
@param parent: Parent Gadgets container.
@param dictionary: Gadget structure as dictionary.
@param attFile: ATT file name of the attitune.
@param workingPath: Working path of the attitune.
@param observerName: Observer name.

Member Function Documentation

__buildPreMacro()

def util.attitunes.Attitune.Attitune.__buildPreMacro (   self )

private

Convert the attitunes timeline to macro.

getAttFile()

def util.attitunes.Attitune.Attitune.getAttFile

(

self

)

Get the ATT file of the gadget.
@return: A string.

getContainer()

def util.attitunes.Attitune.Attitune.getContainer

(

self

)

Get the parent attitunes container.
@return: The parent attitunes container.

getDescription()

def util.attitunes.Attitune.Attitune.getDescription

(

self

)

Get the attitune description object.
@return: The attitune description object.

getDictionary()

def util.attitunes.Attitune.Attitune.getDictionary

(

self

)

Get the dictionary of the attitune.
@return: A dictionary.

getMacro()

def util.attitunes.Attitune.Attitune.getMacro	(		self,
			begin = 0.0
	)

Get a macro from the attitunes.
@param begin: The time begin index in seconds.
@return: The macro as string.

getObserverName()

def util.attitunes.Attitune.Attitune.getObserverName

(

self

)

Get the observer name.
@return: A string.

getWorkingPath()

def util.attitunes.Attitune.Attitune.getWorkingPath

(

self

)

Get the directory path where this attitune is uncompressed.
@return: A directory path as string.

Member Data Documentation

__attFile

util.attitunes.Attitune.Attitune.__attFile

private

__blocksKeys

util.attitunes.Attitune.Attitune.__blocksKeys

private

__blocksStruct

util.attitunes.Attitune.Attitune.__blocksStruct

private

__description

util.attitunes.Attitune.Attitune.__description

private

__dictionary

util.attitunes.Attitune.Attitune.__dictionary

private

__macroStruct

util.attitunes.Attitune.Attitune.__macroStruct

private

__observerName

util.attitunes.Attitune.Attitune.__observerName

private

__parent

util.attitunes.Attitune.Attitune.__parent

private

__wavs

util.attitunes.Attitune.Attitune.__wavs

private

__workingPath

util.attitunes.Attitune.Attitune.__workingPath

private

---

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

• util/attitunes/Attitune.py