MAGE::...Design(3pm)

πŸ’… MAGE::...Design(3pm) πŸ’…

okay so bestie, welcome to the User Contributed Perl Documentation corner of the terminal, where the manual page is literally called MAGE::...Design(3pm) (yes, with the dots, she's mysterious like that ✨). buckle up, we're reading the whole thing, no skimming, no skipping. 🫢


✨ NAME ✨

Bio::MAGE::Experiment::ExperimentDesign β€” a whole class for the MAGE-OM API. she's the blueprint girlie for experiment designs and she knows it. πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

here's the vibe check, in code:

use Bio::MAGE::Experiment::ExperimentDesign

# creating an empty instance
my $experimentdesign = Bio::MAGE::Experiment::ExperimentDesign->new();

# creating an instance with existing data
my $experimentdesign = Bio::MAGE::Experiment::ExperimentDesign->new(
      replicateDescription=>$description_ref,
      experimentalFactors=>\@experimentalfactor_list,
      types=>\@ontologyentry_list,
      qualityControlDescription=>$description_ref,
      normalizationDescription=>$description_ref,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      topLevelBioAssays=>\@bioassay_list,
      descriptions=>\@description_list,
      security=>$security_ref,
);

# 'replicateDescription' association
my $description_ref = $experimentdesign->replicateDescription(); # getter
$experimentdesign->replicateDescription($description_ref); # setter

# 'experimentalFactors' association
my $experimentalfactor_array_ref = $experimentdesign->experimentalFactors(); # getter
$experimentdesign->experimentalFactors(\@experimentalfactor_list); # setter

# 'types' association
my $ontologyentry_array_ref = $experimentdesign->types(); # getter
$experimentdesign->types(\@ontologyentry_list); # setter

# 'qualityControlDescription' association
my $description_ref = $experimentdesign->qualityControlDescription(); # getter
$experimentdesign->qualityControlDescription($description_ref); # setter

# 'normalizationDescription' association
my $description_ref = $experimentdesign->normalizationDescription(); # getter
$experimentdesign->normalizationDescription($description_ref); # setter

# 'auditTrail' association
my $audit_array_ref = $experimentdesign->auditTrail(); # getter
$experimentdesign->auditTrail(\@audit_list); # setter

# 'propertySets' association
my $namevaluetype_array_ref = $experimentdesign->propertySets(); # getter
$experimentdesign->propertySets(\@namevaluetype_list); # setter

# 'topLevelBioAssays' association
my $bioassay_array_ref = $experimentdesign->topLevelBioAssays(); # getter
$experimentdesign->topLevelBioAssays(\@bioassay_list); # setter

# 'descriptions' association
my $description_array_ref = $experimentdesign->descriptions(); # getter
$experimentdesign->descriptions(\@description_list); # setter

# 'security' association
my $security_ref = $experimentdesign->security(); # getter
$experimentdesign->security($security_ref); # setter

see how every association gets a getter and a setter? that's the whole pattern, bestie. getter pulls the value out, setter shoves a new one in. πŸ’–


🌸 DESCRIPTION 🌸

straight from the MAGE-OM documentation for the "ExperimentDesign" class, and I quote:

The ExperimentDesign is the description and collection of ExperimentalFactors and the hierarchy of BioAssays to which they pertain.

so basically: she's the description, she collects the ExperimentalFactors, and she holds the whole hierarchy of BioAssays those factors belong to. main character behavior fr. πŸ‘‘


🧚 INHERITANCE 🧚

Bio::MAGE::Experiment::ExperimentDesign has the following superclasses:

  • Bio::MAGE::Describable

so she inherited the Describable genes and she's wearing them well. πŸ’œ


πŸ‘‘ CLASS METHODS πŸ‘‘

The following methods can all be called without first having an instance of the class via the Bio::MAGE::Experiment::ExperimentDesign->methodname() syntax. no object needed, just call her like she's already famous. ✨

πŸŽ€ new()

πŸŽ€ new(%args)

The object constructor new() accepts the following optional named-value style arguments. optional!! so you can pass none, some, or all:

  • replicateDescription β€” Sets the value of the "replicateDescription" association.

The value must be of type: instance of Bio::MAGE::Description::Description.

  • types β€” Sets the value of the "types" association.

The value must be of type: array of Bio::MAGE::Description::OntologyEntry.

  • experimentalFactors β€” Sets the value of the "experimentalFactors" association.

The value must be of type: array of Bio::MAGE::Experiment::ExperimentalFactor.

  • qualityControlDescription β€” Sets the value of the "qualityControlDescription" association.

The value must be of type: instance of Bio::MAGE::Description::Description.

  • auditTrail β€” Sets the value of the "auditTrail" association (this association was inherited from class Bio::MAGE::Describable).

The value must be of type: array of Bio::MAGE::AuditAndSecurity::Audit.

  • normalizationDescription β€” Sets the value of the "normalizationDescription" association.

The value must be of type: instance of Bio::MAGE::Description::Description.

  • propertySets β€” Sets the value of the "propertySets" association (this association was inherited from class Bio::MAGE::Extendable).

The value must be of type: array of Bio::MAGE::NameValueType.

  • descriptions β€” Sets the value of the "descriptions" association (this association was inherited from class Bio::MAGE::Describable).

The value must be of type: array of Bio::MAGE::Description::Description.

  • topLevelBioAssays β€” Sets the value of the "topLevelBioAssays" association.

The value must be of type: array of Bio::MAGE::BioAssay::BioAssay.

  • security β€” Sets the value of the "security" association (this association was inherited from class Bio::MAGE::Describable).

The value must be of type: instance of Bio::MAGE::AuditAndSecurity::Security.

πŸ’« $obj = class->new(%parameters)

The new() method is the class constructor. the origin story, if you will. 🌈

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.

πŸ’« @names = class->get_slot_names()

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. so don't come for her about missing attributes, she told you upfront. πŸ’€

Return value: A list of the names of all slots defined for this class.

Side effects: none

πŸ’« @name_list = get_attribute_names()

returns the list of attribute data members for this class.

πŸ’« @name_list = get_association_names()

returns the list of association data members for this class.

πŸ’« @class_list = get_superclasses()

returns the list of superclasses for this class.

πŸ’« @class_list = get_subclasses()

returns the list of subclasses for this class.

πŸ’« $name = class_name()

Returns the full class name for this class.

πŸ’« $package_name = package_name()

Returns the base package name (i.e. no 'namespace::') of the package that contains this class.

πŸ’« %assns = associations()

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.


🫢 INSTANCE METHODS 🫢

πŸ“ $obj_copy = $obj->new()

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. it's giving clone era. πŸ‘―

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.

πŸ“ $obj->set_slots(%parameters)

πŸ“ $obj->set_slots(@name_list, @value_list)

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. so like, read the room and use real slot names or she will croak at you. 😭

πŸ“ @obj_list = $obj->get_slots(@name_list)

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

πŸ“ $val = $obj->set_slot($name,$val)

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

πŸ“ $val = $obj->get_slot($name)

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


πŸŽ€ ATTRIBUTES πŸŽ€

Attributes are simple data types that belong to a single instance of a class. In the Perl implementation of the MAGE-OM classes, the interface to attributes is implemented using separate setter and getter methods for each attribute.

Bio::MAGE::Experiment::ExperimentDesign has the following attribute accessor methods:

and that's it β€” that list is empty, bestie. she said "no attributes, only associations" and honestly? iconic. πŸ’…

πŸŽ€ ASSOCIATIONS πŸŽ€

Associations are references to other classes. Associations in MAGE-OM have a cardinality that determines the minimum and maximum number of instances of the 'other' class that maybe included in the association. here's the cardinality tea:

  1. There must be exactly one item in the association, i.e. this is a mandatory data field.
  2. 0..1

There may be one item in the association, i.e. this is an optional data field.

  1. 1..N

There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.

  1. 0..N

There may be one or more items in the association, i.e. this is an optional data field, with list cardinality.

Bio::MAGE::Experiment::ExperimentDesign has the following association accessor methods:

πŸ’– replicateDescription πŸ’–

Methods for the "replicateDescription" association.

From the MAGE-OM documentation:

Description of the replicate strategy of the Experiment.

$val = $experimentdesign->setReplicateDescription($val)

The restricted setter method for the "replicateDescription" association.

Input parameters: the value to which the "replicateDescription" association will be set : one of the accepted enumerated values.

Return value: the current value of the "replicateDescription" association : one of the accepted enumerated values.

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::Description::Description


  • $val = $experimentdesign->getReplicateDescription() β€” the restricted getter for the replicateDescription association. She only reads, bestie, no writing πŸ’…
    • Input parameters: none
    • Return value: the current value of the replicateDescription association : an instance of type Bio::MAGE::Description::Description.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

types ✨

Methods for the types association.

From the MAGE-OM documentation:

Classification of an experiment. For example 'normal vs. diseased', 'treated vs. untreated', 'time course', 'tiling', etc.
  • $array_ref = $experimentdesign->setTypes($array_ref) β€” the restricted setter for the types association. Setting the whole vibe at once 🫢
    • Input parameters: the value to which the types association will be set : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry
    • Return value: the current value of the types association : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::Description::OntologyEntry instances
  • $array_ref = $experimentdesign->getTypes() β€” the restricted getter for the types association. Just peeking πŸ‘€
    • Input parameters: none
    • Return value: the current value of the types association : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $experimentdesign->addTypes(@vals) β€” okay so because the types association has list cardinality, it may store more than one value. This method adds the current list of objects in the types association. She's not a one-value-only girlie, she holds many πŸŽ€
    • Input parameters: the list of values @vals to add to the types association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::Description::OntologyEntry

experimentalFactors πŸ”₯

Methods for the experimentalFactors association.

From the MAGE-OM documentation:

The description of the factors (TimeCourse, Dosage, etc.) that group the BioAssays.
  • $array_ref = $experimentdesign->setExperimentalFactors($array_ref) β€” the restricted setter for the experimentalFactors association. Dropping the whole array in, periodt πŸ’œ
    • Input parameters: the value to which the experimentalFactors association will be set : a reference to an array of objects of type Bio::MAGE::Experiment::ExperimentalFactor
    • Return value: the current value of the experimentalFactors association : a reference to an array of objects of type Bio::MAGE::Experiment::ExperimentalFactor
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::Experiment::ExperimentalFactor instances
  • $array_ref = $experimentdesign->getExperimentalFactors() β€” the restricted getter for the experimentalFactors association.
    • Input parameters: none
    • Return value: the current value of the experimentalFactors association : a reference to an array of objects of type Bio::MAGE::Experiment::ExperimentalFactor
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $experimentdesign->addExperimentalFactors(@vals) β€” because the experimentalFactors association has list cardinality, it may store more than one value. This method adds the current list of objects in the experimentalFactors association. Feeding her more factors, she eats every time πŸ“
    • Input parameters: the list of values @vals to add to the experimentalFactors association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::Experiment::ExperimentalFactor

qualityControlDescription 🌸

Methods for the qualityControlDescription association.

From the MAGE-OM documentation:

Description of the quality control aspects of the Experiment.
  • $val = $experimentdesign->setQualityControlDescription($val) β€” the restricted setter for the qualityControlDescription association.
    • Input parameters: the value to which the qualityControlDescription association will be set : one of the accepted enumerated values.
    • Return value: the current value of the qualityControlDescription association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::Description::Description
  • $val = $experimentdesign->getQualityControlDescription() β€” the restricted getter for the qualityControlDescription association.
    • Input parameters: none
    • Return value: the current value of the qualityControlDescription association : an instance of type Bio::MAGE::Description::Description.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

auditTrail πŸ‘‘

Methods for the auditTrail association.

From the MAGE-OM documentation:

A list of Audit instances that track changes to the instance of Describable.
  • $array_ref = $experimentdesign->setAuditTrail($array_ref) β€” the restricted setter for the auditTrail association. The receipts of who changed what, iconic πŸŽ€
    • Input parameters: the value to which the auditTrail association will be set : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::AuditAndSecurity::Audit instances
  • $array_ref = $experimentdesign->getAuditTrail() β€” the restricted getter for the auditTrail association.
    • Input parameters: none
    • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $experimentdesign->addAuditTrail(@vals) β€” because the auditTrail association has list cardinality, it may store more than one value. This method adds the current list of objects in the auditTrail association. Piling up the audit receipts, no cap πŸ’€
    • Input parameters: the list of values @vals to add to the auditTrail association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class Bio::MAGE::AuditAndSecurity::Audit

normalizationDescription πŸ¦‹

Methods for the normalizationDescription association.

From the MAGE-OM documentation:

Description of the normalization strategy of the Experiment.
  • $val = $experimentdesign->setNormalizationDescription($val) β€” the restricted setter for the normalizationDescription association.
    • Input parameters: the value to which the normalizationDescription association will be set : one of the accepted enumerated values.
    • Return value: the current value of the normalizationDescription association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::Description::Description
  • $val = $experimentdesign->getNormalizationDescription() β€” the restricted getter for the normalizationDescription association.
    • Input parameters: none
    • Return value: the current value of the normalizationDescription association : an instance of type Bio::MAGE::Description::Description.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

propertySets 🧚

Methods for the propertySets association.

From the MAGE-OM documentation:

Allows specification of name/value pairs. Meant to primarily help in-house, pipeline processing of instances by providing a place for values that aren't part of the specification proper.
  • $array_ref = $experimentdesign->setPropertySets($array_ref) β€” the restricted setter for the propertySets association. Your little name/value stash for whatever the spec didn't cover, iykyk πŸ’œ
    • Input parameters: the value to which the propertySets association will be set : a reference to an array of objects of type Bio::MAGE::NameValueType
    • Return value: the current value of the propertySets association : a reference to an array of objects of type Bio::MAGE::NameValueType
    • Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class "Bio::MAGE::NameValueType" instances. πŸ’…

  • $array_ref = $experimentdesign->getPropertySets() β€” The restricted getter method for the "propertySets" association. ✨
    • Input parameters: none
    • Return value: the current value of the "propertySets" association : a reference to an array of objects of type "Bio::MAGE::NameValueType"
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $experimentdesign->addPropertySets(@vals) β€” Because the propertySets association has list cardinality, it may store more than one value. This method adds the current list of objects in the propertySets association. πŸ”₯
    • Input parameters: the list of values @vals to add to the propertySets association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class "Bio::MAGE::NameValueType"

πŸ’– descriptions πŸ’–

Methods for the "descriptions" association.

From the MAGE-OM documentation:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
  • $array_ref = $experimentdesign->setDescriptions($array_ref) β€” The restricted setter method for the "descriptions" association. πŸŽ€
    • Input parameters: the value to which the "descriptions" association will be set : a reference to an array of objects of type "Bio::MAGE::Description::Description"
    • Return value: the current value of the "descriptions" association : a reference to an array of objects of type "Bio::MAGE::Description::Description"
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class "Bio::MAGE::Description::Description" instances
  • $array_ref = $experimentdesign->getDescriptions() β€” The restricted getter method for the "descriptions" association. πŸ¦‹
    • Input parameters: none
    • Return value: the current value of the "descriptions" association : a reference to an array of objects of type "Bio::MAGE::Description::Description"
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $experimentdesign->addDescriptions(@vals) β€” Because the descriptions association has list cardinality, it may store more than one value. This method adds the current list of objects in the descriptions association. 🌸
    • Input parameters: the list of values @vals to add to the descriptions association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class "Bio::MAGE::Description::Description"

πŸ’– topLevelBioAssays πŸ’–

Methods for the "topLevelBioAssays" association.

From the MAGE-OM documentation:

The organization of the BioAssays as specified by the ExperimentDesign (TimeCourse, Dosage, etc.)
  • $array_ref = $experimentdesign->setTopLevelBioAssays($array_ref) β€” The restricted setter method for the "topLevelBioAssays" association. 🧚
    • Input parameters: the value to which the "topLevelBioAssays" association will be set : a reference to an array of objects of type "Bio::MAGE::BioAssay::BioAssay"
    • Return value: the current value of the "topLevelBioAssays" association : a reference to an array of objects of type "Bio::MAGE::BioAssay::BioAssay"
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class "Bio::MAGE::BioAssay::BioAssay" instances
  • $array_ref = $experimentdesign->getTopLevelBioAssays() β€” The restricted getter method for the "topLevelBioAssays" association. 🌈
    • Input parameters: none
    • Return value: the current value of the "topLevelBioAssays" association : a reference to an array of objects of type "Bio::MAGE::BioAssay::BioAssay"
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $experimentdesign->addTopLevelBioAssays(@vals) β€” Because the topLevelBioAssays association has list cardinality, it may store more than one value. This method adds the current list of objects in the topLevelBioAssays association. ⭐
    • Input parameters: the list of values @vals to add to the topLevelBioAssays association. NOTE: submitting a single value is permitted.
    • Return value: the number of items stored in the slot after adding @vals
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class "Bio::MAGE::BioAssay::BioAssay"

πŸ’– security πŸ’–

Methods for the "security" association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.
  • $val = $experimentdesign->setSecurity($val) β€” The restricted setter method for the "security" association. πŸ”
    • Input parameters: the value to which the "security" association will be set : one of the accepted enumerated values.
    • Return value: the current value of the "security" association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class "Bio::MAGE::AuditAndSecurity::Security"
  • $val = $experimentdesign->getSecurity() β€” The restricted getter method for the "security" association. πŸ›‘οΈ
    • Input parameters: none
    • Return value: the current value of the "security" association : an instance of type "Bio::MAGE::AuditAndSecurity::Security".
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
sub initialize {

  my $self = shift;
  return 1;

}

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

In the Perl implementation of MAGE-OM classes, there are three types of class data members: "slots", "attributes", and "associations".

🌸 SLOTS 🌸

This API uses the term "slot" to indicate a data member of the class that was not present in the UML model and is used for mainly internal purposes - use only if you understand the inner workings of the API. Most often slots are used by generic methods such as those in the XML writing and reading classes.

Slots are implemented using unified getter/setter methods:

  • $var = $obj->slot_name(); β€” Retrieves the current value of the slot. ✨
  • $new_var = $obj->slot_name($new_var); β€” Store $new_var in the slot - the return value is also $new_var. πŸ’–
  • @names = $obj->get_slot_names() β€” Returns the list of all slots in the class. πŸ‘‘

DATA CHECKING: No data type checking is made for these methods. πŸ’…

🌸 ATTRIBUTES AND ASSOCIATIONS 🌸

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:

  • get* β€” 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.
  • set* β€” Sets the current value, replacing any existing value. ✏️
    • NOTE: For associations, if the association has list cardinality, the argument must be an array reference. Because of this, you probably should be using the add* methods.
    • DATA CHECKING: For attributes, ensure that a single value is provided as the argument. For associations, if the association has list cardinality, ensure that the argument is a reference to an array of instances of the correct MAGE-OM class, otherwise ensure that there is a single argument of the correct MAGE-OM class.
  • add* β€” 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.

🌸 GENERIC METHODS 🌸

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:

$val = $obj->get_slot($name)
\@list_ref = $obj->get_slots(@name_list);
$val = $obj->set_slot($name,$val)
$obj->set_slots(%parameters)
$obj->set_slots(\@name_list, \@value_list)

See elsewhere in this page for a detailed description of these methods. 🫢


πŸ› BUGS πŸ›

Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net)

πŸ‘‘ AUTHOR πŸ‘‘

Jason E. Stewart (jasons 'at' cpan 'dot' org)

🌈 SEE ALSO 🌈

perl(1).

πŸ’€ POD ERRORS πŸ’€

Hey! The above document had some coding errors, which are explained below:

  • Around line 494:
    • '=item' outside of any '=over'
  • Around line 579:
    • You forgot a '=back' before '=head2'
  • Around line 607:
    • Expected '=item 2'
  • Around line 612:
    • Expected '=item 3'
  • Around line 617:
    • Expected '=item 4'

This page was served by perl v5.32.0 on 2020-11-27 for MAGE::...Design(3pm). Bye bestie, stay iconic! πŸ’–βœ¨πŸ‘‘