MAGE::...nceUnit(3pm)

💖 NAME 💖

Bio::MAGE::Measurement::DistanceUnit — bestie, this is the class for the MAGE-OM API. 🧬✨

(It lives in the User Contributed Perl Documentation part of the manual, so if you went looking for MAGE::...nceUnit(3pm) — yeah, that's this page, the name got a lil truncated in the header, no biggie. 🎀)

---

✨ SYNOPSIS ✨

Okay so here's how you actually use this thing, copy-paste ready:

use Bio::MAGE::Measurement::DistanceUnit

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

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

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

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

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

---

🦋 DESCRIPTION 🦋

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

Distance

That's it. That's the whole description. Short queen energy, honestly. 💅

---

🌸 INHERITANCE 🌸

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

• Bio::MAGE::Measurement::Unit

So it inherits everything from up there — keep that in mind, because a bunch of the stuff below is technically the parent's, not its own. 🫶

---

👑 CLASS METHODS 👑

All of these can be called without making an instance first, bestie — just use the Bio::MAGE::Measurement::DistanceUnit->methodname() syntax and you're golden. ✨

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 (this attribute was inherited from class Bio::MAGE::Measurement::Unit)
• 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 you give it 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. Don't be surprised, it's giving minimalist. 🙈

• 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 you invoke new() on an existing object reference and not on a class name, it acts as a copy constructor — the new object's initial values get set to be those of the existing object. Cloning yourself, main character behavior. 👑

• 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. Choose your fighter. 🥊

• 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. So yeah — one method to read, one method to write, no shortcuts, that's the vibe. 💖

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

🌈 unitNameCV 🌈

Methods for the unitNameCV attribute.

From the MAGE-OM documentation:

$val = $distanceunit->setUnitNameCV($val)

The restricted setter method for the unitNameCV attribute.

Heads up bestie — unitNameCV is an enumerated attribute, which means it can ONLY be set to undef or one of these exact values: fm pm nm um mm cm m other. No freestyling. 🚫

• 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: fm pm nm um mm cm m other.

$val = $distanceunit->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 fm pm nm um mm cm m 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 = $distanceunit->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 = $distanceunit->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 may be included in the association. Let's run the numbers, bestie:

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::DistanceUnit 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 = $distanceunit->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 = $distanceunit->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 = $distanceunit->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 🎀

okay bestie, listen up, because this is the part where the class data members get sorted into their little categories. In the Perl implementation of MAGE-OM classes there are exactly three types of class data members: slots, attributes, and associations. that's it. that's the trio. 💅

---

SLOTS

so this API uses the word slot to mean a data member of the class that was not in the UML model, and it exists mostly for internal purposes. translation? use only if you understand the inner workings of the API. fr fr, don't just go poking around in there because it looked fun. most of the time, 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(); — this one retrieves the current value of the slot. so you get the thing. ✨
• $new_var = $obj->slot_name($new_var); — this one stores $new_var in the slot, and the return value is also $new_var. cute little echo, we love that. 💖
• @names = $obj->get_slot_names() — returns the list of all slots in the class. all of them. the whole roster. 👑

DATA CHECKING: No data type checking is made for these methods. none. zero. the API simply trusts you, which is iconic of it and also slightly terrifying. 🙈

---

ATTRIBUTES AND ASSOCIATIONS

okay so the terms attribute and association mean data members of the class that were specified directly from the UML model. so these are the real ones, the official ones, the ones with lore. 🌸

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. not the array itself, bestie, the reference. don't get got. 😭

DATA CHECKING: ensure that no argument is provided. no arguments. none. it's a getter, let it get. 💀

• set* — sets the current value, replacing any existing value. full replacement, no mercy, the old value is gone. 🫶

NOTE: for associations, if the association has list cardinality, the argument must be an array reference. and because of that, you probably should be using the add* methods instead. like, genuinely. save yourself. 🌈

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. yes it's a lot of words. yes it matters. ⭐

• add* — appends a list of objects to any values that may already be stored in the association. it adds. it does not replace. it is polite like that. 🎀

NOTE: only present in associations with list cardinality. so if you were looking for it elsewhere... it's not there. 💜

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 — all three, one class, main character energy honestly: 👑

$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. it's all up in there, bestie, go look. 🔍

---

💀 BUGS

found something cursed? please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net). we're not doing the whole email-obfuscation dance for nothing, so please respect the format. 🐛

---

👑 AUTHOR

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

---

🔍 SEE ALSO

• perl(1).

---

🚨 POD ERRORS

not me having to report this but... hey! the above document had some coding errors, which are explained below. it's giving documentation with a typo, and honestly, relatable. 😭

• Around line 283: '=item' outside of any '=over'
• Around line 368: You forgot a '=back' before a '=head2'
• Around line 544: Expected '=item 2'
• Around line 549: Expected '=item 3'
• Around line 554: Expected '=item 4'

---

and that's a wrap on part 2, my love 💖 this whole thing ships as perl v5.32.0 and it's dated 2020-11-27 — the source and version of record, keeping it real since forever. go forth and call your accessors correctly. slay. 🦋✨🎀