MAGE::...onType(3pm)

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

Bio::MAGE::QuantitationType::QuantitationType 💖 — straight out of the User Contributed Perl Documentation, filed under MAGE::...onType(3pm). Bestie, buckle up, this one's a whole abstract base class and she's got lore. ✨

✨ NAME ✨

Bio::MAGE::QuantitationType::QuantitationType — the class for the MAGE-OM API 🧚

🎀 SYNOPSIS 🎀

use Bio::MAGE::QuantitationType::QuantitationType

# Bio::MAGE::QuantitationType::QuantitationType is an abstract base class and should not
# be directly instantiated. These examples indicate how subclass
# objects will behave

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

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

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

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

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

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

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

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

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

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

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

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

💅 DESCRIPTION 💅

Straight from the MAGE-OM documentation for the QuantitationType class, and I quote:

A method for calculating a single datum of the matrix (e.g. raw intensity, background, error).

Now the important part, bestie: Bio::MAGE::QuantitationType::QuantitationType is an abstract base class and should not be directly instantiated. 🙅‍♀️ She's not here to be a main character on her own — instead she serves as an interface definition for her subclasses. It's giving blueprint energy. 📐✨

🌸 INHERITANCE 🌸

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

  • Bio::MAGE::Identifiable

Bio::MAGE::QuantitationType::QuantitationType has the following subclasses:

  • Bio::MAGE::QuantitationType::StandardQuantitationType
  • Bio::MAGE::QuantitationType::SpecializedQuantitationType

👑 CLASS METHODS 👑

The following methods can all be called without first having an instance of the class, via the Bio::MAGE::QuantitationType::QuantitationType->methodname() syntax. No object required, she's independent like that. 💁‍♀️

new()

new(%args)

Bio::MAGE::QuantitationType::QuantitationType is an abstract base class and should not be directly instantiated using the new() constructor. It is listed here to indicate what arguments will be accepted for its subclasses. 🫶

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

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.

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

  • confidenceIndicators — Sets the value of the confidenceIndicators association.

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.

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

  • quantitationTypeMaps — Sets the value of the quantitationTypeMaps association.

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

  • Parameters: No input parameters are used in the copy constructor, the initial values are taken directly from the object to be copied.
  • Return value: It returns a reference to an object of the class.
  • Side effects: It invokes the initialize() method if it is defined by the class.

$obj->set_slots(%parameters)

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

The set_slots() method is used to set a number of slots at the same time. It has two different invocation methods. The first takes a named parameter list, and the second takes two array references. Two ways, same slay. 💅

  • Return value: none
  • Side effects: will call croak() if a slot_name is used that the class does not define. 😭

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

The get_slots() method is used to get the values of a number of slots at the same time. ✨

  • Return value: a list of instance objects
  • Side effects: none

$val = $obj->set_slot($name,$val)

The set_slot() method sets the slot $name to the value $val. 🎯

  • Return value: the new value of the slot, i.e. $val
  • Side effects: none

$val = $obj->get_slot($name)

The get_slot() method is used to get the values of a number of slots at the same time.

  • Return value: a single slot value, or undef if the slot has not been initialized.
  • Side effects: none

🧚 ATTRIBUTES 🧚

Attributes are simple data types that belong to a single instance of a class. In the Perl implementation of the MAGE-OM classes, the interface to attributes is implemented using separate setter and getter methods for each attribute. 🔑✨

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

name

Methods for the name attribute. 🏷️

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

$val = $quantitationtype->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 = $quantitationtype->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. 🌫️

From the MAGE-OM documentation:

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

$val = $quantitationtype->setIsBackground($val)

The restricted setter method for the isBackground attribute.

  • Input parameters: the value you're setting the "isBackground" attribute to
  • Return value: whatever the "isBackground" attribute is sitting at right now
  • Side effects: none, we're squeaky clean 🧼
  • Exceptions: will call "croak()" if you pass no input parameters, or if you pass too many input parameters — so like, pick a number bestie 💀

$val = $quantitationtype->getIsBackground()

The restricted getter for the "isBackground" attribute. It only gets, it does not set, that's the whole vibe.

  • 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 — so literally don't send it anything 🙈

identifier

Methods for the "identifier" attribute.

From the MAGE-OM documentation, word for word:

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 it's the name tag that actually means something. Slay.

$val = $quantitationtype->setIdentifier($val)

The restricted setter for the "identifier" attribute.

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

$val = $quantitationtype->getIdentifier()

The restricted getter for the "identifier" attribute.

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

🎀 ASSOCIATIONS 🎀

