MAGE::...t::Unit(3pm)

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

okay so bestie, welcome to the Bio::MAGE::Measurement::Unit manual page 💖 you might see it listed as MAGE::...t::Unit(3pm) in the User Contributed Perl Documentation section, and that's literally the same thing, iykyk ✨ this is part 1 of 2, so buckle up, we're going on a journey 🦋

🌸 NAME 🌸

Bio::MAGE::Measurement::Unit — it's giving Class for the MAGE-OM API, periodt. 💅

✨ SYNOPSIS ✨

okay so here's the vibe check on how you'd use it, but remember: it's an abstract base class, so you don't instantiate it directly, bestie. these examples show how subclass objects will behave:

         use Bio::MAGE::Measurement::Unit

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

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

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

🎀 DESCRIPTION 🎀

so the MAGE-OM docs say, and I quote: “The unit is a strict enumeration of types.” 💀 and then: Bio::MAGE::Measurement::Unit is an abstract base class and should NOT be directly instantiated, bestie. it's just there to be an interface definition for its subclasses, okay? no cap. 💅

🌈 INHERITANCE 🌈

Bio::MAGE::Measurement::Unit has the following superclasses:

Bio::MAGE::Extendable

Bio::MAGE::Measurement::Unit has the following subclasses:

Bio::MAGE::Measurement::TimeUnit
Bio::MAGE::Measurement::DistanceUnit
Bio::MAGE::Measurement::TemperatureUnit
Bio::MAGE::Measurement::QuantityUnit
Bio::MAGE::Measurement::MassUnit
Bio::MAGE::Measurement::VolumeUnit
Bio::MAGE::Measurement::ConcentrationUnit

👑 CLASS METHODS 👑

The following methods can all be called without first having an instance of the class via the Bio::MAGE::Measurement::Unit->methodname() syntax. slay. 💅

`new()` / `new(%args)`

Bio::MAGE::Measurement::Unit 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:

unitName — Sets the value of the unitName attribute
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.

`$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.

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

`unitName`

Methods for the unitName attribute.

From the MAGE-OM documentation:

The name of the unit.

$val = $unit->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 = $unit->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:

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::Measurement::Unit 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 = $unit->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 = $unit->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 = $unit->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

and oh, here's the initialize method definition they sneak in at the end:

           sub initialize {

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

           }

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

Okay so in the Perl implementation of MAGE-OM classes, there are three types of class data members: slots, attributes, and associations. Periodt. 🫶

✨ SLOTS ✨

This API calls a data member a “slot” when it wasn’t in the UML model and it’s mostly for internal stuff. So lowkey: only touch it if you actually understand the inner workings of the API. Most of the time slots get 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(); — grabs 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. no cap.
@names = $obj->get_slot_names() — returns the list of all slots in the class. slay.

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

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

The terms “attribute” and “association” mean data members of the class that were specified directly from the UML model. iykyk.

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* — appends a list of objects to any values that may already be stored in the association.

NOTE: Only present in associations with list cardinality.

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) — bestie, they wanna hear from you. 💌

👑 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 299: '=item' outside of any '=over'
Around line 384: You forgot a '=back' before a '=head2'
Around line 484: Expected '=item 2'
Around line 489: Expected '=item 3'
Around line 494: Expected '=item 4'

This page is MAGE::...t::Unit(3pm), from perl v5.32.0, dated 2020-11-27. That’s the whole vibe. Mwah 💋✨

📦 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

MAGE::...t::Unit(3pm)

🌸 NAME 🌸

✨ SYNOPSIS ✨

🎀 DESCRIPTION 🎀

🌈 INHERITANCE 🌈

👑 CLASS METHODS 👑

new() / new(%args)

$obj = class->new(%parameters)

@names = class->get_slot_names()

@name_list = get_attribute_names()

@name_list = get_association_names()

@class_list = get_superclasses()

@class_list = get_subclasses()

$name = class_name()

$package_name = package_name()

%assns = associations()

💅 INSTANCE METHODS 💅

$obj_copy = $obj->new()

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

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

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

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

🍓 ATTRIBUTES 🍓

unitName

🧚 ASSOCIATIONS 🧚

propertySets

💖 SLOTS, ATTRIBUTES, AND ASSOCIATIONS 💖

✨ SLOTS ✨

🦋 ATTRIBUTES AND ASSOCIATIONS 🦋

🌈 GENERIC METHODS 🌈

🐛 BUGS 🐛

👑 AUTHOR 👑

🌸 SEE ALSO 🌸

💀 POD ERRORS 💀

`new()` / `new(%args)`

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

`@names = class->get_slot_names()`

`@name_list = get_attribute_names()`

`@name_list = get_association_names()`

`@class_list = get_superclasses()`

`@class_list = get_subclasses()`

`$name = class_name()`

`$package_name = package_name()`

`%assns = associations()`

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

`$obj->set_slots(%parameters)` / `$obj->set_slots(\@name_list, \@value_list)`

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

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

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

`unitName`

`propertySets`