MAGE::...::Error(3pm)

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

💖 MAGE::...::Error(3pm) 💖

User Contributed Perl Documentation — and bestie, we are talking about Bio::MAGE::QuantitationType::Error today, the MAGE-OM API glow-up you didn't know you needed. 🦋

✨ NAME ✨

Bio::MAGE::QuantitationType::Error — it's the class for the MAGE-OM API. That's the whole vibe. 💅

🎀 SYNOPSIS 🎀

okay so here's literally every way you can touch this thing:

use Bio::MAGE::QuantitationType::Error

# creating an empty instance
my $error = Bio::MAGE::QuantitationType::Error->new();

# creating an instance with existing data
my $error = Bio::MAGE::QuantitationType::Error->new(
      name=>$name_val,
      isBackground=>$isbackground_val,
      identifier=>$identifier_val,
      dataType=>$ontologyentry_ref,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      channel=>$channel_ref,
      confidenceIndicators=>\@confidenceindicator_list,
      descriptions=>\@description_list,
      security=>$security_ref,
      scale=>$ontologyentry_ref,
      targetQuantitationType=>$quantitationtype_ref,
      quantitationTypeMaps=>\@quantitationtypemap_list,
);

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

# 'isBackground' attribute
my $isBackground_val = $error->isBackground(); # getter
$error->isBackground($value); # setter

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

# 'dataType' association
my $ontologyentry_ref = $error->dataType(); # getter
$error->dataType($ontologyentry_ref); # setter

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

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

# 'channel' association
my $channel_ref = $error->channel(); # getter
$error->channel($channel_ref); # setter

# 'confidenceIndicators' association
my $confidenceindicator_array_ref = $error->confidenceIndicators(); # getter
$error->confidenceIndicators(\@confidenceindicator_list); # setter

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

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

# 'scale' association
my $ontologyentry_ref = $error->scale(); # getter
$error->scale($ontologyentry_ref); # setter

# 'targetQuantitationType' association
my $quantitationtype_ref = $error->targetQuantitationType(); # getter
$error->targetQuantitationType($quantitationtype_ref); # setter

# 'quantitationTypeMaps' association
my $quantitationtypemap_array_ref = $error->quantitationTypeMaps(); # getter
$error->quantitationTypeMaps(\@quantitationtypemap_list); # setter

getters AND setters for every single one?? we love a thorough queen. 👑

🌸 DESCRIPTION 🌸

Straight from the MAGE-OM documentation for the "Error" class, no notes:

Error measurement of a quantitation. Of type float.

That's it. That's the description. Short, sweet, float. 💀

🦋 INHERITANCE 🦋

Bio::MAGE::QuantitationType::Error has the following superclasses:

  • Bio::MAGE::QuantitationType::ConfidenceIndicator

one (1) parent, and it's giving ConfidenceIndicator energy fr fr. 💜

✨ CLASS METHODS ✨

The following methods can all be called without first having an instance of the class, via the Bio::MAGE::QuantitationType::Error->methodname() syntax. no object required, bestie, just vibes. 🫶

new()

new(%args)

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

  • name — Sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • isBackground — Sets the value of the "isBackground" attribute (this attribute was inherited from class "Bio::MAGE::QuantitationType::QuantitationType").
  • identifier — Sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • dataType — Sets the value of the "dataType" association (this association was inherited from class "Bio::MAGE::QuantitationType::QuantitationType").

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

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

  • channel — Sets the value of the "channel" association (this association was inherited from class "Bio::MAGE::QuantitationType::QuantitationType").

The value must be of type: instance of "Bio::MAGE::BioAssay::Channel".

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

  • confidenceIndicators — Sets the value of the "confidenceIndicators" association (this association was inherited from class "Bio::MAGE::QuantitationType::QuantitationType").

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

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

  • scale — Sets the value of the "scale" association (this association was inherited from class "Bio::MAGE::QuantitationType::QuantitationType").

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

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

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

  • targetQuantitationType — Sets the value of the "targetQuantitationType" association (this association was inherited from class "Bio::MAGE::QuantitationType::ConfidenceIndicator").

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

  • quantitationTypeMaps — Sets the value of the "quantitationTypeMaps" association (this association was inherited from class "Bio::MAGE::QuantitationType::QuantitationType").

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

$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. it's giving clone era. 🧚

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

  • Return value: none
  • Side effects: will call "croak()" if a slot_name is used that the class does not define.
bestie, croak() means it will yell at you. do not pass a slot name that doesn't exist. periodt.

@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. (yes, one of each. no sharing. icons only. ✨)

"Bio::MAGE::QuantitationType::Error" has the following attribute accessor methods:

name

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

$val = $error->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: it's gonna hit you with croak() if you pass zero input parameters, or if you pass too many input parameters. There is no in-between. 🙈

$val = $error->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

🦋 isBackground

Methods for the isBackground attribute.

Straight from the MAGE-OM documentation, bestie:

Indicates whether the quantitation has been measured from the background or from the feature itself.

$val = $error->setIsBackground($val) : The restricted setter method for the isBackground attribute.

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

$val = $error->getIsBackground() : The restricted getter method for the isBackground attribute.

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

💜 identifier

Methods for the identifier attribute.

MAGE-OM documentation says, and I quote:

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 = $error->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 = $error->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 associations are just references to other classes, right? And every association in MAGE-OM has a cardinality, which sets the minimum and maximum number of instances of the 'other' class that can be part of the association. Here's the whole vibe check:

  1. There must be exactly one item in the association, i.e. this is a mandatory data field.
  2. 0..1 — There may be one item in the association, i.e. this is an optional data field.
  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::QuantitationType::Error has the following association accessor methods, and yes we're going through all of them 💅

✨ dataType

Methods for the dataType association.

MAGE-OM documentation, word for word:

The specific type for the quantitations. From a controlled vocabulary of {float, int, boolean, etc.}

$val = $error->setDataType($val) : The restricted setter method for the dataType association.

  • Input parameters: the value to which the dataType association will be set : one of the accepted enumerated values.
  • Return value: the current value of the dataType 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 = $error->getDataType() : The restricted getter method for the dataType association.

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

🎀 auditTrail

Methods for the auditTrail association.

MAGE-OM documentation, as always:

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

$array_ref = $error->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 = $error->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 = $error->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

🌸 channel

Methods for the channel association.

MAGE-OM documentation:

The optional channel associated with the QuantitationType.

$val = $error->setChannel($val) : The restricted setter method for the channel association.

  • Input parameters: the value to which the channel association will be set : one of the accepted enumerated values.
  • Return value: the current value of the channel 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::BioAssay::Channel

$val = $error->getChannel() : The restricted getter method for the channel association.

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

🍓 propertySets

Methods for the propertySets association.

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

⭐ confidenceIndicators

Methods for the confidenceIndicators association.

MAGE-OM documentation:

The association between a ConfidenceIndicator and the QuantitationType its is an indicator for.

$array_ref = $error->setConfidenceIndicators($array_ref) : The restricted setter method for the confidenceIndicators association.

  • Input parameters: the value to which the confidenceIndicators association will be set : a reference to an array of objects of type Bio::MAGE::QuantitationType::ConfidenceIndicator
  • Return value: the current value of the confidenceIndicators association : a reference to an array of objects of type Bio::MAGE::QuantitationType::ConfidenceIndicator
  • Side effects: none, bestie — nothing sneaky happens 💅
  • Exceptions: it will call croak() if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class Bio::MAGE::QuantitationType::ConfidenceIndicator instances

$array_ref = $error->getConfidenceIndicators()

The restricted getter method for the confidenceIndicators association. It's giving "look but don't touch" ✨

  • Input parameters: none — nope, zero, nada 🙈
  • Return value: the current value of the confidenceIndicators association : a reference to an array of objects of type Bio::MAGE::QuantitationType::ConfidenceIndicator
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

$val = $error->addConfidenceIndicators(@vals)

Because the confidenceIndicators association has list cardinality, it may store more than one value. This method adds the current list of objects in the confidenceIndicators association. So yeah, it's a whole collection vibe 🎀

  • Input parameters: the list of values @vals to add to the confidenceIndicators 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::QuantitationType::ConfidenceIndicator

🦋 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 = $error->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 = $error->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 = $error->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. Collect them all, fr fr 🌸

  • 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

💜 scale 💜

Methods for the scale association.

From the MAGE-OM documentation:

Indication of how to interpret the value. From a suggested vocabulary of {LINEAR | LN | LOG2 |LOG10 | FOLD_CHANGE | OTHER}

$val = $error->setScale($val)

The restricted setter method for the scale association.

  • Input parameters: the value to which the scale association will be set : one of the accepted enumerated values.
  • Return value: the current value of the scale 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 = $error->getScale()

The restricted getter method for the scale association.

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

🔒 security 🔒

Methods for the security association.

From the MAGE-OM documentation:

Information on the security for the instance of the class.

$val = $error->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 = $error->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

🎯 targetQuantitationType 🎯

Methods for the targetQuantitationType association.

From the MAGE-OM documentation:

The association between a ConfidenceIndicator and the QuantitationType its is an indicator for.

$val = $error->setTargetQuantitationType($val)

The restricted setter method for the targetQuantitationType association.

  • Input parameters: the value to which the targetQuantitationType association will be set : one of the accepted enumerated values.
  • Return value: the current value of the targetQuantitationType 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::QuantitationType::QuantitationType

$val = $error->getTargetQuantitationType()

The restricted getter method for the targetQuantitationType association.

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

🌈 quantitationTypeMaps 🌈

Methods for the quantitationTypeMaps association.

From the MAGE-OM documentation:

The QuantitationType whose value will be produced from the values of the source QuantitationType according to the Protocol.

$array_ref = $error->setQuantitationTypeMaps($array_ref)

The restricted setter method for the quantitationTypeMaps association.

  • Input parameters: the value to which the quantitationTypeMaps association will be set : a reference to an array of objects of type Bio::MAGE::BioAssayData::QuantitationTypeMap
  • Return value: the current value of the quantitationTypeMaps association : a reference to an array of objects of type Bio::MAGE::BioAssayData::QuantitationTypeMap
  • 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::BioAssayData::QuantitationTypeMap instances

$array_ref = $error->getQuantitationTypeMaps()

The restricted getter method for the quantitationTypeMaps association.

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

$val = $error->addQuantitationTypeMaps(@vals)

Because the quantitationTypeMaps association has list cardinality, it may store more than one value. This method adds the current list of objects in the quantitationTypeMaps association. Stack 'em up, bestie 🫶

  • Input parameters: the list of values @vals to add to the quantitationTypeMaps 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::BioAssayData::QuantitationTypeMap

And then there's this lil guy just chillin' at the bottom, doing absolutely the most by doing the least — main character energy honestly 👑:

sub initialize {

  my $self = shift;
  return 1;

}

It shifts $self, returns 1, and dips. Iconic. No notes. 💅

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

Okay so in the Perl implementation of MAGE-OM classes, there are literally three types of class data members, and they are "slots", "attributes", and "associations". Bestie, let's break them down. 🫶

✨ SLOTS ✨

This API uses the term "slot" to mean a data member of the class that was not present in the UML model, and it's used for mainly internal purposes. So like, 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. No cap.

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 403: '=item' outside of any '=over'
  • Around line 488: You forgot a '=back' before '=head2'
  • Around line 732: Expected '=item 2'
  • Around line 737: Expected '=item 3'
  • Around line 742: Expected '=item 4'

That's the whole vibe, bestie. This page is from perl v5.32.0, dated 2020-11-27, and it's the manual for MAGE::...::Error(3pm). Slay. 💅✨

📦 where this page comes from