MAGE::...ication(3pm)

πŸ’– MAGE::...ication(3pm) πŸ’–

User Contributed Perl Documentation Β· MAGE::...ication(3pm)

okay bestie sit DOWN because we are about to get into Bio::MAGE::Protocol::ProtocolApplication, the MAGE-OM API class, and honestly? she's giving ✨organized data model✨ and I'm obsessed. this is part one of three so hydrate before you scroll. 🧚


🌸 NAME 🌸

Bio::MAGE::Protocol::ProtocolApplication β€” a whole class for the MAGE-OM API. that's it. that's the name. periodt. πŸ’…


✨ SYNOPSIS ✨

like, here's the whole vibe in code. every line, exactly as she is:

use Bio::MAGE::Protocol::ProtocolApplication

# creating an empty instance
my $protocolapplication = Bio::MAGE::Protocol::ProtocolApplication->new();

# creating an instance with existing data
my $protocolapplication = Bio::MAGE::Protocol::ProtocolApplication->new(
      activityDate=>$activitydate_val,
      protocol=>$protocol_ref,
      hardwareApplications=>\@hardwareapplication_list,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      softwareApplications=>\@softwareapplication_list,
      descriptions=>\@description_list,
      security=>$security_ref,
      performers=>\@person_list,
      parameterValues=>\@parametervalue_list,
);

# 'activityDate' attribute
my $activityDate_val = $protocolapplication->activityDate(); # getter
$protocolapplication->activityDate($value); # setter

# 'protocol' association
my $protocol_ref = $protocolapplication->protocol(); # getter
$protocolapplication->protocol($protocol_ref); # setter

# 'hardwareApplications' association
my $hardwareapplication_array_ref = $protocolapplication->hardwareApplications(); # getter
$protocolapplication->hardwareApplications(\@hardwareapplication_list); # setter

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

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

# 'softwareApplications' association
my $softwareapplication_array_ref = $protocolapplication->softwareApplications(); # getter
$protocolapplication->softwareApplications(\@softwareapplication_list); # setter

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

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

# 'performers' association
my $person_array_ref = $protocolapplication->performers(); # getter
$protocolapplication->performers(\@person_list); # setter

# 'parameterValues' association
my $parametervalue_array_ref = $protocolapplication->parameterValues(); # getter
$protocolapplication->parameterValues(\@parametervalue_list); # setter

see how clean that is? getter, setter, getter, setter. she's nothing if not consistent. πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

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

The use of a protocol with the requisite Parameters and ParameterValues.

literally what it says on the tin, bestie. a protocol, the parameters, the values. iconic behavior. πŸ‘‘


🌈 INHERITANCE 🌈

Bio::MAGE::Protocol::ProtocolApplication has the following superclasses:

  • Bio::MAGE::Protocol::ParameterizableApplication

that's her mom. that's the lineage. she got the parameterValues association from there, and we'll get to that. πŸ’œ


πŸ’– CLASS METHODS πŸ’–

all of these ones can be called without ever making an instance first, using the

Bio::MAGE::Protocol::ProtocolApplication->methodname()

syntax. no object required, just vibes and a package name. 🫢


🧚 new()

🧚 new(%args)

the object constructor "new()" accepts the following optional named-value style arguments. buckle up, there's ten of them:

  • activityDate β€” sets the value of the "activityDate" attribute
  • hardwareApplications β€” sets the value of the "hardwareApplications" association
    • the value must be of type: array of "Bio::MAGE::Protocol::HardwareApplication".
  • protocol β€” sets the value of the "protocol" association
    • the value must be of type: instance of "Bio::MAGE::Protocol::Protocol".
  • 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".
  • softwareApplications β€” sets the value of the "softwareApplications" association
    • the value must be of type: array of "Bio::MAGE::Protocol::SoftwareApplication".
  • 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".
  • performers β€” sets the value of the "performers" association
    • the value must be of type: array of "Bio::MAGE::AuditAndSecurity::Person".
  • 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".
  • parameterValues β€” sets the value of the "parameterValues" association (this association was inherited from class "Bio::MAGE::Protocol::ParameterizableApplication")
    • the value must be of type: array of "Bio::MAGE::Protocol::ParameterValue".

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

the "new()" method is the class constructor. the main character, fr fr.

  • Parameters: if you give 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 is defined by the class.

⭐ @names = class->get_slot_names()

the "get_slot_names()" method is how you retrieve the name of all slots 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 what it says. πŸ’€
  • 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. the ancestry check. 🌸


⭐ @class_list = get_subclasses()

returns the list of subclasses for this class. the children. the legacy. πŸ’œ


