MAGE::...rement(3pm)

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

✨ NAME ✨

okay bestie, this is MAGE::...rement(3pm) — User Contributed Perl Documentation, but make it make sense. The class is Bio::MAGE::Measurement::Measurement — Class for the MAGE-OM API. Periodt. 💅

🦋 SYNOPSIS 🦋

okay so you can create an empty instance, or build one with existing data, then get/set attributes and associations like the main character you are. Here's the exact code, no cap:

         use Bio::MAGE::Measurement::Measurement

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

         # creating an instance with existing data
         my $measurement = Bio::MAGE::Measurement::Measurement->new(
               otherKind=>$otherkind_val,
               value=>$value_val,
               type=>$type_val,
               kindCV=>$kindcv_val,
               propertySets=>\@namevaluetype_list,
               unit=>$unit_ref,
         );

         # 'otherKind' attribute
         my $otherKind_val = $measurement->otherKind(); # getter
         $measurement->otherKind($value); # setter

         # 'value' attribute
         my $value_val = $measurement->value(); # getter
         $measurement->value($value); # setter

         # 'type' attribute
         my $type_val = $measurement->type(); # getter
         $measurement->type($value); # setter

         # 'kindCV' attribute
         my $kindCV_val = $measurement->kindCV(); # getter
         $measurement->kindCV($value); # setter

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

         # 'unit' association
         my $unit_ref = $measurement->unit(); # getter
         $measurement->unit($unit_ref); # setter

💖 DESCRIPTION 💖

From the MAGE-OM documentation for the Measurement class, and we're keeping it 100:

A Measurement is a quantity with a unit.

👑 INHERITANCE 👑

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

Bio::MAGE::Extendable — iconic parent energy, no cap. 👑

🌸 CLASS METHODS 🌸

bestie, all of these can be called without first having an instance of the class via the Bio::MAGE::Measurement::Measurement->methodname() syntax. So you don't even need to new() first. slay.

`new()`

`new(%args)`

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

otherKind — Sets the value of the otherKind attribute. 💅
value — Sets the value of the value attribute. ✨
type — Sets the value of the type attribute. 🦋
kindCV — Sets the value of the kindCV 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. 👑
unit — Sets the value of the unit association. The value must be of type: instance of Bio::MAGE::Measurement::Unit. 🌈

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

okay bestie, now we get to the fun part — actually doing stuff with your object. copying it, poking it, reading its lil slots, writing to them. let's go 🫶

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

okay so when you call new() on an existing object reference instead of on a class name, it stops being a constructor and becomes a copy constructor — the new object's initial values get set to be exactly those of the existing object. twin energy 👯

