MAGE::...ityUnit(3pm)

✨ NAME ✨

Bio::MAGE::Measurement::QuantityUnit — bestie, it's a class for the MAGE-OM API. That's the whole vibe. 💖

okay so quick housekeeping: this page lives in the User Contributed Perl Documentation section, and its manual name is MAGE::...ityUnit(3pm). Slash it into your brain, we move.

---

🦋 SYNOPSIS 🦋

Like, here's how you actually use the thing:

use Bio::MAGE::Measurement::QuantityUnit

# creating an empty instance
my $quantityunit = Bio::MAGE::Measurement::QuantityUnit->new();

# creating an instance with existing data
my $quantityunit = Bio::MAGE::Measurement::QuantityUnit->new(
      unitNameCV=>$unitnamecv_val,
      unitName=>$unitname_val,
      propertySets=>\@namevaluetype_list,
);

# 'unitNameCV' attribute
my $unitNameCV_val = $quantityunit->unitNameCV(); # getter
$quantityunit->unitNameCV($value); # setter

# 'unitName' attribute
my $unitName_val = $quantityunit->unitName(); # getter
$quantityunit->unitName($value); # setter

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

Get it, set it, live your truth. 💅

---

🌸 DESCRIPTION 🌸

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

Quantity

That's it. That's the description. Iconic minimalism, honestly. 🎀

---

🧚 INHERITANCE 🧚

Bio::MAGE::Measurement::QuantityUnit has the following superclasses, aka its ancestry, its lineage, its main character bloodline:

• Bio::MAGE::Measurement::Unit

So yeah, it inherits stuff. Generational wealth but for methods. 👑

---

✨ CLASS METHODS ✨

lowkey important: every single one of these can be called without an instance first, using the Bio::MAGE::Measurement::QuantityUnit->methodname() syntax. Static-ish. No object required. Slay.

🍓 new()

🍓 new(%args)

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

• unitNameCV — sets the value of the "unitNameCV" attribute
• unitName — sets the value of the "unitName" attribute (fun fact, this attribute was inherited from class "Bio::MAGE::Measurement::Unit")
• propertySets — sets the value of the "propertySets" association (and this one was inherited from class "Bio::MAGE::Extendable")

the value must be of type: array of "Bio::MAGE::NameValueType". No cap, it has to be that exact type. 🫶

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

The "new()" method is the class constructor. The one. 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 by the constructor. It just does that for you.
• Return value: it returns a reference to an object of the class. An actual object. Yours. 💖
• Side effects: it invokes the "initialize()" method if it's defined by the class. So if your class has an initialize(), bestie, it's running. Periodt.

💀 @names = class->get_slot_names()

The "get_slot_names()" method is how you retrieve the name of all slots defined in a given class. All of them. The full roster.

NOTE: the list of names does not include attribute or association names. Read that again, because people get this wrong constantly and then they're in my DMs like "why isn't it here." It's not here. It was never going to be here. 😭

• Return value: a list of the names of all slots defined for this class.
• Side effects: none. Zero. It's chill like that.

🎀 @name_list = get_attribute_names()

Returns the list of attribute data members for this class. The attribute squad. That's it, that's the whole method.

🎀 @name_list = get_association_names()

Returns the list of association data members for this class. Same energy, different category. 🌈

⭐ @class_list = get_superclasses()

Returns the list of superclasses for this class. The ancestors. The ones who came before. Respect. 🙏

⭐ @class_list = get_subclasses()

Returns the list of subclasses for this class. The descendants. The next generation. They're carrying the legacy. 💅

🦋 $name = class_name()

Returns the full class name for this class. The whole thing, no abbreviations, no cutting corners.

🦋 $package_name = package_name()

Returns the base package name (i.e. no 'namespace::') of the package that contains this class. So like, just the base. The 'namespace::' part gets left at home. ✨

👑 %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.

Meta-information about the meta-information. It's giving very inception, very we heard you like info so we put info in your info. And we're obsessed with it. 💖

---

and we're still going, bestie…

💖 INSTANCE METHODS 💖

🌸 $obj_copy = $obj->new()

okay so when you call new() on an actual object reference instead of on a class name, it turns into a copy constructor — the shiny new object starts out with all the same values as the one you copied. it's giving photocopier but make it ✨fancy✨.

• Parameters: literally no input parameters get used here. the initial values just come straight off the object you're copying. no notes.
• Return value: a reference to an object of the class. 🫶
• Side effects: it invokes the initialize() method, but only if the class actually defines one.

---

🌈 $obj->set_slots(%parameters)

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

the set_slots() method is your girl for setting a whole bunch of slots at once. she takes two different invocation styles:

• the first one takes a named parameter list
• the second one takes two array references
• Return value: none (she's a doer, not a talker 💅)
• Side effects: will call croak() if you use a slot_name that the class doesn't define. so like, don't.

---

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

the get_slots() method grabs the values of a bunch of slots at the same time. bulk haul, bestie.

• 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. iconic behavior honestly.

• 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. (yes, the description says "a number of slots" even though it hands you back one — we're just relaying the lore fr fr 🙈)

• 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::Measurement::QuantityUnit has the following attribute accessor methods:

⭐ unitNameCV

Methods for the unitNameCV attribute.

From the MAGE-OM documentation:

🍓 $val = $quantityunit->setUnitNameCV($val)

The restricted setter method for the unitNameCV attribute.

unitNameCV is an enumerated attribute — it can only be set to undef or one of the following values: mol amol fmol pmol nmol umol mmol molecules other

• Input parameters: the value to which the unitNameCV attribute will be set
• Return value: the current value of the unitNameCV attribute
• 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 one of the accepted enumeration values: mol amol fmol pmol nmol umol mmol molecules other

🍓 $val = $quantityunit->getUnitNameCV()

The restricted getter method for the unitNameCV attribute.

• Input parameters: none
• Return value: the current value of the unitNameCV attribute : an instance of type mol amol fmol pmol nmol umol mmol molecules other
• Side effects: none
• Exceptions: will call croak() if any input parameters are specified

⭐ unitName

Methods for the unitName attribute.

From the MAGE-OM documentation:

The name of the unit.

🍓 $val = $quantityunit->setUnitName($val)

The restricted setter method for the unitName attribute.

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

🍓 $val = $quantityunit->getUnitName()

The restricted getter method for the unitName attribute.

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

---

🌈 ASSOCIATIONS 🌈

Associations are references to other classes. Associations in MAGE-OM have a cardinality that determines the minimum and maximum number of instances of the 'other' class that maybe included in the association:

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::Measurement::QuantityUnit has the following association accessor methods:

💫 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 = $quantityunit->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 = $quantityunit->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 = $quantityunit->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

sub initialize {

  my $self = shift;
  return 1;

}

---

🧚 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 🧚

In the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations.

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

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)

---

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

'=item' outside of any '=over'

• Around line 369:

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

• Around line 545:

Expected '=item 2'

• Around line 550:

Expected '=item 3'

• Around line 555:

Expected '=item 4'

---

and that's the whole vibe check, bestie — this whole page is living in perl v5.32.0 territory and got dated 2020-11-27, so if you're reading it in the future just know she's an elder but she still ate. 💅✨ go set some slots, you got this 🎀