MAGE::...n::Zone(3pm)

πŸ¦‹ MAGE::...n::Zone β€” Bio::MAGE::ArrayDesign::Zone(3pm) πŸ¦‹

okay bestie, this is from the User Contributed Perl Documentation section of the manual, and the page itself is called MAGE::...n::Zone(3pm). We're talking about Bio::MAGE::ArrayDesign::Zone β€” and ngl, it's giving ✨structured array geometry✨ energy.


🌸 NAME 🌸

Bio::MAGE::ArrayDesign::Zone β€” a class for the MAGE-OM API. That's it, that's the whole name section, periodt.


πŸŽ€ SYNOPSIS πŸŽ€

Here's the whole vibe of how you actually use this thing:

use Bio::MAGE::ArrayDesign::Zone

# creating an empty instance
my $zone = Bio::MAGE::ArrayDesign::Zone->new();

# creating an instance with existing data
my $zone = Bio::MAGE::ArrayDesign::Zone->new(
      lowerRightY=>$lowerrighty_val,
      lowerRightX=>$lowerrightx_val,
      upperLeftX=>$upperleftx_val,
      name=>$name_val,
      upperLeftY=>$upperlefty_val,
      identifier=>$identifier_val,
      row=>$row_val,
      column=>$column_val,
      auditTrail=>\@audit_list,
      propertySets=>\@namevaluetype_list,
      distanceUnit=>$distanceunit_ref,
      descriptions=>\@description_list,
      security=>$security_ref,
);

# 'lowerRightY' attribute
my $lowerRightY_val = $zone->lowerRightY(); # getter
$zone->lowerRightY($value); # setter

# 'lowerRightX' attribute
my $lowerRightX_val = $zone->lowerRightX(); # getter
$zone->lowerRightX($value); # setter

# 'upperLeftX' attribute
my $upperLeftX_val = $zone->upperLeftX(); # getter
$zone->upperLeftX($value); # setter

# 'name' attribute
my $name_val = $zone->name(); # getter
$zone->name($value); # setter

# 'upperLeftY' attribute
my $upperLeftY_val = $zone->upperLeftY(); # getter
$zone->upperLeftY($value); # setter

# 'identifier' attribute
my $identifier_val = $zone->identifier(); # getter
$zone->identifier($value); # setter

# 'row' attribute
my $row_val = $zone->row(); # getter
$zone->row($value); # setter

# 'column' attribute
my $column_val = $zone->column(); # getter
$zone->column($value); # setter

# 'auditTrail' association
my $audit_array_ref = $zone->auditTrail(); # getter
$zone->auditTrail(\@audit_list); # setter

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

# 'distanceUnit' association
my $distanceunit_ref = $zone->distanceUnit(); # getter
$zone->distanceUnit($distanceunit_ref); # setter

# 'descriptions' association
my $description_array_ref = $zone->descriptions(); # getter
$zone->descriptions(\@description_list); # setter

# 'security' association
my $security_ref = $zone->security(); # getter
$zone->security($security_ref); # setter

see how every attribute gets a getter AND a setter? iconic behaviour tbh πŸ’…


✨ DESCRIPTION ✨

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

Specifies the location of a zone on an array.

fr fr that's the whole personality. it tells you WHERE a zone sits on an array. main character of spatial data 🌸


🧚 INHERITANCE 🧚

Bio::MAGE::ArrayDesign::Zone has the following superclasses:

  • Bio::MAGE::Identifiable

so yeah, it inherits from Bio::MAGE::Identifiable β€” the family tree is giving very linear, but okay bestie we move 🌈


πŸ‘‘ CLASS METHODS πŸ‘‘

The following methods can all be called without first having an instance of the class, via the Bio::MAGE::ArrayDesign::Zone->methodname() syntax. class methods, no object required, we love a low-stakes entry point ✨

🌟 new()

🌟 new(%args)

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

  • lowerRightY β€” Sets the value of the "lowerRightY" attribute
  • lowerRightX β€” Sets the value of the "lowerRightX" attribute
  • upperLeftX β€” Sets the value of the "upperLeftX" attribute
  • name β€” Sets the value of the "name" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • upperLeftY β€” Sets the value of the "upperLeftY" attribute
  • identifier β€” Sets the value of the "identifier" attribute (this attribute was inherited from class "Bio::MAGE::Identifiable").
  • row β€” Sets the value of the "row" attribute
  • column β€” Sets the value of the "column" attribute
  • auditTrail β€” Sets the value of the "auditTrail" association (this association was inherited from class "Bio::MAGE::Describable").

The value must be of type: array of "Bio::MAGE::AuditAndSecurity::Audit".

  • 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".

  • descriptions β€” Sets the value of the "descriptions" association (this association was inherited from class "Bio::MAGE::Describable").

The value must be of type: array of "Bio::MAGE::Description::Description".

  • distanceUnit β€” Sets the value of the "distanceUnit" association

The value must be of type: instance of "Bio::MAGE::Measurement::DistanceUnit".

  • security β€” Sets the value of the "security" association (this association was inherited from class "Bio::MAGE::Describable").

