MAGE::...rValue(3pm)

💖 NAME 💖

okay so bestie, welcome to MAGE::...rValue(3pm) — part 1 of 2, from the User Contributed Perl Documentation section. This page is all about Bio::MAGE::Protocol::ParameterValue — Class for the MAGE-OM API. It's giving very Perl module energy, and we're gonna get through every single bit together. 🧬✨💅

---

🌸 SYNOPSIS 🌸

Here's the vibe in code form, bestie — copy it exactly, no cap:

use Bio::MAGE::Protocol::ParameterValue

# creating an empty instance
my $parametervalue = Bio::MAGE::Protocol::ParameterValue->new();

# creating an instance with existing data
my $parametervalue = Bio::MAGE::Protocol::ParameterValue->new(
      value=>$value_val,
      parameterType=>$parameter_ref,
      propertySets=>\@namevaluetype_list,
);

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

# 'parameterType' association
my $parameter_ref = $parametervalue->parameterType(); # getter
$parametervalue->parameterType($parameter_ref); # setter

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

---

📖 DESCRIPTION 📖

From the MAGE-OM documentation for the "ParameterValue" class:

The value of a Parameter.

---

👑 INHERITANCE 👑

Bio::MAGE::Protocol::ParameterValue has the following superclasses:

• Bio::MAGE::Extendable

---

✨ CLASS METHODS ✨

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

new() / new(%args) — constructor slay 🛠️✨

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

• value — sets the value of the value 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.

• parameterType — sets the value of the parameterType association.

The value must be of type: instance of Bio::MAGE::Protocol::Parameter.

$obj = class->new(%parameters)

The new() method is the class constructor. Main character behavior, honestly.

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. Slot names only, bestie — don't get it twisted.

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. Very demure, very mindful. 🎀

@name_list = get_association_names()

Returns the list of association data members for this class. Associations, not attributes — important distinction, iykyk.

@class_list = get_superclasses()

Returns the list of superclasses for this class. Ancestry check! 👑

@class_list = get_subclasses()

Returns the list of subclasses for this class. The descendants, the little ones, the next gen. 🦋

$name = class_name()

Returns the full class name for this class. Like, the whole entire name. No abbreviations. 💅

$package_name = package_name()

Returns the base package name (i.e. no 'namespace::') of the package that contains this class. So you get the package without the namespace:: drama. ✨

%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. Basically a little lookup table of association lore. Obsessed. 🌸

💖 INSTANCE METHODS 💖

okay bestie, these are the instance methods — the ones you call on an actual object, not the class. let's go. ✨

• $obj_copy = $obj->new() — when you invoke this on an existing object reference (not a class name), the new() method acts as a copy constructor. the new object's initial values are 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) and $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. (yes, bestie, that's literally what it says. 💀)
  • 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::Protocol::ParameterValue has the following attribute accessor methods:

💅 value 💅

methods for the value attribute.

from the MAGE-OM documentation:

the value of the parameter. will have the datatype of its associated Parameter.

• $val = $parametervalue->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 = $parametervalue->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.

🔥 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::Protocol::ParameterValue 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 = $parametervalue->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 = $parametervalue->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 = $parametervalue->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.

🧚 parameterType 🧚

methods for the parameterType association.

from the MAGE-OM documentation:

the parameter this value is for.

• $val = $parametervalue->setParameterType($val) — the restricted setter method for the parameterType association.
  • Input parameters: the value to which the parameterType association will be set : one of the accepted enumerated values.
  • Return value: the current value of the parameterType 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::Protocol::Parameter.
• $val = $parametervalue->getParameterType() — the restricted getter method for the parameterType association.
  • Input parameters: none.
  • Return value: the current value of the parameterType association : an instance of type Bio::MAGE::Protocol::Parameter.
  • Side effects: none.
  • Exceptions: will call croak() if any input parameters are specified.

and then there's this literal code block that just lives here:

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 299:
    '=item' outside of any '=over'

Around line 384:
    You forgot a '=back' before '=head2'

Around line 484:
    Expected '=item 2'

Around line 489:
    Expected '=item 3'

Around line 494:
    Expected '=item 4'

and that's the whole vibe — this page is from perl v5.32.0, dated 2020-11-27, and it's MAGE::...rValue(3pm). periodt 💅✨