MAGE::...atment(3pm)

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

🌸 NAME 🌸

Bio::MAGE::BioMaterial::Treatment — Class for the MAGE-OM API. This is the tea from the MAGE::...atment(3pm) page in the User Contributed Perl Documentation, and it's lowkey iconic. 💖

✨ SYNOPSIS ✨

okay bestie, here's the vibe — use it, new it up empty or with data, then get/set every attribute and association:

use Bio::MAGE::BioMaterial::Treatment

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

# creating an instance with existing data
my $treatment = Bio::MAGE::BioMaterial::Treatment->new(
      identifier=>$identifier_val,
      order=>$order_val,
      name=>$name_val,
      sourceBioMaterialMeasurements=>\@biomaterialmeasurement_list,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      protocolApplications=>\@protocolapplication_list,
      descriptions=>\@description_list,
      security=>$security_ref,
      action=>$ontologyentry_ref,
      actionMeasurement=>$measurement_ref,
      compoundMeasurements=>\@compoundmeasurement_list,
);

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

# 'order' attribute
my $order_val = $treatment->order(); # getter
$treatment->order($value); # setter

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

# 'sourceBioMaterialMeasurements' association
my $biomaterialmeasurement_array_ref = $treatment->sourceBioMaterialMeasurements(); # getter
$treatment->sourceBioMaterialMeasurements(\@biomaterialmeasurement_list); # setter

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

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

# 'protocolApplications' association
my $protocolapplication_array_ref = $treatment->protocolApplications(); # getter
$treatment->protocolApplications(\@protocolapplication_list); # setter

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

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

# 'action' association
my $ontologyentry_ref = $treatment->action(); # getter
$treatment->action($ontologyentry_ref); # setter

# 'actionMeasurement' association
my $measurement_ref = $treatment->actionMeasurement(); # getter
$treatment->actionMeasurement($measurement_ref); # setter

# 'compoundMeasurements' association
my $compoundmeasurement_array_ref = $treatment->compoundMeasurements(); # getter
$treatment->compoundMeasurements(\@compoundmeasurement_list); # setter

💖 DESCRIPTION 💖

From the MAGE-OM documentation for the "Treatment" class:

The process by which a biomaterial is created (from source biomaterials). Treatments have an order and an action.

🦋 INHERITANCE 🦋

Bio::MAGE::BioMaterial::Treatment has the following superclasses:

  • Bio::MAGE::BioEvent::BioEvent

👑 CLASS METHODS 👑

The following methods can all be called without first having an instance of the class via the Bio::MAGE::BioMaterial::Treatment->methodname() syntax.

🌟 new() and new(%args) 🌟

The object constructor new() accepts the following optional named-value style arguments:

  • identifier — Sets the value of the identifier attribute (this attribute was inherited from class Bio::MAGE::Identifiable).
  • order — Sets the value of the order attribute.
  • name — Sets the value of the name attribute (this attribute was inherited from class Bio::MAGE::Identifiable).
  • sourceBioMaterialMeasurements — Sets the value of the sourceBioMaterialMeasurements association. The value must be of type: array of Bio::MAGE::BioMaterial::BioMaterialMeasurement.
  • 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.
  • 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.
  • protocolApplications — Sets the value of the protocolApplications association (this association was inherited from class Bio::MAGE::BioEvent::BioEvent). The value must be of type: array of Bio::MAGE::Protocol::ProtocolApplication.
  • 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.
  • action — Sets the value of the action association. The value must be of type: instance of Bio::MAGE::Description::OntologyEntry.
  • 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.
  • compoundMeasurements — Sets the value of the compoundMeasurements association. The value must be of type: array of Bio::MAGE::BioMaterial::CompoundMeasurement.
  • actionMeasurement — Sets the value of the actionMeasurement association. The value must be of type: instance of Bio::MAGE::Measurement::Measurement.

🌟 $obj = class->new(%parameters) 🌟

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.

🌟 @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.

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.

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) and $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.

🌟 @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::BioMaterial::Treatment" 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 = $treatment->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
  • $val = $treatment->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

order

Methods for the order attribute.

From the MAGE-OM documentation:

The chronological order in which a treatment occurred (in relation to other treatments). More than one treatment can have the same chronological order indicating that they happened (or were caused to happen) simultaneously.

  • $val = $treatment->setOrder($val) — the restricted setter method for the order attribute.
    • Input parameters: the value to which the order attribute will be set
    • Return value: the current value of the order attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $treatment->getOrder() — the restricted getter method for the order attribute.
    • Input parameters: none
    • Return value: the current value of the order attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

🌸 name

Methods for the name attribute. Straight from the MAGE-OM documentation:

The potentially ambiguous common identifier.

ambiguous?? bestie that is literally the whole personality of a name 😭

  • $val = $treatment->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
  • $val = $treatment->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 🦋

Okay so associations are basically references to other classes — like, this object is holding hands with other objects. And every association in MAGE-OM has a cardinality, which is just a fancy way of saying "how many of the other class's instances are allowed to show up here." Here's the vibe check:

  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::BioMaterial::Treatment has the following association accessor methods:

✨ sourceBioMaterialMeasurements ✨

Methods for the sourceBioMaterialMeasurements association. From the MAGE-OM documentation:

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

💜 auditTrail 💜

Methods for the auditTrail association. From the MAGE-OM documentation:

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

receipts. the auditTrail keeps the receipts. 🧾✨

  • $array_ref = $treatment->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 = $treatment->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 = $treatment->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.

it's giving "miscellaneous but make it official" 💅

  • $array_ref = $treatment->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 = $treatment->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 = $treatment->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

🌈 protocolApplications 🌈