The value must be of type: instance of "Bio::MAGE::AuditAndSecurity::Security".

🌟 $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. just slots, bestie, don't @ me
  • 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.
heads up bestie β€” use a slot name this class doesn't know about and it WILL croak() at you. rude but fair πŸ’€

πŸ“ @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. one for reading, one for writing, no multitasking, no cap ✨

"Bio::MAGE::ArrayDesign::Zone" has the following attribute accessor methods:

🌸 lowerRightY

Methods for the "lowerRightY" attribute.

From the MAGE-OM documentation:

Boundary horizontal lower right position relative to (0,0).
  • $val = $zone->setLowerRightY($val)

The restricted setter method for the "lowerRightY" attribute.

  • Input parameters: the value to which the "lowerRightY" attribute will be set
  • Return value: the current value of the "lowerRightY" attribute
  • Side effects: none
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getLowerRightY()

The restricted getter method for the "lowerRightY" attribute.

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

🌸 lowerRightX

Methods for the "lowerRightX" attribute.

From the MAGE-OM documentation:

Boundary vertical lower right position relative to (0,0).
  • $val = $zone->setLowerRightX($val)

The restricted setter method for the "lowerRightX" attribute.

  • Input parameters: the value to which the "lowerRightX" attribute will be set
  • Return value: the current value of the "lowerRightX" attribute
  • Side effects: none
  • Exceptions: will call "croak()" if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getLowerRightX()

The restricted getter method for the "lowerRightX" attribute.

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

🌸 upperLeftX

Methods for the "upperLeftX" attribute.

From the MAGE-OM documentation:

Boundary vertical upper left position relative to (0,0).
  • $val = $zone->setUpperLeftX($val)

The restricted setter method for the "upperLeftX" attribute.

...and that's where part 1 runs out, bestie β€” there's more coming 🫢

  • Input parameters: the value to which the upperLeftX attribute will be set
    • Return value: the current value of the upperLeftX attribute
    • Side effects: none, bestie
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified 🫠
  • $val = $zone->getUpperLeftX() β€” the restricted getter for the upperLeftX attribute.
    • Input parameters: none
    • Return value: the current value of the upperLeftX attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified πŸ’€

name

Methods for the name attribute. From the MAGE-OM documentation:

The potentially ambiguous common identifier.
  • $val = $zone->setName($val) β€” the restricted setter for the name attribute.
    • Input parameters: the value to which the name attribute will be set
    • Return value: the current value of the name attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getName() β€” the restricted getter for the name attribute.
    • Input parameters: none
    • Return value: the current value of the name attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified ✨

upperLeftY

Methods for the upperLeftY attribute. From the MAGE-OM documentation:

Boundary horizontal upper left position relative to (0,0).
  • $val = $zone->setUpperLeftY($val) β€” the restricted setter for the upperLeftY attribute.
    • Input parameters: the value to which the upperLeftY attribute will be set
    • Return value: the current value of the upperLeftY attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getUpperLeftY() β€” the restricted getter for the upperLeftY attribute.
    • Input parameters: none
    • Return value: the current value of the upperLeftY attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified πŸ¦‹

identifier

Methods for the identifier attribute. From the MAGE-OM documentation:

An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of related documents, or a repository) of its use.
  • $val = $zone->setIdentifier($val) β€” the restricted setter for the identifier attribute.
    • Input parameters: the value to which the identifier attribute will be set
    • Return value: the current value of the identifier attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getIdentifier() β€” the restricted getter for the identifier attribute.
    • Input parameters: none
    • Return value: the current value of the identifier attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified πŸ‘‘

row

Methods for the row attribute. From the MAGE-OM documentation:

row position in the ZoneGroup
  • $val = $zone->setRow($val) β€” the restricted setter for the row attribute.
    • Input parameters: the value to which the row attribute will be set
    • Return value: the current value of the row attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getRow() β€” the restricted getter for the row attribute.
    • Input parameters: none
    • Return value: the current value of the row attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified 🌈

column

Methods for the column attribute. From the MAGE-OM documentation:

column position in the ZoneGroup.
  • $val = $zone->setColumn($val) β€” the restricted setter for the column attribute.
    • Input parameters: the value to which the column attribute will be set
    • Return value: the current value of the column attribute
    • Side effects: none
    • Exceptions: will call croak() if no input parameters are specified, or if too many input parameters are specified
  • $val = $zone->getColumn() β€” the restricted getter for the column attribute.
    • Input parameters: none
    • Return value: the current value of the column attribute
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified πŸ’–

πŸ”— ASSOCIATIONS πŸ”—

Associations are references to other classes. And in MAGE-OM, every association has a cardinality β€” that's just the glow-up word for how many of the 'other' class can be in there, minimum to maximum. The options are:

  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::ArrayDesign::Zone has the following association accessor methods, and they are giving:


auditTrail

Methods for the auditTrail association. From the MAGE-OM documentation:

