MAGE::...Sample(3pm)

📦 version 20030502.3, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 NAME 💖

Bio::MAGE::BioMaterial::BioSample — the class for the MAGE-OM API, bestie. This is it. This is the one. (You'll also see it hanging out in the manual as MAGE::...Sample(3pm), User Contributed Perl Documentation, if you're being all formal about it. We are not. 💅)

✨ SYNOPSIS ✨

Okay so here's the whole vibe in code form, no cap:

use Bio::MAGE::BioMaterial::BioSample

# creating an empty instance
my $biosample = Bio::MAGE::BioMaterial::BioSample->new();

# creating an instance with existing data
my $biosample = Bio::MAGE::BioMaterial::BioSample->new(
      identifier=>$identifier_val,
      name=>$name_val,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      qualityControlStatistics=>\@namevaluetype_list,
      descriptions=>\@description_list,
      characteristics=>\@ontologyentry_list,
      treatments=>\@treatment_list,
      security=>$security_ref,
      type=>$ontologyentry_ref,
      materialType=>$ontologyentry_ref,
);

# 'identifier' attribute
my $identifier_val = $biosample->identifier(); # getter
$biosample->identifier($value); # setter

# 'name' attribute
my $name_val = $biosample->name(); # getter
$biosample->name($value); # setter

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

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

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

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

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

# 'treatments' association
my $treatment_array_ref = $biosample->treatments(); # getter
$biosample->treatments(\@treatment_list); # setter

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

# 'type' association
my $ontologyentry_ref = $biosample->type(); # getter
$biosample->type($ontologyentry_ref); # setter

# 'materialType' association
my $ontologyentry_ref = $biosample->materialType(); # getter
$biosample->materialType($ontologyentry_ref); # setter

🌸 DESCRIPTION 🌸

Straight from the MAGE-OM documentation for the "BioSample" class, okay, quoting them directly:

BioSamples are products of treatments that are of interest. BioSamples are often used as the sources for other biosamples. The Type attribute describes the role the BioSample holds in the treatment hierarchy. This type can be an extract.

So like... a BioSample is the result of treatments (the glow-up, if you will), and then other biosamples can be born from it. Iconic lineage behavior honestly. 🧬✨

👑 INHERITANCE 👑

Bio::MAGE::BioMaterial::BioSample has these superclasses — its ancestors, its roots, its whole lineage:

  • Bio::MAGE::BioMaterial::BioMaterial

🔥 CLASS METHODS 🔥

The way these work: you do not need an instance first. You can call every single one of them straight off the class using the Bio::MAGE::BioMaterial::BioSample->methodname() syntax. Main character energy fr fr.

new()

new(%args)

The object constructor "new()" accepts these optional named-value style arguments, and yes we're listing all of them because we don't skip:

  • identifier — sets the value of the "identifier" attribute. (This attribute was inherited from the class "Bio::MAGE::Identifiable".)
  • name — sets the value of the "name" attribute. (This attribute was inherited from the class "Bio::MAGE::Identifiable".)
  • auditTrail — sets the value of the "auditTrail" association. (This association was inherited from the class "Bio::MAGE::Describable".)

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

  • propertySets — sets the value of the "propertySets" association. (This association was inherited from the class "Bio::MAGE::Extendable".)

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

  • qualityControlStatistics — sets the value of the "qualityControlStatistics" association. (This association was inherited from the class "Bio::MAGE::BioMaterial::BioMaterial".)

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

  • treatments — sets the value of the "treatments" association. (This association was inherited from the class "Bio::MAGE::BioMaterial::BioMaterial".)

The value must be of type: array of "Bio::MAGE::BioMaterial::Treatment".

  • characteristics — sets the value of the "characteristics" association. (This association was inherited from the class "Bio::MAGE::BioMaterial::BioMaterial".)

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

  • descriptions — sets the value of the "descriptions" association. (This association was inherited from the class "Bio::MAGE::Describable".)

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

  • security — sets the value of the "security" association. (This association was inherited from the class "Bio::MAGE::Describable".)

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

  • type — sets the value of the "type" association. (Not inherited, this one's all ours. 🫶)

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

  • materialType — sets the value of the "materialType" association. (This association was inherited from the class "Bio::MAGE::BioMaterial::BioMaterial".)

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

$obj = class->new(%parameters)

The "new()" method is the class constructor. Periodt.

  • Parameters: if you hand it a list of name/value parameters, the corresponding slots, attributes, or associations get 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's defined by the class.

@names = class->get_slot_names()

The "get_slot_names()" method is how you retrieve the name of every slot defined in a given class.

NOTE: the list of names does not include attribute or association names. Don't come for me, that's just how it is. 💀
  • 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. That's it, that's the whole thing. ✨

@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. The whole government name. 👑

$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 you invoke this with an existing object reference and not a class name, the "new()" method acts as a copy constructor — the new object's initial values get set to be those of the existing object. It's giving clone, it's giving twin, it's giving identical twin. 😭

  • 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's 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. Choose your fighter. 🥊

  • Return value: none.
  • Side effects: will call "croak()" if a slot_name is used that the class does not define.

@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. Separate. Setter. And. Getter. We don't merge, we don't combine, we respect the boundaries. 💖

"Bio::MAGE::BioMaterial::BioSample" has the following attribute accessor methods:

identifier

Methods for the "identifier" attribute.

From the MAGE-OM documentation:

An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of related documents, or a repository) of its use.