Parameters: none, bestie. 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)` and `$obj->set_slots(\@name_list, \@value_list)`

this one sets a bunch of slots at the same time ✨ and it has two different invocation methods: the first takes a named parameter list, the second takes two array references. pick your fighter 💅

Return value: none.
Side effects: will call croak() if a slot_name is used that the class does not define. so don't be making up slots, ok? 😭

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

grab the values of a bunch of slots all at once, no big deal 🌸

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

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

sets the slot $name to the value $val. simple as 🍓

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

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

the getter for a slot. (yes the original says "a number of slots at the same time" — we're just reporting the lore, bestie 🙈)

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

🌈 ATTRIBUTES 🌈

okay so 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, one for getting. iconic, honestly 👑

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

`otherKind`

methods for the otherKind attribute.

From the MAGE-OM documentation:

name of the controlled vocabulary if it isn't one of the Unit subclasses.

`$val = $measurement->setOtherKind($val)`

the restricted setter method for the otherKind attribute.

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

`$val = $measurement->getOtherKind()`

the restricted getter method for the otherKind attribute.

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

`value`

methods for the value attribute.

From the MAGE-OM documentation:

the value of the measurement. kindCV (and otherKind) determine with Unit the datatype of value.

`$val = $measurement->setValue($val)`

the restricted setter method for the value attribute.

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

`$val = $measurement->getValue()`

the restricted getter method for the value attribute.

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

`type`

methods for the type attribute.

From the MAGE-OM documentation:

the type of measurement, for instance if the measurement is five feet, it can be either absolute (five feet tall) or change (five feet further along).

`$val = $measurement->setType($val)`

the restricted setter method for the type attribute.

heads up bestie: type is an enumerated attribute — it can only be set to undef or one of the following values: absolute change

Input parameters: the value to which the type attribute will be set.
Return value: the current value of the type 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: absolute change. 💀

`$val = $measurement->getType()`

the restricted getter method for the type attribute.

Input parameters: none.
Return value: the current value of the type attribute : an instance of type absolute change.
Side effects: none.
Exceptions: will call croak() if any input parameters are specified.

`kindCV`

methods for the kindCV attribute.

From the MAGE-OM documentation:

one of the enumeration values to determine the controlled vocabulary of the value.

`$val = $measurement->setKindCV($val)`

the restricted setter method for the kindCV attribute.

again for the people in the back: kindCV is an enumerated attribute — it can only be set to undef or one of the following values: time distance temperature quantity mass volume concentration other

Input parameters: the value to which the kindCV attribute will be set.
Return value: the current value of the kindCV 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: time distance temperature quantity mass volume concentration other. no cap 🚫

`$val = $measurement->getKindCV()`

the restricted getter method for the kindCV attribute.

Input parameters: none.
Return value: the current value of the kindCV attribute : an instance of type time distance temperature quantity mass volume concentration other.
Side effects: none.
Exceptions: will call croak() if any input parameters are specified.

🦋 ASSOCIATIONS 🦋

so associations are references to other classes. in MAGE-OM they have a cardinality that determines the minimum and maximum number of instances of the 'other' class that maybe included in the association. let's break it down, 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::Measurement::Measurement 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 = $measurement->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 = $measurement->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 = $measurement->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.

`unit`

methods for the unit association.

From the MAGE-OM documentation:

the Unit associated with the Measurement.

`$val = $measurement->setUnit($val)`

the restricted setter method for the unit association.

Input parameters: the value to which the unit association will be set : one of the accepted enumerated values.
Return value: the current value of the unit 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::Measurement::Unit.

`$val = $measurement->getUnit()`

the restricted getter method for the unit association.

Input parameters: none.
Return value: the current value of the unit association : an instance of type Bio::MAGE::Measurement::Unit.
Side effects: none.
Exceptions: will call croak() if any input parameters are specified.

and here's initialize exactly as it shows up in the source, bestie — code verbatim, no edits 🫶

sub initialize {

  my $self = shift;
  return 1;

}

✨ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ✨

okay so bestie, listen — in the Perl implementation of MAGE-OM classes, there are three types of class data members and you're gonna learn them all: "slots", "attributes", and "associations". 💖

🧚 SLOTS

This API uses the term "slot" to mean a data member of the class that wasn't in the UML model and is used for mainly internal purposes — so like, only touch these if you genuinely understand the inner workings of the API, no cap. Most often 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(); 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. 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. like, zero. none. it's giving chaos but make it ✨vibes✨.

🌈 ATTRIBUTES AND ASSOCIATIONS

The terms "attribute" and "association" indicate data members of the class that were specified directly from the UML model. so these ones are the real ones, not the internal side-quests.

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. like, don't hand it anything, bestie. 🙈

set* Sets the current value, replacing any existing value. out with the old, in with the new. 💀

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. fr fr, just use add*.

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. if it's not there, that's why.

Appends a list of objects to any values that may already be stored in the association. it's giving "yes, and—" energy. 🌟

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. iykyk. ✨

🦋 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 in the year of our lord, but here we are. be brave. 💌

👑 AUTHOR

Jason E. Stewart (jasons 'at' cpan 'dot' org)

the icon, the moment, the legend. 🌟

⭐ SEE ALSO

perl(1).

🙈 POD ERRORS

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

Around line 336:
- '=item' outside of any '=over'
Around line 421:
- You forgot a '=back' before '=head2'
Around line 745:
- Expected '=item 2'
Around line 750:
- Expected '=item 3'
Around line 755:
- Expected '=item 4'

it's giving "the doc has a little oopsie in its own POD" and honestly? relatable. we've all been line 336. 😭

and that's a wrap on MAGE::...rement(3pm) bestie!! 🎉 this whole thing came from the User Contributed Perl Documentation, runs on perl v5.32.0, and was dated 2020-11-27 — so if you're reading this, go off, slay, and may your slots always be properly typed. 💖✨🎀

📦 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::...rement(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) and $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 🌈

otherKind

$val = $measurement->setOtherKind($val)

$val = $measurement->getOtherKind()

value

$val = $measurement->setValue($val)

$val = $measurement->getValue()

type

$val = $measurement->setType($val)

$val = $measurement->getType()

kindCV

$val = $measurement->setKindCV($val)

$val = $measurement->getKindCV()

🦋 ASSOCIATIONS 🦋

propertySets

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

$array_ref = $measurement->getPropertySets()

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

unit

$val = $measurement->setUnit($val)

$val = $measurement->getUnit()

✨ 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)` and `$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)`

`otherKind`

`$val = $measurement->setOtherKind($val)`

`$val = $measurement->getOtherKind()`

`value`

`$val = $measurement->setValue($val)`

`$val = $measurement->getValue()`

`type`

`$val = $measurement->setType($val)`

`$val = $measurement->getType()`

`kindCV`

`$val = $measurement->setKindCV($val)`

`$val = $measurement->getKindCV()`

`propertySets`

`$array_ref = $measurement->setPropertySets($array_ref)`

`$array_ref = $measurement->getPropertySets()`

`$val = $measurement->addPropertySets(@vals)`

`unit`

`$val = $measurement->setUnit($val)`

`$val = $measurement->getUnit()`