A list of Audit instances that track changes to the instance of Describable.
  • $array_ref = $zone->setAuditTrail($array_ref) β€” the restricted setter for the auditTrail association.
    • Input parameters: the value to which the auditTrail association will be set : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • 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::AuditAndSecurity::Audit instances 😭
  • $array_ref = $zone->getAuditTrail() β€” the restricted getter for the auditTrail association.
    • Input parameters: none
    • Return value: the current value of the auditTrail association : a reference to an array of objects of type Bio::MAGE::AuditAndSecurity::Audit
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $zone->addAuditTrail(@vals) β€” because the auditTrail association has list cardinality, it may store more than one value. This method adds the current list of objects in the auditTrail association.
    • Input parameters: the list of values @vals to add to the auditTrail 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::AuditAndSecurity::Audit πŸ’€

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 = $zone->setPropertySets($array_ref) β€” the restricted setter 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 = $zone->getPropertySets() β€” the restricted getter 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 = $zone->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 🫢

descriptions

Methods for the descriptions association. From the MAGE-OM documentation:

Free hand text descriptions. Makes available the associations of Description to an instance of Describable.
  • $array_ref = $zone->setDescriptions($array_ref) β€” the restricted setter for the descriptions association.

Input parameters: the value you're setting the descriptions association to β€” a reference to an array of objects of type Bio::MAGE::Description::Description πŸ’–

Return value: whatever the descriptions association is holding right now β€” a reference to an array of Bio::MAGE::Description::Description objects 🌸

Side effects: none, we're chill

Exceptions: it will hit you with croak() if you pass no input parameters, or too many input parameters, or if $array_ref isn't a reference to an array of Bio::MAGE::Description::Description instances. Like, it will literally yell at you πŸ™ˆ

  • $array_ref = $zone->getDescriptions() β€” the restricted getter method for the descriptions association.

Input parameters: none, bestie, it just reads

Return value: the current value of the descriptions association β€” a reference to an array of Bio::MAGE::Description::Description objects ✨

Side effects: none

Exceptions: will call croak() if any input parameters are specified 😭 it wants nothing from you

  • $val = $zone->addDescriptions(@vals) β€” okay so because the descriptions association has list cardinality, it can store more than one value, and this method adds the current list of objects in the descriptions association. Queen behavior honestly πŸ‘‘

Input parameters: the list of values @vals to add to the descriptions 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::Description::Description πŸ’€


🌈 distanceUnit 🌈

Methods for the distanceUnit association, slay.

From the MAGE-OM documentation:

Unit for the Zone attributes.
  • $val = $zone->setDistanceUnit($val) β€” the restricted setter method for the distanceUnit association.

Input parameters: the value to which the distanceUnit association will be set β€” one of the accepted enumerated values

Return value: the current value of the distanceUnit 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::DistanceUnit 😀

  • $val = $zone->getDistanceUnit() β€” the restricted getter method for the distanceUnit association.

Input parameters: none

Return value: the current value of the distanceUnit association β€” an instance of type Bio::MAGE::Measurement::DistanceUnit πŸ’…

Side effects: none

Exceptions: will call croak() if any input parameters are specified


πŸ” security πŸ”

Methods for the security association. Protecting the vibe, fr fr.

From the MAGE-OM documentation:

Information on the security for the instance of the class.
  • $val = $zone->setSecurity($val) β€” the restricted setter method for the security association.

Input parameters: the value to which the security association will be set β€” one of the accepted enumerated values

Return value: the current value of the security 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::AuditAndSecurity::Security ⚠️

  • $val = $zone->getSecurity() β€” the restricted getter method for the security association.

Input parameters: none

Return value: the current value of the security association β€” an instance of type Bio::MAGE::AuditAndSecurity::Security πŸ›‘οΈ

Side effects: none

Exceptions: will call croak() if any input parameters are specified

And then there's this little guy just vibing in the middle of it all:

sub initialize {

  my $self = shift;
  return 1;

}

✨ 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. Three. Not two. Not four. Three, and you're gonna learn all of them πŸŽ€

🧚 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 β€” so like, use only if you understand the inner workings of the API, bestie. Don't go poking around in there unless you know what you're doing πŸ™ˆ 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, and 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. None. Zero. It simply does not care πŸ’€

πŸ¦‹ 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. Like, genuinely, use 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 β€” yes, go look, it's all there πŸ‘€


πŸ› 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 β€” not me being messy, the document being messy, okay?? 😭

  • Around line 403:

'=item' outside of any '=over'

  • Around line 488:

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

  • Around line 1092:

Expected '=item 2'

  • Around line 1097:

Expected '=item 3'

  • Around line 1102:

Expected '=item 4'


And that's a wrap on MAGE::...n::Zone(3pm), bestie!! πŸŽ€ This whole thing is perl v5.32.0 energy, dated 2020-11-27 β€” an absolute vintage moment, and yes we love her for it. Go forth, set your zones, croak() responsibly, and remember: the restricted getters want no input parameters. Periodt. πŸ’…βœ¨πŸ¦‹