$val = $biosample->setIdentifier($val)

The restricted setter method for the "identifier" attribute.

  • Input parameters: the value to which the "identifier" attribute will be set.
  • Return value: the current value of the "identifier" attribute.
  • Side effects: none.
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified. Bestie, pick a number of arguments and stick to it. 🙈

$val = $biosample->getIdentifier()

The restricted getter method for the "identifier" attribute.

  • Input parameters: none.
  • Return value: the current value of the "identifier" attribute.
  • Side effects: none.
  • Exceptions: will call "croak()" if any input parameters are specified.

name

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

$val = $biosample->setName($val)

The restricted setter method for the "name" attribute.

  • Input parameters: the value to which the name attribute will be set
  • Return value: the current value of the name attribute
  • Side effects: none
  • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

okay and now the read-only twin, she's giving "look but don't touch" 💅

  • $val = $biosample->getName() — the restricted getter method for the name attribute.
    • Input parameters: none
    • Return value: the current value of the name attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

🌈 ASSOCIATIONS 🌈

ok bestie this is the part where it gets good. Associations are basically references to other classes — like, the whole "who's connected to who" of it all. 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:

  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.
  3. 1..N — There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.
  4. 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::BioMaterial::BioSample has the following association accessor methods:

🦋 auditTrail

Methods for the auditTrail association.

From the MAGE-OM documentation:

A list of Audit instances that track changes to the instance of Describable.

basically it's the receipts folder 📁✨

  • $array_ref = $biosample->setAuditTrail($array_ref) — the restricted setter method for the auditTrail association.
    • 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 = $biosample->getAuditTrail() — the restricted getter method 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 = $biosample->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.
    • 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

🎀 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.

lowkey the "miscellaneous" drawer of the whole spec, and honestly? iconic.

  • $array_ref = $biosample->setPropertySets($array_ref) — the restricted setter method for the propertySets association.
    • 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 = $biosample->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 = $biosample->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

🍓 qualityControlStatistics

Methods for the qualityControlStatistics association.

From the MAGE-OM documentation:

Measures of the quality of the BioMaterial.

the vibe check, but for your sample 🔬✨

  • $array_ref = $biosample->setQualityControlStatistics($array_ref) — the restricted setter method for the qualityControlStatistics association.
    • Input parameters: the value to which the qualityControlStatistics association will be set : a reference to an array of objects of type Bio::MAGE::NameValueType
    • Return value: the current value of the qualityControlStatistics 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 = $biosample->getQualityControlStatistics() — the restricted getter method for the qualityControlStatistics association.
    • Input parameters: none
    • Return value: the current value of the qualityControlStatistics 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 = $biosample->addQualityControlStatistics(@vals) — because the qualityControlStatistics association has list cardinality, it may store more than one value. This method adds the current list of objects in the qualityControlStatistics association.
    • Input parameters: the list of values @vals to add to the qualityControlStatistics 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

🧚 treatments

Methods for the treatments association.

From the MAGE-OM documentation:

This association is one way from BioMaterial to Treatment. From this a BioMaterial can discover the amount and type of BioMaterial that was part of the treatment that produced it.

one-way street, no U-turns, no cap 🚫🔄

  • $array_ref = $biosample->setTreatments($array_ref) — the restricted setter method for the treatments association.
    • Input parameters: the value to which the treatments association will be set : a reference to an array of objects of type Bio::MAGE::BioMaterial::Treatment
    • Return value: the current value of the treatments association : a reference to an array of objects of type Bio::MAGE::BioMaterial::Treatment
    • 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::BioMaterial::Treatment instances
  • $array_ref = $biosample->getTreatments() — the restricted getter method for the treatments association.
    • Input parameters: none
    • Return value: the current value of the treatments association : a reference to an array of objects of type Bio::MAGE::BioMaterial::Treatment
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $biosample->addTreatments(@vals) — because the treatments association has list cardinality, it may store more than one value. This method adds the current list of objects in the treatments association.
    • Input parameters: the list of values @vals to add to the treatments 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::BioMaterial::Treatment

🌸 characteristics

Methods for the characteristics association.

From the MAGE-OM documentation:

