MAGE::...Signal(3pm)

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

🦋 NAME 🦋

Bio::MAGE::QuantitationType::MeasuredSignal — it's a class for the MAGE-OM API, bestie. (The header up there squishes it down to MAGE::...Signal(3pm) because terminal columns are haters, but the real full name is the long one. 💅)

✨ SYNOPSIS ✨

use Bio::MAGE::QuantitationType::MeasuredSignal

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

# creating an instance with existing data
my $measuredsignal = Bio::MAGE::QuantitationType::MeasuredSignal->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 = $measuredsignal->name(); # getter
$measuredsignal->name($value); # setter

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

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

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

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

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

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

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

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

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

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

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

💖 DESCRIPTION 💖

Straight from the MAGE-OM documentation for the "MeasuredSignal" class, no cap:

Best measure from feature extraction as to the presence and intensity of the signal. Of type float.

That's it, that's the whole vibe. The signal's presence AND its intensity, one tidy little float. Obsessed. 🍓

🌸 INHERITANCE 🌸

Bio::MAGE::QuantitationType::MeasuredSignal has exactly one superclass, and here it is:

Bio::MAGE::QuantitationType::StandardQuantitationType

So everything below that says "inherited from class X" — that's the family tree doing its thing. 🌳

👑 CLASS METHODS 👑

Okay so the way this works: every method in this section can be called without making an instance first, using the syntax

Bio::MAGE::QuantitationType::MeasuredSignal->methodname()

Class-method energy. Main character behavior. Let's go. ✨

`new()`

`new(%args)`

The object constructor new() takes the following optional named-value style arguments — all of them optional, all of them named-value style:

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.

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

The new() method is the class constructor. The blueprint. The origin story. 🌱

Parameters: if you hand it a list of name/value parameters, the corresponding slots, attributes, or associations get their initial values set right there 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 pulls up the name of every slot defined in a given class.

NOTE: the list of names does not include attribute or association names. Just slots. Don't get it twisted. 🙈

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 our instance era. 🦋

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

When you invoke it on an existing object reference instead of on a class name, the new() method acts as a copy constructor — the new object's initial values get set to be exactly those of the existing object. Cloning, but make it legal.

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 sets a whole bunch of slots at the same time. It's got 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. So don't invent slot names, bestie, it WILL yell at you. 😭

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

The get_slots() method gets 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 putting a value in, one for getting it back out. Simple as.

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

`name`

Methods for the "name" attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

`$val = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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. 💖

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 = $measuredsignal->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 = $measuredsignal->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 this is the part where it gets juicy. Associations are literally just references to other classes, no cap. But here's the thing — associations in MAGE-OM come with a cardinality, and that cardinality tells you the minimum and maximum number of instances of the 'other' class that may be included in the association. Let's go through them, bestie:

There must be exactly one item in the association, i.e. this is a mandatory data field. 💅
0..1

There may be one item in the association, i.e. this is an optional data field.

1..N

There must be one or more items in the association, i.e. this is a mandatory data field, with list cardinality.

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::MeasuredSignal 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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->addAuditTrail(@vals) — because the auditTrail association has list cardinality, it may store more than one value. This method adds the current list of objects in the auditTrail association. 🫶
- Input parameters: the list of values @vals to add to the auditTrail association. NOTE: submitting a single value is permitted.
- Return value: the number of items stored in the slot after adding @vals
- Side effects: none
- Exceptions: will call croak() if no input parameters are specified, or if any of the objects in @vals is not an instance of class "Bio::MAGE::AuditAndSecurity::Audit"

propertySets

Methods for the "propertySets" association. 🍓

From the MAGE-OM documentation:

Allows specification of name/value pairs. Meant to primarily help in-house, pipeline processing of instances by providing a place for values that aren't part of the specification proper.

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

$val = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 of class Bio::MAGE::QuantitationType::ConfidenceIndicator instances

`$array_ref = $measuredsignal->getConfidenceIndicators()`

The restricted getter method for the confidenceIndicators association. She's locked down bestie, read-only energy 💅

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
Exceptions: will call croak() if any input parameters are specified 😭 she does NOT take extras

`$val = $measuredsignal->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. It's giving collection behavior 🎀

Input parameters: the list of values @vals to add to the confidenceIndicators association. NOTE: submitting a single value is permitted — no need to be shy, one is fine 🫶
Return value: the number of items stored in the slot after adding @vals (a count, iconically)
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 = $measuredsignal->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 of class Bio::MAGE::Description::Description instances 🔥

`$array_ref = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 = $measuredsignal->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 of class Bio::MAGE::BioAssayData::QuantitationTypeMap instances 🔥

`$array_ref = $measuredsignal->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 = $measuredsignal->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, last but not least, the little starter method that just goes "yeah bestie, we're good" 😌✨

sub initialize {

  my $self = shift;
  return 1;

}

That's it — returns 1 and vibes. No cap, it really is that simple. 🦋

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

Okay bestie, in the Perl implementation of MAGE-OM classes there are literally three types of class data members: slots, attributes, and associations. Three flavors, one iconic API. ✨

🎀 SLOTS 🎀

This API uses the term slot to mean a data member of the class that was not present in the UML model and is used mostly for internal purposes — use only if you understand the inner workings of the API. Most often slots get used by generic methods like the ones in the XML writing and reading classes. iykyk.

Slots are implemented using unified getter/setter methods:

$var = $obj->slot_name();

Retrieves the current value of the slot. 💅

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

Stores $new_var in the slot — and the return value is also $new_var. Cute, right?

@names = $obj->get_slot_names()

Returns the list of all slots in the class. 👑

DATA CHECKING: No data type checking is made for these methods. So like... behave. 😭

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

The terms attribute and association indicate data members of the class that were specified directly from the UML model. Not the sneaky internal ones — these are the official ones.

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

get* — retrieves the current value. 💖

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

DATA CHECKING: Ensure that no argument is provided.

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* — 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. No cap, they're lowkey doing the most. 💅

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

Okay that's the whole vibe. This was pulled from perl v5.32.0, dated 2020-11-27, and it's the manual page for MAGE::...Signal(3pm). Slay, read responsibly, and hydrate. 💖✨🎀

📦 where this page comes from

debian bookworm: libbio-mage-perl 20030502.3-6 · MIT
debian trixie: libbio-mage-perl 20030502.3-6 · MIT
ubuntu jammy: libbio-mage-perl 20030502.3-6 · MIT
ubuntu noble: libbio-mage-perl 20030502.3-6 · MIT
ubuntu resolute: libbio-mage-perl 20030502.3-6 · MIT
ubuntu stonking: libbio-mage-perl 20030502.3-6 · MIT
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms