"Form Representation is a class representing one variant orthography of a Form." (LMF) More...

Inheritance diagram for pylmflib.pylmflib.core.form_representation.FormRepresentation:

Public Member Functions
def	__init__
	Constructor. More...

def	__del__
	Destructor. More...

def	get_speakers
	Get speakers. More...

def	set_writtenForm
	Set written form and script. More...

def	get_writtenForm
	Get written form. More...

def	set_variantForm
	Set variant form. More...

def	get_variantForm
	Get variant form. More...

def	set_type
	Set variant type. More...

def	get_type
	Get variant type. More...

def	set_comment
	Set variant form comment. More...

def	get_comment
	Get variant form comment. More...

def	set_language
	Set language used for comment. More...

def	get_language
	Get language used for comment. More...

def	set_tone
	Set tone. More...

def	get_tone
	Get tone. More...

def	set_geographicalVariant
	Set geographical variant. More...

def	get_geographicalVariant
	Get geographical variant. More...

def	set_phoneticForm
	Set phonetic form. More...

def	get_phoneticForm
	Get phonetic form. More...

def	set_contextualVariation
	Set contextual variation. More...

def	get_contextualVariation
	Get contextual variation. More...

def	set_spellingVariant
	Set spelling variant. More...

def	get_spellingVariant
	Get spelling variant. More...

def	set_citationForm
	Set citation form. More...

def	get_citationForm
	Get citation form. More...

def	set_dialect
	Set dialect. More...

def	get_dialect
	Get dialect. More...

def	set_transliteration
	Set transliteration. More...

def	get_transliteration
	Get transliteration. More...

def	set_scriptName
	Set script name. More...

def	get_scriptName
	Get script name. More...

def	create_audio
	Create an Audio instance. More...

def	get_audio
	Get the audio resource maintained by the form representation. More...

def	set_audio
	Set audio resource. More...

Public Attributes
	variantForm

	type

	transliteration

	tone

	geographicalVariant

	phoneticForm

	contextualVariation

	spellingVariant

	citationForm

	dialect

	audio
	Audio instance is owned by FormRepresentation There is zero or one Audio instance per FormRepresentation. More...

	targets

	writtenForm

	comment

	language

	scriptName

Detailed Description

"Form Representation is a class representing one variant orthography of a Form." (LMF)

Definition at line 11 of file form_representation.py.

Constructor & Destructor Documentation

def pylmflib.pylmflib.core.form_representation.FormRepresentation.__init__ ( self )

Constructor.

FormRepresentation instances are owned by Form.

Returns: A FormRepresentation instance.

Definition at line 14 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.__del__ ( self )

Destructor.

Release Audio instances.

Definition at line 40 of file form_representation.py.

Member Function Documentation

def pylmflib.pylmflib.core.form_representation.FormRepresentation.create_audio ( self )

Create an Audio instance.

Returns: Audio instance.

Definition at line 297 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_audio ( self )

Get the audio resource maintained by the form representation.

Returns: Audio instance.

Definition at line 303 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_citationForm ( self )

Get citation form.

Returns: FormRepresentation attribute 'citationForm'.

Definition at line 243 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_comment	(	self,
		language = `None`
	)

Get variant form comment.

Parameters

language If this argument is given, get comment only if written in this language.

Returns: The filtered Representation attribute 'comment'.

Definition at line 126 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_contextualVariation ( self )

Get contextual variation.

Returns: FormRepresentation attribute 'contextualVariation'.

Definition at line 211 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_dialect ( self )

Get dialect.

Returns: FormRepresentation attribute 'dialect'.

Definition at line 259 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_geographicalVariant ( self )

Get geographical variant.

Returns: FormRepresentation attribute 'geographicalVariant'.

Definition at line 179 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_language ( self )

Get language used for comment.

Returns: Representation attribute 'language'.

Definition at line 147 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_phoneticForm ( self )

Get phonetic form.

Returns: FormRepresentation attribute 'phoneticForm'.

Definition at line 195 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_scriptName ( self )

Get script name.

Returns: Representation attribute 'scriptName'.

Definition at line 291 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_speakers ( self )

Get speakers.

Returns: FormRepresentation private attribute '__speaker', a Python list of Speaker instances.

Definition at line 49 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_spellingVariant ( self )

Get spelling variant.

Returns: FormRepresentation attribute 'spellingVariant'.

Definition at line 227 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_tone ( self )

Get tone.

Returns: FormRepresentation attribute 'tone'.

Definition at line 163 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_transliteration ( self )

Get transliteration.

Returns: FormRepresentation attribute 'transliteration'.

Definition at line 275 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_type ( self )

Get variant type.

Returns: FormRepresentation attribute 'type'.

Definition at line 106 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_variantForm ( self )

Get variant form.

Returns: FormRepresentation attribute 'variantForm'.

Definition at line 86 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.get_writtenForm	(	self,
		script_name = `None`
	)

Get written form.

Parameters

script_name If this argument is given, get written form only if written using this script.

Returns: The filtered Representation attribute 'writtenForm'.

Definition at line 68 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_audio	(	self,
		media_type,
		file_name,
		author,
		quality,
		start_position,
		duration,
		external_reference,
		audio_file_format
	)

Set audio resource.

Attributes 'mediaType', 'fileName', 'author', 'quality', 'startPosition', 'durationOfEffectiveSpeech', 'externalReference', 'audioFileFormat' are owned by Material/Audio.

Parameters

media_type	The media type to set.
file_name	Name of the audio file.
author	Author of the recording.
quality	Quality of the recording, in range 'quality_range' defined in 'common/range.py'.
start_position	Start position of the form in the recording, in format 'Thh:mm:ss,msms', e.g. "T00:05:00".
duration	Duration of the effcetive speech, in format 'PThhHmmMssS', e.g. "PT00:05:00".
external_reference	Reference of the audio file, if not directly provided.
audio_file_format	Format of the audio file, e.g. "wav".

Returns: FormRepresentation instance.

Definition at line 309 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_citationForm	(	self,
		citation_form
	)

Set citation form.

Parameters

citation_form The citation form to set.

Returns: FormRepresentation instance.

Definition at line 233 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_comment	(	self,
		comment,
		language = `None`
	)

Set variant form comment.

Parameters

comment	Comment about the variant form.
language	Language used for the comment.

Returns: FormRepresentation instance.

Definition at line 112 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_contextualVariation	(	self,
		contextual_variation
	)

Set contextual variation.

Parameters

contextualVariation The contextual variation to set.

Returns: FormRepresentation instance.

Definition at line 201 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_dialect	(	self,
		dialect
	)

Set dialect.

Parameters

dialect The dialect to set.

Returns: FormRepresentation instance.

Definition at line 249 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_geographicalVariant	(	self,
		geographical_variant
	)

Set geographical variant.

Parameters

geographical_variant The geographical variant to set.

Returns: FormRepresentation instance.

Definition at line 169 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_language	(	self,
		language
	)

Set language used for comment.

Parameters

language Language used for the comment.

Returns: FormRepresentation instance.

Definition at line 136 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_phoneticForm	(	self,
		phonetic_form
	)

Set phonetic form.

Parameters

phonetic_form The phonetic form to set.

Returns: FormRepresentation instance.

Definition at line 185 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_scriptName	(	self,
		script_name
	)

Set script name.

Parameters

script_name The script name to set.

Returns: FormRepresentation instance.

Definition at line 281 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_spellingVariant	(	self,
		spelling_variant
	)

Set spelling variant.

Parameters

spelling_variant The spelling variant to set.

Returns: FormRepresentation instance.

Definition at line 217 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_tone	(	self,
		tone
	)

Set tone.

Parameters

tone	The tone to set.

Returns: FormRepresentation instance.

Definition at line 153 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_transliteration	(	self,
		transliteration
	)

Set transliteration.

Parameters

transliteration The transliteration to set.

Returns: FormRepresentation instance.

Definition at line 265 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_type	(	self,
		type
	)

Set variant type.

Parameters

type	Type of variant, in range 'type_variant_range' defined in 'common/range.py'.

Returns: FormRepresentation instance.

Definition at line 92 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_variantForm	(	self,
		variant_form
	)

Set variant form.

Parameters

variant_form The variant form to set.

Returns: FormRepresentation instance.

Definition at line 76 of file form_representation.py.

def pylmflib.pylmflib.core.form_representation.FormRepresentation.set_writtenForm	(	self,
		written_form,
		script_name = `None`
	)

Set written form and script.

Parameters

written_form	The written form to set.
script_name	Script used for the written form.

Returns: FormRepresentation instance.

Definition at line 55 of file form_representation.py.

Member Data Documentation

pylmflib.pylmflib.core.form_representation.FormRepresentation.audio

Audio instance is owned by FormRepresentation There is zero or one Audio instance per FormRepresentation.

Definition at line 33 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.citationForm

Definition at line 29 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.comment

Definition at line 121 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.contextualVariation

Definition at line 27 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.dialect

Definition at line 30 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.geographicalVariant

Definition at line 25 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.language

Definition at line 144 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.phoneticForm

Definition at line 26 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.scriptName

Definition at line 288 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.spellingVariant

Definition at line 28 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.targets

Definition at line 35 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.tone

Definition at line 24 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.transliteration

Definition at line 23 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.type

Definition at line 22 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.variantForm

Definition at line 21 of file form_representation.py.

pylmflib.pylmflib.core.form_representation.FormRepresentation.writtenForm

Definition at line 63 of file form_representation.py.

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

/Users/celine/Work/CNRS/workspace/pylmflib/pylmflib/core/form_representation.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation