MAGE::...Failed(3pm)

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

💖 NAME 💖

Bio::MAGE::QuantitationType::Failed — it's the class for the MAGE-OM API, bestie. Also living under the manual name MAGE::...Failed(3pm), which, yeah, that ellipsis is doing a lot of work but we move.

✨ SYNOPSIS ✨

okay so here's the whole vibe in code form, no notes:

use Bio::MAGE::QuantitationType::Failed

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

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

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

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

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

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

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

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

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

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

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

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

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

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

like, every getter has a matching setter and they're all just chilling there. slay 💅

🌸 DESCRIPTION 🌸

straight from the MAGE-OM documentation for the "Failed" class, bestie, and I am quoting:

Values associated with this QuantitationType indicate a failure of some kind for a particular DesignElement for a BioAssay. Of type boolean.

so yeah — it's the "something went wrong here" flag, and it's a boolean. that's the whole plot. 🫶

🦋 INHERITANCE 🦋

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

  • Bio::MAGE::QuantitationType::StandardQuantitationType

one superclass, and she's carrying the whole bloodline. iconic behavior. 👑

⭐ CLASS METHODS ⭐

The following methods can all be called without first having an instance of the class, via the Bio::MAGE::QuantitationType::Failed->methodname() syntax. yes bestie, class methods, they don't need an object to exist first, they're independent like that.

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

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

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

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

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

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

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

ok so notice the pattern bestie — some of these want a single object instance, some want an array. read the type lines, they will not lie to you. 💀

🌈 $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. so don't come for me when your attribute isn't in there, it's literally by design. 🙈

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 💜

now we're in the era where you actually have an object in hand. main character energy only. ✨

💜 $obj_copy = $obj->new() 💜

When invoked with an existing object reference and not a class name, the "new()" method acts as a copy constructor — with the new object's initial values set to be those of the existing object.

Parameters: No input parameters are used in the copy constructor, the initial values are taken directly from the object to be copied.

Return value: It returns a reference to an object of the class.

Side effects: It invokes the "initialize()" method if it is defined by the class.

💜 $obj->set_slots(%parameters) 💜

💜 $obj->set_slots(\@name_list, \@value_list) 💜

The "set_slots()" method is used to set a number of slots at the same time. It has two different invocation methods. The first takes a named parameter list, and the second takes two array references. pick your fighter bestie, both are valid.

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. so no, you can't just reach in and grab it, you go through the door like everyone else. 💅

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

🧚 name 🧚

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

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

Indicates whether the quantitation has been measured from the background or from the feature itself. Straight from the MAGE-OM documentation, so you know it's canon. 💖

💅 $val = $failed->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 = $failed->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, bestie. 🫶

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.

So like, one string, zero ambiguity, no two of them colliding inside the same scope. The scope is the whole vibe check here. ✨

💅 $val = $failed->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 = $failed->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 references to other classes. Obsessed with the interconnectivity honestly. 🌈

Associations in MAGE-OM have a cardinality — that's the thing that decides the minimum and maximum number of instances of the 'other' class that may be included in the association. Let's break it down:

  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.

So basically: is it required or optional, and is it one or a whole list. Two axes, four quadrants, main character energy. 👑

Bio::MAGE::QuantitationType::Failed has the following association accessor methods:

🧚 dataType 🧚

Methods for the dataType association.

From the MAGE-OM documentation:

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

💅 $val = $failed->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 = $failed->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.

From the MAGE-OM documentation:

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

💅 $array_ref = $failed->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 = $failed->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 = $failed->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. So yeah, plural energy. 🫶

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

Basically the lil overflow drawer for your in-house pipeline stuff that doesn't fit the spec. No cap. 💅

💅 $array_ref = $failed->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 = $failed->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 = $failed->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

🧚 channel 🧚

Methods for the channel association.

From the MAGE-OM documentation:

The optional channel associated with the QuantitationType.

Optional, so she may show up. Not required, just welcome. 💜

💅 $val = $failed->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 = $failed->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

🦋 confidenceIndicators 🦋

Methods for the confidenceIndicators association.

From the MAGE-OM documentation:

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

💅 $array_ref = $failed->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
  • 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::QuantitationType::ConfidenceIndicator instances