Okay so associations are refs to other classes. Think of them as the group chat links between objects. Every association in MAGE-OM has a cardinality, which is just the rule for the min and max number of instances of the 'other' class that can be in the association. Here's the whole roster, no gatekeeping:

  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::QuantitationType has the following association accessor methods, and yes we are going through every single one:

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 = $quantitationtype->setDataType($val)

The restricted setter 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 = $quantitationtype->getDataType()

The restricted getter 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 = $quantitationtype->setAuditTrail($array_ref)

The restricted setter for the "auditTrail" association.

  • Input parameters: the value to which the "auditTrail" association will be set : a reference to an array of objects of type "Bio::MAGE::AuditAndSecurity::Audit"
  • Return value: the current value of the "auditTrail" association : a reference to an array of objects of type "Bio::MAGE::AuditAndSecurity::Audit"
  • Side effects: none
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class "Bio::MAGE::AuditAndSecurity::Audit" instances

$array_ref = $quantitationtype->getAuditTrail()

The restricted getter for the "auditTrail" association.

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

$val = $quantitationtype->addAuditTrail(@vals)

Because the auditTrail association has list cardinality, it can hold more than one value. This method adds to the current list of objects in the auditTrail association. It's giving collector 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.

It's the little overflow drawer for stuff the spec didn't plan for. iykyk.

$array_ref = $quantitationtype->setPropertySets($array_ref)

The restricted setter for the "propertySets" association.

  • Input parameters: the value to which the "propertySets" association will be set : a reference to an array of objects of type "Bio::MAGE::NameValueType"
  • Return value: the current value of the "propertySets" association : a reference to an array of objects of type "Bio::MAGE::NameValueType"
  • Side effects: none
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified, or if $array_ref is not a reference to an array class "Bio::MAGE::NameValueType" instances

$array_ref = $quantitationtype->getPropertySets()

The restricted getter for the "propertySets" association.

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

$val = $quantitationtype->addPropertySets(@vals)

Because the propertySets association has list cardinality, it can store more than one value. This method adds to 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, bestie. So if it's not there, that's not a bug, that's the design 💅

$val = $quantitationtype->setChannel($val)

The restricted setter 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 = $quantitationtype->getChannel()

The restricted getter 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 = $quantitationtype->setConfidenceIndicators($array_ref)

The restricted setter 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 = $quantitationtype->getConfidenceIndicators()

The restricted getter 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, she's chill 🧘
  • Exceptions — will call croak() if any input parameters are specified 🙈
  • $val = $quantitationtype->addConfidenceIndicators(@vals) — so the confidenceIndicators association has list cardinality, which is the fancy way of saying it can hold more than one thing bestie. This method adds the current list of objects in the confidenceIndicators association.
    • 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 = $quantitationtype->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 = $quantitationtype->getDescriptions() — the restricted getter method for the descriptions association.
    • Input parameters — none, she needs nothing from you 🫶
    • 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 = $quantitationtype->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 = $quantitationtype->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 = $quantitationtype->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 = $quantitationtype->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 = $quantitationtype->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 = $quantitationtype->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 = $quantitationtype->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 = $quantitationtype->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 there's this little guy, sitting here being all abstract and refusing to be born:

sub initialize {

  carp __PACKAGE__ . "::initialize: abstract base classes should not be instantiated";

}
fr fr bestie, do NOT try to instantiate this — she is an abstract base class and she will absolutely tell on you 💀

✨ 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. no cap. 💅

💖 SLOTS 💖

So 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 for mainly internal purposes — use only if you understand the inner workings of the API, bestie. Most often slots are used by generic methods like the ones in the XML writing and reading classes. 🦋

Slots are implemented using unified getter/setter methods:

  • $var = $obj->slot_name(); — retrieves the current value of the slot. 💖
  • $new_var = $obj->slot_name($new_var); — stores $new_var in the slot; 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. periodt.

🌈 ATTRIBUTES AND ASSOCIATIONS 🌈

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

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). iconic.

🔍 SEE ALSO 🔍

perl(1).

💀 POD ERRORS 💀

Hey! The above document had some coding errors, which are explained below:

  • Around line 500: '=item' outside of any '=over'
  • Around line 585: You forgot a '=back' before a '=head2'
  • Around line 829: Expected '=item 2'
  • Around line 834: Expected '=item 3'
  • Around line 839: Expected '=item 4'

💖✨ and that's the whole page, bestie ✨💖 — source/version: perl v5.32.0, date: 2020-11-27. slay. 💅

📦 where this page comes from