Package gen :: Package lib :: Module event :: Class Event

Class Event

Introduction

The Event record is used to store information about some type of action that occurred at a particular place at a particular time, such as a birth, death, or marriage.

Instance Methods

__init__(self, source=None)
Create a new Event instance, copying from the source if present.

source code

tuple

serialize(self, no_text_date=False)
Convert the data held in the event to a Python tuple that represents all the data elements.

source code

unserialize(self, data)
Convert the data held in a tuple created by the serialize method back into the data in an Event structure.

source code

list

get_text_data_list(self)
Return the list of all textual attributes of the object.

source code

list

get_text_data_child_list(self)
Return the list of child objects that may carry textual data.

source code

list

get_sourcref_child_list(self)
Return the list of child secondary objects that may refer sources.

source code

list

get_note_child_list(self)
Return the list of child secondary objects that may refer notes.

source code

list

get_referenced_handles(self)
Return the list of (classname, handle) tuples for all directly referenced primary objects.

source code

list

get_handle_referents(self)
Return the list of child objects which may, directly or through their children, reference primary objects.

source code

bool

is_empty(self)
Return True if the Event is an empty object (no values set).

source code

bool

are_equal(self, other)
Return True if the passed Event is equivalent to the current Event.

source code

set_type(self, the_type)
Set the type of the Event to the passed (int,str) tuple.

source code

tuple

get_type(self)
Return the type of the Event.

source code

set_description(self, description)
Set the description of the Event to the passed string.

source code

str

get_description(self)
Return the description of the Event.

source code

Inherited from srcbase.SourceBase: add_source_reference, get_source_references, has_source_reference, remove_source_references, replace_source_references, set_source_reference_list

Inherited from notebase.NoteBase: add_note, get_note_list, get_referenced_note_handles, remove_note, set_note_list

Inherited from mediabase.MediaBase: add_media_reference, get_media_list, has_media_reference, remove_media_references, replace_media_references, set_media_list

Inherited from attrbase.AttributeBase: add_attribute, get_attribute_list, remove_attribute, set_attribute_list

Inherited from datebase.DateBase: get_date_object, set_date_object

Inherited from placebase.PlaceBase: get_place_handle, set_place_handle

Inherited from primaryobj.PrimaryObject: get_marker, has_handle_reference, remove_handle_references, replace_handle_reference, set_marker

Inherited from primaryobj.BasicPrimaryObject: get_change_display, get_change_time, get_gramps_id, get_handle, set_gramps_id, set_handle

Inherited from baseobj.BaseObject: get_referenced_handles_recursively, matches_regexp, matches_string

Inherited from privacybase.PrivacyBase: get_privacy, set_privacy

Method Details

init(self, source=None)
(Constructor)

source code

Create a new Event instance, copying from the source if present.

Parameters:

source (Event) - An event used to initialize the new event

Overrides: privacybase.PrivacyBase.__init__

serialize(self, no_text_date=False)

source code

Convert the data held in the event to a Python tuple that represents all the data elements.

This method is used to convert the object into a form that can easily be saved to a database.

These elements may be primative Python types (string, integers), complex Python types (lists or tuples, or Python objects. If the target database cannot handle complex types (such as objectes or lists), the database is responsible for converting the data into a form that it can use.

Returns: tuple: Returns a python tuple containing the data that should be considered persistent.
Overrides: privacybase.PrivacyBase.serialize