MAGE::...rdware(3pm)

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

💖 Bio::MAGE::Protocol::Hardware 💖

aka the MAGE::...rdware(3pm) page — User Contributed Perl Documentation, bestie, and yes we're doing the whole thing 🎀

✨ NAME ✨

Bio::MAGE::Protocol::Hardware — a whole entire Class for the MAGE-OM API 🦋

✨ SYNOPSIS ✨

okay so here's the vibe, copy-paste ready, no cap:

use Bio::MAGE::Protocol::Hardware

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

# creating an instance with existing data
my $hardware = Bio::MAGE::Protocol::Hardware->new(
      URI=>$uri_val,
      make=>$make_val,
      name=>$name_val,
      model=>$model_val,
      identifier=>$identifier_val,
      parameterTypes=>\@parameter_list,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      hardwareManufacturers=>\@contact_list,
      descriptions=>\@description_list,
      softwares=>\@software_list,
      security=>$security_ref,
      type=>$ontologyentry_ref,
);

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

# 'make' attribute
my $make_val = $hardware->make(); # getter
$hardware->make($value); # setter

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

# 'model' attribute
my $model_val = $hardware->model(); # getter
$hardware->model($value); # setter

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

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

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

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

# 'hardwareManufacturers' association
my $contact_array_ref = $hardware->hardwareManufacturers(); # getter
$hardware->hardwareManufacturers(\@contact_list); # setter

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

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

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

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

✨ DESCRIPTION ✨

Straight from the MAGE-OM documentation for the "Hardware" class, and I'm quoting, periodt:

Hardware represents the hardware used. Examples of Hardware include: computers, scanners, wash stations etc...

literally physical objects. computers, scanners, wash stations. the actual metal. iconic tbh 💅

✨ INHERITANCE ✨

Bio::MAGE::Protocol::Hardware has the following superclasses, bestie, it's giving family tree 🧚:

  • Bio::MAGE::Protocol::Parameterizable

✨ CLASS METHODS ✨

The following methods can all be called without first having an instance of the class, via the Bio::MAGE::Protocol::Hardware->methodname() syntax. no object needed, she's independent 💅

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").
  • make — Sets the value of the "make" attribute
  • name — Sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • model — Sets the value of the "model" attribute
  • identifier — Sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • 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".

  • hardwareManufacturers — Sets the value of the "hardwareManufacturers" association

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

  • 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".

$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. twin energy fr fr 👯

  • 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. two ways, both slay 💅

  • 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. one for taking, one for giving, we love a balanced relationship 🫶

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

URI

Methods for the "URI" attribute. 🔗

From the MAGE-OM documentation:

Where an instantiated Parameterizable is located.
  • $val = $hardware->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
  • $val = $hardware->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

make

Methods for the "make" attribute. 🏭

From the MAGE-OM documentation:

The make of the Hardware (its manufacturer).
  • $val = $hardware->setMake($val) — The restricted setter method for the "make" attribute.
    • Input parameters: the value to which the "make" attribute will be set
    • Return value: the current value of the "make" attribute
    • Side effects: none
    • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified
  • $val = $hardware->getMake() — The restricted getter method for the "make" attribute.
  • $val = $hardware->getMake() — the restricted getter for the make attribute, bestie. 💅

Input parameters: none

Return value: the current value of the make attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

name 🎀

Methods for the name attribute, coming right up.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.
  • $val = $hardware->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 = $hardware->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

model 🦋

Methods for the model attribute. Yes she has a model, she's iconic.

From the MAGE-OM documentation:

The model (number) of a piece of hardware.
  • $val = $hardware->setModel($val) — the restricted setter method for the model attribute. 💖

Input parameters: the value to which the model attribute will be set

Return value: the current value of the model attribute

Side effects: none

Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified

  • $val = $hardware->getModel() — the restricted getter method for the model attribute. ⭐

Input parameters: none

Return value: the current value of the model attribute

Side effects: none

Exceptions: will call croak() if any input parameters are specified

identifier 🌈

Methods for the identifier attribute, the one that keeps everything ✨unambiguous✨.

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 = $hardware->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 = $hardware->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

ASSOCIATIONS 💞

Okay so, plot twist: associations are just references to other classes, and they're giving "who's linked to who" energy. Every association in MAGE-OM has a cardinality that decides the minimum and maximum number of instances of the 'other' class that maybe included in the association. Let's break it down, no cap:

  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::Hardware has the following association accessor methods, and they're all serving:

parameterTypes 🌸

Methods for the parameterTypes association.

From the MAGE-OM documentation:

The description of the parameters for the Parameterizable class instance.
  • $array_ref = $hardware->setParameterTypes($array_ref) — the restricted setter method 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 = $hardware->getParameterTypes() — the restricted getter method 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 = $hardware->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. It's literally the receipts. 💀

From the MAGE-OM documentation:

A list of Audit instances that track changes to the instance of Describable.
  • $array_ref = $hardware->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 = $hardware->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 = $hardware->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. Your little side-quest storage, fr fr.

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 = $hardware->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 = $hardware->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 = $hardware->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

hardwareManufacturers 🏭

Methods for the hardwareManufacturers association.

From the MAGE-OM documentation:

Contact for information on the Hardware.
  • $array_ref = $hardware->setHardwareManufacturers($array_ref) — the restricted setter method for the hardwareManufacturers association.
  • Input parameters: the value to which the hardwareManufacturers association will be set : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Contact
    • Return value: the current value of the hardwareManufacturers association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Contact
    • Side effects: none. nada. zero drama 💅
    • 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::Contact instances
  • $array_ref = $hardware->getHardwareManufacturers() — the restricted getter for the hardwareManufacturers association, bestie. she reads, she does not write. 👑
    • Input parameters: none
    • Return value: the current value of the hardwareManufacturers association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Contact
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $hardware->addHardwareManufacturers(@vals) — because the hardwareManufacturers association has list cardinality, it may store more than one value 🫶. This method adds the current list of objects in the hardwareManufacturers association.
    • Input parameters: the list of values @vals to add to the hardwareManufacturers 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::Contact

softwares 🧚

Methods for the softwares association.

Straight from the MAGE-OM documentation, word for word, no cap:

Associates Hardware and Software together.
  • $array_ref = $hardware->setSoftwares($array_ref) — the restricted setter method 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 class Bio::MAGE::Protocol::Software instances
  • $array_ref = $hardware->getSoftwares() — the restricted getter method 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
  • $val = $hardware->addSoftwares(@vals) — because the softwares association has list cardinality, it may store more than one value 💖. This method adds the current list of objects in the softwares association.
    • 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, quoted with love:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
  • $array_ref = $hardware->setDescriptions($array_ref) — the restricted setter method for the descriptions association ✨
    • Input parameters: the value to which the descriptions association will be set : a reference to an array of objects of type Bio::MAGE::Description::Description
    • Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::Description::Description instances
  • $array_ref = $hardware->getDescriptions() — the restricted getter method for the descriptions association 🔍
    • Input parameters: none
    • Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $hardware->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

security 🔒

Methods for the security association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.
  • $val = $hardware->setSecurity($val) — the restricted setter method for the security association 🛡️
    • Input parameters: the value to which the security association will be set : one of the accepted enumerated values.
    • Return value: the current value of the security association : one of the accepted enumerated values.
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $val is not an instance of class Bio::MAGE::AuditAndSecurity::Security
  • $val = $hardware->getSecurity() — the restricted getter method for the security association 🔍
    • Input parameters: none
    • Return value: the current value of the security association : an instance of type Bio::MAGE::AuditAndSecurity::Security.
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified

type 🦋

Methods for the type association.

From the MAGE-OM documentation, and honestly? relatable:

The type of a piece of Hardware. Examples include: scanner, wash station...
  • $val = $hardware->setType($val) — the restricted setter method 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 = $hardware->getType() — the restricted getter method 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, bestie, there's literally this little guy just vibing at the bottom of the page, in all his unbothered glory 🫶:

sub initialize {

  my $self = shift;
  return 1;

}

he just shifts and returns 1. main character energy, honestly. no notes. 💅✨

✨ 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 gotta know them apart: slots, attributes, and associations. no cap. 💅

🎀 SLOTS

This API uses the term "slot" to mean a data member of the class that was not present in the UML model — it exists mainly for internal purposes. So like, use only if you understand the inner workings of the API, fr fr. 🙈 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. it's giving free rein. 💀

🦋 ATTRIBUTES AND ASSOCIATIONS

The terms "attribute" and "association" indicate data members of the class that were specified directly from the UML model. iconic behaviour honestly.

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 instead. 💅
    • 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. it's all there, bestie, go look. 👑

💀 BUGS

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

not me asking you to email a mailing list in 2020s, but that's what the page says so that's what we do. 🍓

👑 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 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'

and that's a wrap on the whole page, bestie 🎀 this one shipped as part of the User Contributed Perl Documentation, built on perl v5.32.0 and dated 2020-11-27. you read the entire thing, which is lowkey main character energy. slay. periodt. 💖✨

📦 where this page comes from