Bio::MAGE::Measurement - Container module for classes in the MAGE package: Measurement
use Bio::MAGE::Measurement;
This is a package module that encapsulates a number of classes in the Bio::MAGE hierarchy. These classes belong to the Measurement package of the MAGE-OM object model.
The Bio::MAGE::Measurement module contains the following Bio::MAGE classes:
This method returns a list of non-fully qualified class names (i.e. they do not have 'Bio::MAGE::' as a prefix) in this package.
The
new() method is the class constructor.
Parameters: if given a list of name/value parameters the corresponding slots, attributes, or associations will have their initial values set by the constructor.
Return value: It returns a reference to an object of the class.
Side effects: It invokes the
initialize() method if it is defined by the class.
The
get_slot_names() method is used to retrieve the name of all slots defined in a given class.
NOTE: the list of names does not include attribute or association names.
Return value: A list of the names of all slots defined for this class.
Side effects: none
returns the list of attribute data members for this class.
returns the list of association data members for this class.
returns the list of superclasses for this class.
returns the list of subclasses for this class.
Returns the full class name for this class.
Returns the base package name (i.e. no 'namespace::') of the package that contains this class.
returns the association meta-information in a hash where the keys are the association names and the values are
Association objects that provide the meta-information for the association.
When invoked with an existing object reference and not a class name, the
new() method acts as a copy constructor - with the new object's initial values set to be those of the existing object.
Parameters: No input parameters are used in the copy constructor, the initial values are taken directly from the object to be copied.
Return value: It returns a reference to an object of the class.
Side effects: It invokes the
initialize() method if it is defined by the class.
The
set_slots() method is used to set a number of slots at the same time. It has two different invocation methods. The first takes a named parameter list, and the second takes two array references.
Return value: none
Side effects: will call
croak() if a slot_name is used that the class does not define.
The
get_slots() method is used to get the values of a number of slots at the same time.
Return value: a list of instance objects
Side effects: none
The
set_slot() method sets the slot
$name to the value
$val
Return value: the new value of the slot, i.e.
$val
Side effects: none
The
get_slot() method is used to get the values of a number of slots at the same time.
Return value: a single slot value, or undef if the slot has not been initialized.
Side effects: none
In the Perl implementation of MAGE-OM classes, there are three types of class data members:
slots,
attributes, and
associations.
This:
Retrieves the current value of the slot.
Store $new_var in the slot - the return value is also $new_var.
Returns the list of all slots in the class.
DATA CHECKING: No data type checking is made for these methods.
The terms
attribute and
association indicate data members of the class that were specified directly from the UML model.
In the Perl implementation of MAGE-OM classes, association and attribute accessors are implemented using three separate methods:
Retrieves the current value.
NOTE: For associations, if the association has list cardinality, an array reference is returned.
DATA CHECKING: Ensure that no argument is provided..
NOTE: Only present in associations with list cardinality.
Appends a list of objects to any values that may already be stored in the association.
DATA CHECKING: Ensure that all arguments are of the correct MAGE-OM class.
The unified base class of all MAGE-OM classes,
Bio::MAGE::Base, provides a set of generic methods that will operate on slots, attributes, and associations:
See elsewhere in this page for a detailed description of these methods.
Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net)
Jason E. Stewart (jasons 'at' cpan 'dot' org)
perl(1).