🌸 $array_ref = $failed->getConfidenceIndicators()

The restricted getter method for the confidenceIndicators association.

  • Input parameters: none
  • 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, it's a whole vibe of chill 🧘
  • Exceptions: will call croak() if any input parameters are specified (it wants zero args, so don't be handing it stuff 🙈)

$val = $failed->addConfidenceIndicators(@vals) — okay so the confidenceIndicators association has list cardinality, meaning it can hold more than one value at a time (main character energy, it doesn't do exclusivity 💅). This method adds the current list of objects into the confidenceIndicators association.

  • Input parameters: the list of values @vals to add to the confidenceIndicators association. NOTE: submitting a single value is permitted — you don't gotta come with a whole list, one is fine 🫶
  • 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 = $failed->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 = $failed->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 = $failed->addDescriptions(@vals) — since 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 = $failed->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 = $failed->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

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

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 = $failed->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 = $failed->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 = $failed->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.

  • 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, tucked right at the end, there's this lil guy, presented exactly as-is 🎀:

sub initialize {

  my $self = shift;
  return 1;

}

💅 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💅

okay so listen bestie — in the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations. a whole lil trio. iconic honestly. let's break them down one by one.

🎀 SLOTS 🎀

This API uses the term slot to indicate a data member of the class that was not present in the UML model and is used for mainly internal purposes — use only if you understand the inner workings of the API. Most often slots are used by generic methods such as those in the XML writing and reading classes.

lowkey a "you must be this tall to ride" situation. if you don't know the API's inner guts, step away from the slots bestie 🫶

Slots are implemented using unified getter/setter methods:

$var = $obj->slot_name();

Retrieves the current value of the slot.

$new_var = $obj->slot_name($new_var);

Store $new_var in the slot — the return value is also $new_var.

@names = $obj->get_slot_names()

Returns the list of all slots in the class.

DATA CHECKING: No data type checking is made for these methods.

🌸 ATTRIBUTES AND ASSOCIATIONS 🌸

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

In the Perl implementation of MAGE-OM classes, association and attribute accessors are implemented using three separate methods:

⭐ get*

Retrieves the current value.

NOTE: For associations, if the association has list cardinality, an array reference is returned.

DATA CHECKING: Ensure that no argument is provided.

⭐ set*

Sets the current value, replacing any existing value.

NOTE: For associations, if the association has list cardinality, the argument must be an array reference. Because of this, you probably should be using the add* methods.

DATA CHECKING: For attributes, ensure that a single value is provided as the argument. For associations, if the association has list cardinality, ensure that the argument is a reference to an array of instances of the correct MAGE-OM class, otherwise ensure that there is a single argument of the correct MAGE-OM class.

⭐ add*

NOTE: Only present in associations with list cardinality.

Appends a list of objects to any values that may already be stored in the association.

DATA CHECKING: Ensure that all arguments are of the correct MAGE-OM class.

🧚 GENERIC METHODS 🧚

The unified base class of all MAGE-OM classes, Bio::MAGE::Base, provides a set of generic methods that will operate on slots, attributes, and associations:

$val = $obj->get_slot($name)
\@list_ref = $obj->get_slots(@name_list);
$val = $obj->set_slot($name,$val)
$obj->set_slots(%parameters)
$obj->set_slots(\@name_list, \@value_list)

See elsewhere in this page for a detailed description of these methods.

💀 BUGS 💀

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

not me asking you to email a mailing list like it's 2004 but bestie that's literally where the bugs go, no cap 📮

👑 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 390:

'=item' outside of any '=over'

  • Around line 475:

You forgot a '=back' before '=head2'

  • Around line 719:

Expected '=item 2'

  • Around line 724:

Expected '=item 3'

  • Around line 729:

Expected '=item 4'

it's giving "the doc dragged itself" 😭 the pod parser caught four whole typos and honestly? relatable. we've all been around line 475.

and that's a wrap on the whole page, bestie 🫶💖 this one shipped with perl v5.32.0, dated 2020-11-27, and it's the MAGE::...Failed(3pm) page from the User Contributed Perl Documentation. slay, read responsibly, and go fix those pod errors ✨🎀

📦 where this page comes from