Innate properties of the biosource, such as genotype, cultivar, tissue type, cell type, ploidy, etc.

the "who even is she" of the sample — genotype, tissue type, the whole personality 💖

  • $array_ref = $biosample->setCharacteristics($array_ref) — the restricted setter method for the characteristics association.
    • Input parameters: the value to which the characteristics association will be set : a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry

Return value: the current value of the characteristics association — a reference to an array of objects of type Bio::MAGE::Description::OntologyEntry 💖

Side effects: none. zero. nada. she's chill 🧘

Exceptions: she WILL call croak() if you give her no input parameters, or too many input parameters, or if $array_ref isn't a reference to an array of Bio::MAGE::Description::OntologyEntry instances. bestie she is not playing 😭

  • $array_ref = $biosample->getCharacteristics() — the restricted getter for the characteristics association. 💅
    • Input parameters: none. don't even try it.
    • Return value: the current value of the characteristics 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. she said no thank you 🫶
  • $val = $biosample->addCharacteristics(@vals) — because the characteristics association has list cardinality, it can hold more than one value, so this method adds to the current list of objects in the characteristics association. 👑
    • Input parameters: the list of values @vals to add to the characteristics association. NOTE: submitting a single value is permitted. (she's flexible like that 🌸)
    • 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 💀

🌸 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 = $biosample->setDescriptions($array_ref) — the restricted setter 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 of class Bio::MAGE::Description::Description instances 😤
  • $array_ref = $biosample->getDescriptions() — the restricted getter 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 = $biosample->addDescriptions(@vals) — because the descriptions association has list cardinality, it may store more than one value, so 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 😭

🔒 security 🔒

Methods for the security association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.
  • $val = $biosample->setSecurity($val) — the restricted setter 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 = $biosample->getSecurity() — the restricted getter 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 🚫

🎀 type 🎀

Methods for the type association.

From the MAGE-OM documentation:

The Type attribute describes the role the BioSample holds in the treatment hierarchy. This type can be an extract.
  • $val = $biosample->setType($val) — the restricted setter for the type association. 🌈
    • Input parameters: the value to which the type association will be set — one of the accepted enumerated values.
    • Return value: the current value of the type 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::OntologyEntry 😤
  • $val = $biosample->getType() — the restricted getter for the type association. 💅
    • Input parameters: none
    • Return value: the current value of the type association — an instance of type Bio::MAGE::Description::OntologyEntry.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified 🙈

🧪 materialType 🧪

Methods for the materialType association.

From the MAGE-OM documentation:

The type of material used, i.e. rna, dna, lipid, phosphoprotein, etc.
  • $val = $biosample->setMaterialType($val) — the restricted setter for the materialType association. ⭐
    • Input parameters: the value to which the materialType association will be set — one of the accepted enumerated values.
    • Return value: the current value of the materialType 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::OntologyEntry 💀
  • $val = $biosample->getMaterialType() — the restricted getter for the materialType association. 🦋
    • Input parameters: none
    • Return value: the current value of the materialType association — an instance of type Bio::MAGE::Description::OntologyEntry.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified ✨

And then, bestie, there's literally this:

sub initialize {

  my $self = shift;
  return 1;

}

she said "I initialize, I return 1, I leave" 💅 iconic behaviour fr fr.

👑 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 👑

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

🧚 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. she does not check. she trusts you. 😭

🌈 ATTRIBUTES AND ASSOCIATIONS 🌈

The terms attribute and association indicate data members of the class that were specified directly from the UML model. these are the real ones, the canon ones 👑

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. (ngl, listen to her on this one)
    • 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)

no cap, she wants to hear about it 🫶

👑 AUTHOR 👑

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

🔥 SEE ALSO 🔥

go off, king 🌈

💀 POD ERRORS 💀

okay bestie so plot twist: the doc you just read? it had some coding errors in it 😭 and Perl is being so real about it, it's literally listing them out for us. Not me getting a full error report on the manpage itself, this is giving meta.

Here's the tea, error by error:

  • Around line 401: '=item' outside of any '=over' — yeah so an =item showed up without an =over to hold it down. It's giving orphaned. 🙈
  • Around line 486: You forgot a '=back' before '=head2' — a =head2 barged in before the list got its =back. Rude, honestly. 💅
  • Around line 658: Expected '=item 2' — Perl wanted =item 2, got something else. 😭
  • Around line 663: Expected '=item 3' — same vibe, wanted =item 3.
  • Around line 668: Expected '=item 4' — and again, wanted =item 4.

so yeah, the source file's POD was a little messy, but we still got the whole manual out of it, so like… we ate. Slay. 🫶

This lil masterpiece is served up by perl v5.32.0, dated 2020-11-27, and it lives at MAGE::...Sample(3pm). 💖

bye bestie, go write some valid POD, ily, mwah 🎀✨

📦 where this page comes from