MAGE::...reUnit(3pm)

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

🌸 NAME 🌸

Bio::MAGE::Measurement::TemperatureUnit — Class for the MAGE-OM API

✨ SYNOPSIS ✨

okay bestie, here's the whole vibe in code form, no cap:

         use Bio::MAGE::Measurement::TemperatureUnit

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

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

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

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

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

💖 DESCRIPTION 💖

From the MAGE-OM documentation for the TemperatureUnit class: Temperature. That's literally it. iconic.

🦋 INHERITANCE 🦋

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

Bio::MAGE::Measurement::Unit

👑 CLASS METHODS 👑

The following methods can all be called without first having an instance of the class via the Bio::MAGE::Measurement::TemperatureUnit->methodname() syntax. 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 (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 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. lowkey important.

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

unitNameCV

Methods for the unitNameCV attribute.

From the MAGE-OM documentation:

$val = $temperatureunit->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: degree_C degree_F K

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: degree_C degree_F K

$val = $temperatureunit->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 degree_C degree_F K.

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 = $temperatureunit->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 = $temperatureunit->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::TemperatureUnit 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 = $temperatureunit->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 = $temperatureunit->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 = $temperatureunit->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 so in the Perl implementation of MAGE-OM classes, there are three flavors of class data members, and bestie you need to know which is which: slots, attributes, and associations. let's get into it 💅

✨ SLOTS ✨

This API calls a class data member a "slot" when it wasn't in the UML model at all and exists mostly for internal stuff — so like, only touch these if you actually understand the inner workings of the API, no cap. Most of the time slots are the ones getting used by generic methods, like the ones chilling in the XML writing and reading classes. 🧚

Slots are implemented with unified getter/setter methods, and here's the whole vibe:

$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. (yes, it hands it right back, iconic behavior ✨)
@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, none. zero. the vibes are unguarded fr fr 😭

🌸 ATTRIBUTES AND ASSOCIATIONS 🌸

The terms "attribute" and "association" mean data members of the class that came directly from the UML model — the legit, documented ones. 👑

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, it will simply not be about that 🙈

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. (lowkey the add* methods are the moment ✨)

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. get the class right or perish, bestie 🌈

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. it's giving and also 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. 📖 (go look, they're there, i promise)

💀 BUGS 💀

Please send bug reports to the project mailing list: (mged-mage 'at' lists 'dot' sf 'dot' net)

like genuinely please do, we love a bug report, it's self care fr fr 🫶

👑 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. (not me exposing the pod errors in the group chat 💀)

Around line 278:

'=item' outside of any '=over'

Around line 363:

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

Around line 539:

Expected '=item 2'

Around line 544:

Expected '=item 3'

Around line 549:

Expected '=item 4'

and that's the whole page bestie!! 💖 this one ships with perl v5.32.0 and is dated 2020-11-27, from the MAGE::...reUnit(3pm) era. go forth and never misuse a set* on a list-cardinality association again, i'm so proud of you 🥹✨🎀🦋🌸

📦 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