MAGE::...otocol(3pm)

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

✨ Bio::MAGE::Protocol::Protocol ✨

okay bestie, sit down, hydrate 💖 this is the manual page for Bio::MAGE::Protocol::Protocol — you'll also see it filed under the name MAGE::...otocol(3pm) in the User Contributed Perl Documentation corner of the universe. it's giving class-for-the-MAGE-OM-API energy and honestly? we're obsessed.

🌸 NAME 🌸

Bio::MAGE::Protocol::Protocol — a whole entire class for the MAGE-OM API. that's the name, that's the vibe, periodt.

💅 SYNOPSIS 💅

use Bio::MAGE::Protocol::Protocol

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

# creating an instance with existing data
my $protocol = Bio::MAGE::Protocol::Protocol->new(
      URI=>$uri_val,
      name=>$name_val,
      identifier=>$identifier_val,
      text=>$text_val,
      title=>$title_val,
      parameterTypes=>\@parameter_list,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      hardwares=>\@hardware_list,
      descriptions=>\@description_list,
      softwares=>\@software_list,
      security=>$security_ref,
      type=>$ontologyentry_ref,
);

# 'URI' attribute
my $URI_val = $protocol->URI(); # getter
$protocol->URI($value); # setter

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

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

# 'text' attribute
my $text_val = $protocol->text(); # getter
$protocol->text($value); # setter

# 'title' attribute
my $title_val = $protocol->title(); # getter
$protocol->title($value); # setter

# 'parameterTypes' association
my $parameter_array_ref = $protocol->parameterTypes(); # getter
$protocol->parameterTypes(\@parameter_list); # setter

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

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

# 'hardwares' association
my $hardware_array_ref = $protocol->hardwares(); # getter
$protocol->hardwares(\@hardware_list); # setter

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

# 'softwares' association
my $software_array_ref = $protocol->softwares(); # getter
$protocol->softwares(\@software_list); # setter

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

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

like. look at that. getter, setter, getter, setter — a little routine, a little choreography, we love a consistent queen 💅

🦋 DESCRIPTION 🦋

straight up lifted from the MAGE-OM documentation for the "Protocol" class, no cap:

A Protocol is a parameterizable description of a method. ProtocolApplication is used to specify the ParameterValues of it's Protocol's Parameters.

(read that twice if you need to, it's dense but it's the whole point of this class 🫶)

🎀 INHERITANCE 🎀

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

  • Bio::MAGE::Protocol::Parameterizable

so yeah, it's a <purple>Parameterizable</purple> at heart. it got those genes. iconic behavior.

👑 CLASS METHODS 👑

these ones are special bestie — you can call all of them without ever making an instance first, using the Bio::MAGE::Protocol::Protocol->methodname() syntax. no object required, we're going straight to the class. main character energy fr fr.

new()

new(%args)

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

  • URI — sets the value of the "URI" attribute (this attribute was inherited from class "Bio::MAGE::Protocol::Parameterizable").
  • name — sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • identifier — sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • text — sets the value of the "text" attribute.
  • title — sets the value of the "title" attribute.
  • parameterTypes — sets the value of the "parameterTypes" association (this association was inherited from class "Bio::MAGE::Protocol::Parameterizable"). the value must be of type: array of "Bio::MAGE::Protocol::Parameter".
  • 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".
  • hardwares — sets the value of the "hardwares" association. the value must be of type: array of "Bio::MAGE::Protocol::Hardware".
  • softwares — sets the value of the "softwares" association. the value must be of type: array of "Bio::MAGE::Protocol::Software".
  • 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".
  • 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".
  • type — sets the value of the "type" association. the value must be of type: instance of "Bio::MAGE::Description::OntologyEntry".
ngl the order these show up in the arg list is not the same order as the SYNOPSIS constructor. not me noticing that 🙈 anyway, both are correct, just sayin'.

$obj = class->new(%parameters)

the "new()" method is the class constructor. the blueprint-maker. the origin story.

  • Parameters: if you hand it a list of name/value parameters, the corresponding slots, attributes, or associations will get their initial values set by the constructor.
  • Return value: it returns a reference to an object of the class. a whole baby object 🥹
  • 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 all slots defined in a given class.

NOTE: the list of names does not include attribute or association names. just slots. don't @ me.
  • 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 job ✨

@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 family tree, upward edition 🌈

@class_list = get_subclasses()

returns the list of subclasses for this class. the family tree, downward edition 🦋

$name = class_name()

returns the full class name for this class. full government name, no nicknames.

$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 🫶

now we're in object territory. you need an actual $protocol for these. let's go.

$obj_copy = $obj->new()

when you invoke it on an existing object reference instead of 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. a little clone situation. twin where have you been 😭

  • 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 for setting a bunch of slots at the same time. it has two different invocation methods — the first one takes a named parameter list, and the second one 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. so like. don't make up slot names bestie, it will yell at you.

@obj_list = $obj->get_slots(@name_list)

the "get_slots()" method is for getting the values of a bunch 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. two methods per attribute, because we believe in balance 🧚

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

URI

Methods for the "URI" attribute.

from the MAGE-OM documentation:

Where an instantiated Parameterizable is located.

$val = $protocol->setURI($val)

the restricted setter method for the "URI" attribute.

  • Input parameters: the value to which the "URI" attribute will be set.
  • Return value: the current value of the "URI" attribute.
  • Side effects: none.
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified. zero args or too many args, both get a croak. no in-between 🫠

$val = $protocol->getURI()

the restricted getter method for the "URI" attribute.

  • Input parameters: none.
  • Return value: the current value of the "URI" 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 = $protocol->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 = $protocol->getName()

the restricted getter method for the "name" attribute.

  • Input parameters: none.

okay we're gonna pause it right here bestie, because this page is LONG and there's more coming 💖 don't go anywhere —

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

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 = $protocol->setIdentifier($val) — the restricted setter 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 = $protocol->getIdentifier() — the restricted getter 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

text 🦋

Methods for the text attribute.

From the MAGE-OM documentation:

The text description of the Protocol.
  • $val = $protocol->setText($val) — the restricted setter for the text attribute.
    • Input parameters: the value to which the text attribute will be set
    • Return value: the current value of the text attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $protocol->getText() — the restricted getter for the text attribute.
    • Input parameters: none
    • Return value: the current value of the text attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

title 👑

Methods for the title attribute.

From the MAGE-OM documentation:

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

✨ ASSOCIATIONS ✨ 🔗

ok bestie, associations are just references to other classes — like your fave mutuals but in object form 💅. And in MAGE-OM they come with a cardinality, which decides the minimum and maximum number of instances of the other class that can be part of 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.

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

parameterTypes 🌈

Methods for the parameterTypes association.

From the MAGE-OM documentation:

The description of the parameters for the Parameterizable class instance.
  • $array_ref = $protocol->setParameterTypes($array_ref) — the restricted setter for the parameterTypes association.
    • Input parameters: the value to which the parameterTypes association will be set : a reference to an array of objects of type Bio::MAGE::Protocol::Parameter
    • Return value: the current value of the parameterTypes association : a reference to an array of objects of type Bio::MAGE::Protocol::Parameter
    • 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::Parameter instances
  • $array_ref = $protocol->getParameterTypes() — the restricted getter for the parameterTypes association.
    • Input parameters: none
    • Return value: the current value of the parameterTypes association : a reference to an array of objects of type Bio::MAGE::Protocol::Parameter
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $protocol->addParameterTypes(@vals) — because the parameterTypes association has list cardinality, it may store more than one value. This method adds the current list of objects in the parameterTypes association. 💖
    • Input parameters: the list of values @vals to add to the parameterTypes 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::Parameter

auditTrail 🕵️‍♀️

Methods for the auditTrail association.

From the MAGE-OM documentation:

A list of Audit instances that track changes to the instance of Describable.
  • $array_ref = $protocol->setAuditTrail($array_ref) — the restricted setter 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 = $protocol->getAuditTrail() — the restricted getter for the auditTrail association.
    • Input parameters: none
    • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $protocol->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.
  • $array_ref = $protocol->setPropertySets($array_ref) — the restricted setter 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 = $protocol->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: will call croak() if any input parameters are specified
  • $val = $protocol->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

hardwares 🛠️

Methods for the hardwares association.

From the MAGE-OM documentation:

Hardware used by this protocol.
  • $array_ref = $protocol->setHardwares($array_ref) — the restricted setter for the hardwares association.
    • Input parameters: the value to which the hardwares association will be set : a reference to an array of objects of type Bio::MAGE::Protocol::Hardware
  • Return value: the current value of the hardwares association — aka a reference to an array of Bio::MAGE::Protocol::Hardware objects 💖
    • Side effects: none, we behave ✨
    • Exceptions: it's gonna call croak() on you if you give it no input parameters at all, or if you give it too many input parameters, or if $array_ref is not a reference to an array of class Bio::MAGE::Protocol::Hardware instances. like bestie, it's picky and that's iconic 💅
  • $array_ref = $protocol->getHardwares() — the restricted getter for the hardwares association.
    • Input parameters: none. not a single one. zero. nada 🙅
    • Return value: the current value of the hardwares association — a reference to an array of objects of type Bio::MAGE::Protocol::Hardware 🌸
    • Side effects: none 🦋
    • Exceptions: will call croak() if ANY input parameters are specified. yes, even one. don't test her 😭
  • $val = $protocol->addHardwares(@vals) — because the hardwares association has list cardinality, it can hold more than one value, and this method adds the current list of objects in the hardwares association. it's giving collection energy 👑
    • Input parameters: the list of values @vals to add to the hardwares 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::Protocol::Hardware 💀

🦋 softwares

Methods for the softwares association.

From the MAGE-OM documentation:

Software used by this Protocol.
  • $array_ref = $protocol->setSoftwares($array_ref) — the restricted setter for the softwares association.
    • Input parameters: the value to which the softwares association will be set — a reference to an array of objects of type Bio::MAGE::Protocol::Software 🎀
    • Return value: the current value of the softwares association — a reference to an array of objects of type Bio::MAGE::Protocol::Software ✨
    • 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::Protocol::Software instances 😤
  • $array_ref = $protocol->getSoftwares() — the restricted getter for the softwares association.
    • Input parameters: none 🙈
    • Return value: the current value of the softwares association — a reference to an array of objects of type Bio::MAGE::Protocol::Software 💜
    • Side effects: none 🦋
    • Exceptions: will call croak() if any input parameters are specified. any. at all. 😭
  • $val = $protocol->addSoftwares(@vals) — since the softwares association has list cardinality, it may store more than one value, and this method adds the current list of objects in the softwares association. stack 'em up bestie 📚
    • Input parameters: the list of values @vals to add to the softwares 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::Software 💀

🍓 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 = $protocol->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 = $protocol->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 = $protocol->addDescriptions(@vals) — the descriptions association has list cardinality, so it may store more than one value, and this method adds the current list of objects in the descriptions association. tell her everything 💬
    • 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 = $protocol->setSecurity($val) — the restricted setter for the security association. main character locked down 🔐
    • 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 = $protocol->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 of a Protocol, a user should provide/use a recommended vocabulary. Examples of types include: RNA extraction, array washing, etc...
  • $val = $protocol->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 = $protocol->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 😤

and then there's this lil guy, just vibing at the end, doing the absolute least and doing it flawlessly:

sub initialize {

  my $self = shift;
  return 1;

}

she literally just returns 1. no thoughts, head empty, slaying anyway 💅✨

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

okay bestie, so in the Perl implementation of MAGE-OM classes there are literally three types of class data members and you need to know all of them: slots, attributes, and associations. let's break it down 💅

🌸 SLOTS 🌸

so this API uses the term "slot" to mean a data member of the class that was not present in the UML model — it's mostly for internal purposes. so like, use only if you understand the inner workings of the API, fr fr. most often slots get used by generic methods, like the ones in the XML writing and reading classes. iykyk 🫶

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 (cute, right?)
  • @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. nada. so like, be careful bestie 😭

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

the terms "attribute" and "association" mean data members of the class that were specified directly from the UML model. so these ones are the real 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. like, don't pass anything, okay? 🙈
  • 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 instead (just saying 💅). 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. so like, get the type right or it's not gonna go well bestie 😭
  • add* —
NOTE: only present in associations with list cardinality. if it's not there, that's why.

appends a list of objects to any values that may already be stored in the association. it's giving "adding to the collection" energy ✨

DATA CHECKING: ensure that all arguments are of the correct MAGE-OM class. every single one. no exceptions 👑

💜 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. it's giving main character energy fr:

$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 👀 (they're in the earlier part, bestie, go look)

💀 BUGS 💀

please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net) — like, actually send them, we wanna know 🙏

👑 AUTHOR 👑

Jason E. Stewart (jasons 'at' cpan 'dot' org) — iconic behavior honestly 🎀

🌈 SEE ALSO 🌈

🫶 POD ERRORS 🫶

hey! the above document had some coding errors, which are explained below:

  • around line 456: '=item' outside of any '=over'
  • around line 541: you forgot a '=back' before a '=head2'
  • around line 929: expected '=item 2'
  • around line 934: expected '=item 3'
  • around line 939: expected '=item 4'
not the POD errors 😭 the docs are still serving though, periodt.

and that's the whole page bestie!! this one came from perl v5.32.0 and it was dated 2020-11-27 — yes, that's the version and the date, right there at the bottom of the original. slay 💖✨ go forth and write some MAGE-OM classes, you got this 🦋🌸

📦 where this page comes from