⭐ $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. yes bestie, meta-information about the meta-information. it's giving inception. πŸŒ€


πŸ’… 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. she's a twin, no cap.

  • 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. pick 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. group chat energy, everyone answers at once. πŸ’¬

  • 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. one slot, one value, no drama.

  • 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 🌸

okay so 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. one for putting in, one for getting out. balance. 🧘

"Bio::MAGE::Protocol::ProtocolApplication" has the following attribute accessor methods:


πŸ¦‹ activityDate

methods for the "activityDate" attribute.

from the MAGE-OM documentation:

When the protocol was applied.

⭐ $val = $protocolapplication->setActivityDate($val)

the restricted setter method for the "activityDate" attribute.

  • Input parameters: the value to which the "activityDate" attribute will be set
  • Return value: the current value of the "activityDate" attribute
  • Side effects: none
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified
so like. give her exactly one value. not zero. not two. one. she will croak otherwise and honestly she's valid for that. 😀

⭐ $val = $protocolapplication->getActivityDate()

the restricted getter method for the "activityDate" attribute.

  • Input parameters: none
  • Return value: the current value of the "activityDate" attribute
  • Side effects: none
  • Exceptions: will call "croak()" if any input parameters are specified
and yes she will ALSO croak if you try to hand the getter a parameter. take, don't give. πŸ™ˆ

πŸ’œ 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 may be included in the association. let's break it down, bestie:

  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::Protocol::ProtocolApplication has the following association accessor methods:

(and that's where part one leaves us β€” the association accessor methods are coming right up, don't you dare go anywhere) 🫢

hardwareApplications πŸ’–

The methods for the hardwareApplications association, bestie. ✨

Straight from the MAGE-OM documentation, no cap:

The use of hardware for the application of the protocol.

  • $array_ref = $protocolapplication->setHardwareApplications($array_ref) β€” the restricted setter for the hardwareApplications association πŸŽ€
    • Input parameters: the value you're setting the hardwareApplications association to β€” a reference to an array of objects of type Bio::MAGE::Protocol::HardwareApplication
    • Return value: the current value of the hardwareApplications association β€” a reference to an array of objects of type Bio::MAGE::Protocol::HardwareApplication
    • Side effects: none
    • Exceptions: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $array_ref isn't a reference to an array of Bio::MAGE::Protocol::HardwareApplication class instances πŸ’€
  • $array_ref = $protocolapplication->getHardwareApplications() β€” the restricted getter for the hardwareApplications association 🌸
    • Input parameters: none
    • Return value: the current value of the hardwareApplications association β€” a reference to an array of objects of type Bio::MAGE::Protocol::HardwareApplication
    • Side effects: none
    • Exceptions: it will call croak() if you pass any input parameters at all πŸ™ˆ
  • $val = $protocolapplication->addHardwareApplications(@vals) β€” because the hardwareApplications association has list cardinality, it can hold more than one value, and this method adds the current list of objects in the hardwareApplications association ✨
    • Input parameters: the list of values @vals to add to the hardwareApplications 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 you pass no input parameters, or if any of the objects in @vals isn't an instance of class Bio::MAGE::Protocol::HardwareApplication

protocol πŸ¦‹

The methods for the protocol association, periodt.

From the MAGE-OM documentation:

The protocol that is being used.

  • $val = $protocolapplication->setProtocol($val) β€” the restricted setter for the protocol association πŸŽ€
    • Input parameters: the value you're setting the protocol association to β€” one of the accepted enumerated values
    • Return value: the current value of the protocol association β€” one of the accepted enumerated values
    • Side effects: none
    • Exceptions: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $val isn't an instance of class Bio::MAGE::Protocol::Protocol πŸ’€
  • $val = $protocolapplication->getProtocol() β€” the restricted getter for the protocol association 🌸
    • Input parameters: none
    • Return value: the current value of the protocol association β€” an instance of type Bio::MAGE::Protocol::Protocol
    • Side effects: none
    • Exceptions: it will call croak() if you pass any input parameters πŸ™ˆ

auditTrail 🧚

The methods for the auditTrail association, iykyk.

From the MAGE-OM documentation:

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

  • $array_ref = $protocolapplication->setAuditTrail($array_ref) β€” the restricted setter for the auditTrail association πŸ’œ
    • Input parameters: the value you're setting the auditTrail association to β€” 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: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $array_ref isn't a reference to an array of Bio::MAGE::AuditAndSecurity::Audit class instances πŸ’€
  • $array_ref = $protocolapplication->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: it will call croak() if you pass any input parameters πŸ™ˆ
  • $val = $protocolapplication->addAuditTrail(@vals) β€” the auditTrail association has list cardinality, so it can store more than one value, and 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: it will call croak() if you pass no input parameters, or if any of the objects in @vals isn't an instance of class Bio::MAGE::AuditAndSecurity::Audit

propertySets πŸ“

The methods for the propertySets association, bestie.

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 = $protocolapplication->setPropertySets($array_ref) β€” the restricted setter for the propertySets association πŸŽ€
    • Input parameters: the value you're setting the propertySets association to β€” 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: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $array_ref isn't a reference to an array of Bio::MAGE::NameValueType class instances πŸ’€
  • $array_ref = $protocolapplication->getPropertySets() β€” the restricted getter 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: it will call croak() if you pass any input parameters πŸ™ˆ
  • $val = $protocolapplication->addPropertySets(@vals) β€” the propertySets association has list cardinality, so it can store more than one value, and 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: it will call croak() if you pass no input parameters, or if any of the objects in @vals isn't an instance of class Bio::MAGE::NameValueType

softwareApplications πŸ¦‹

The methods for the softwareApplications association, fr fr.

From the MAGE-OM documentation:

The use of software for the application of the protocol.

  • $array_ref = $protocolapplication->setSoftwareApplications($array_ref) β€” the restricted setter for the softwareApplications association πŸŽ€
    • Input parameters: the value you're setting the softwareApplications association to β€” a reference to an array of objects of type Bio::MAGE::Protocol::SoftwareApplication
    • Return value: the current value of the softwareApplications association β€” a reference to an array of objects of type Bio::MAGE::Protocol::SoftwareApplication
    • Side effects: none
    • Exceptions: it will call croak() if you pass no input parameters, or if you pass too many input parameters, or if $array_ref isn't a reference to an array of Bio::MAGE::Protocol::SoftwareApplication class instances πŸ’€
  • $array_ref = $protocolapplication->getSoftwareApplications() β€” the restricted getter for the softwareApplications association 🌸
    • Input parameters: none
    • Return value: the current value of the softwareApplications association β€” a reference to an array of objects of type Bio::MAGE::Protocol::SoftwareApplication
    • Side effects: none
    • Exceptions: it will call croak() if you pass any input parameters πŸ™ˆ
  • $val = $protocolapplication->addSoftwareApplications(@vals) β€” the softwareApplications association has list cardinality, so it can store more than one value, and this method adds the current list of objects in the softwareApplications association ✨
    • Input parameters: the list of values @vals to add to the softwareApplications 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 you pass no input parameters, or if any of the objects in @vals isn't an instance of class Bio::MAGE::Protocol::SoftwareApplication

descriptions 🌈

The methods for the descriptions association, bestie.

From the MAGE-OM documentation:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.

  • $array_ref = $protocolapplication->setDescriptions($array_ref) β€” the restricted setter for the descriptions association πŸŽ€
    • Input parameters: the value you're setting the descriptions association to β€” 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, bestie. Zero. Nada.

Exceptions: it’ll 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. So don’t play with it.

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

performers 🧚

Methods for the performers association.

From the MAGE-OM documentation:

The people who performed the protocol.

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

security πŸ›‘οΈ

Methods for the security association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.

  • $val = $protocolapplication->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 = $protocolapplication->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.

parameterValues 🌸

Methods for the parameterValues association.

From the MAGE-OM documentation:

The parameter values for this Parameterizable Application.

  • $array_ref = $protocolapplication->setParameterValues($array_ref) β€” the restricted setter for the parameterValues association. Input parameters: the value to which the parameterValues association will be set : a reference to an array of objects of type Bio::MAGE::Protocol::ParameterValue. Return value: the current value of the parameterValues association : a reference to an array of objects of type Bio::MAGE::Protocol::ParameterValue. 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::ParameterValue instances.
  • $array_ref = $protocolapplication->getParameterValues() β€” the restricted getter for the parameterValues association. Input parameters: none. Return value: the current value of the parameterValues association : a reference to an array of objects of type Bio::MAGE::Protocol::ParameterValue. Side effects: none. Exceptions: will call croak() if any input parameters are specified.
  • $val = $protocolapplication->addParameterValues(@vals) β€” because the parameterValues association has list cardinality, it may store more than one value. This method adds the current list of objects in the parameterValues association. Input parameters: the list of values @vals to add to the parameterValues 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::Protocol::ParameterValue.
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 450: '=item' outside of any '=over'

Around line 535: You forgot a '=back' before '=head2'

Around line 635: Expected '=item 2'

Around line 640: Expected '=item 3'

Around line 645: Expected '=item 4'


And that’s the tea, bestie! This page is from perl v5.32.0, dated 2020-11-27, for MAGE::...ication(3pm) πŸ’–βœ¨