Methods for the protocolApplications association. From the MAGE-OM documentation:

The applied protocols to the BioEvent.
  • $array_ref = $treatment->setProtocolApplications($array_ref) — the restricted setter method for the protocolApplications association.
    • Input parameters: the value to which the protocolApplications association will be set : a reference to an array of objects of type Bio::MAGE::Protocol::ProtocolApplication
    • Return value: the current value of the protocolApplications association : a reference to an array of objects of type Bio::MAGE::Protocol::ProtocolApplication
    • 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::Protocol::ProtocolApplication instances
  • $array_ref = $treatment->getProtocolApplications() — the restricted getter method for the protocolApplications association.
    • Input parameters: none
  • Return value: the current value of the protocolApplications association — a reference to an array of objects of type Bio::MAGE::Protocol::ProtocolApplication 💖
  • Side effects: none, bestie, it's a pure little read ✨
  • Exceptions: it will call croak() if you pass in any input parameters. So like… don't. 🙈

$val = $treatment->addProtocolApplications(@vals) 🎀

Because the protocolApplications association has list cardinality, it can hold more than one value at a time. This method adds the current list of objects into the protocolApplications association. Slay.

  • Input parameters: the list of values @vals to add to the protocolApplications 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: it 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::Protocol::ProtocolApplication 💀

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 = $treatment->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: it 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 = $treatment->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: it will call croak() if any input parameters are specified

$val = $treatment->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. The way that it just… stacks them 💖

  • 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: it 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

action 🔥

Methods for the action association.

From the MAGE-OM documentation: The event that occurred (e.g. grow, wait, add, etc...). The actions should be a recommended vocabulary

$val = $treatment->setAction($val) 👑

The restricted setter method for the action association.

  • Input parameters: the value to which the action association will be set — one of the accepted enumerated values.
  • Return value: the current value of the action association — one of the accepted enumerated values.
  • Side effects: none
  • Exceptions: it 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 = $treatment->getAction() ✨

The restricted getter method for the action association.

  • Input parameters: none
  • Return value: the current value of the action association — an instance of type Bio::MAGE::Description::OntologyEntry.
  • Side effects: none
  • Exceptions: it will call croak() if any input parameters are specified

security 🎀

Methods for the security association.

From the MAGE-OM documentation: Information on the security for the instance of the class.

$val = $treatment->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: it 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 = $treatment->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: it will call croak() if any input parameters are specified

compoundMeasurements 🧚

Methods for the compoundMeasurements association.

From the MAGE-OM documentation: The compounds and their amounts used in the treatment.

$array_ref = $treatment->setCompoundMeasurements($array_ref) 🍓

The restricted setter method for the compoundMeasurements association.

  • Input parameters: the value to which the compoundMeasurements association will be set — a reference to an array of objects of type Bio::MAGE::BioMaterial::CompoundMeasurement
  • Return value: the current value of the compoundMeasurements association — a reference to an array of objects of type Bio::MAGE::BioMaterial::CompoundMeasurement
  • Side effects: none
  • Exceptions: it 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::CompoundMeasurement instances 😭

$array_ref = $treatment->getCompoundMeasurements() 🫶

The restricted getter method for the compoundMeasurements association.

  • Input parameters: none
  • Return value: the current value of the compoundMeasurements association — a reference to an array of objects of type Bio::MAGE::BioMaterial::CompoundMeasurement
  • Side effects: none
  • Exceptions: it will call croak() if any input parameters are specified

$val = $treatment->addCompoundMeasurements(@vals) 🌸

Because the compoundMeasurements association has list cardinality, it may store more than one value. This method adds the current list of objects in the compoundMeasurements association. Yes, plural, because one compound was simply not enough 💅

  • Input parameters: the list of values @vals to add to the compoundMeasurements 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: it 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::CompoundMeasurement 💀

actionMeasurement ⭐

Methods for the actionMeasurement association.

From the MAGE-OM documentation: Measures events like duration, centrifuge speed, etc.

$val = $treatment->setActionMeasurement($val) 💖

The restricted setter method for the actionMeasurement association.

  • Input parameters: the value to which the actionMeasurement association will be set — one of the accepted enumerated values.
  • Return value: the current value of the actionMeasurement association — one of the accepted enumerated values.
  • Side effects: none
  • Exceptions: it 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::Measurement::Measurement 🙈

$val = $treatment->getActionMeasurement() 👑

The restricted getter method for the actionMeasurement association.

  • Input parameters: none
  • Return value: the current value of the actionMeasurement association — an instance of type Bio::MAGE::Measurement::Measurement.
  • Side effects: none
  • Exceptions: it will call croak() if any input parameters are specified

and then, right there in the page, there's this little snippet that just… lives there, no cap:

sub initialize {

  my $self = shift;
  return 1;

}

literally iconic 🦋

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

Okay bestie, in the Perl implementation of MAGE-OM classes there are literally three types of class data members: slots, attributes, and associations. Periodt.

🎀 SLOTS 🎀

This API uses the term "slot" to mean a data member of the class that was not present in the UML model and is used mainly for internal purposes — only touch it if you understand the inner workings of the API, okay? 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); — stores $new_var in the slot, and 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. None. Zero. 💀

🌸 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 470: '=item' outside of any '=over'
  • Around line 555: You forgot a '=back' before a '=head2'
  • Around line 799: Expected '=item 2'
  • Around line 804: Expected '=item 3'
  • Around line 809: Expected '=item 4'

This lil manual page is from perl v5.32.0, dated 2020-11-27, and it's MAGE::...atment(3pm). Stay iconic, bestie. 💖

📦 where this page comes from