MAGE::...::Ratio(3pm)

โœจ MAGE::...::Ratio โœจ

aka Bio::MAGE::QuantitationType::Ratio โ€” the class for the MAGE-OM API, bestie ๐Ÿ’– (this is the 3pm manual page, so like, Perl module documentation, iykyk)


NAME ๐ŸŽ€

Bio::MAGE::QuantitationType::Ratio โ€” it's the class for the MAGE-OM API, no cap ๐Ÿ’…


SYNOPSIS โœจ

okay so here's the whole vibe, copy-paste ready:

  use Bio::MAGE::QuantitationType::Ratio

  # creating an empty instance
  my $ratio = Bio::MAGE::QuantitationType::Ratio->new();

  # creating an instance with existing data
  my $ratio = Bio::MAGE::QuantitationType::Ratio->new(
        name=>$name_val,
        isBackground=>$isbackground_val,
        identifier=>$identifier_val,
        dataType=>$ontologyentry_ref,
        auditTrail=>\@audit_list,
        channel=>$channel_ref,
        propertySets=>\@namevaluetype_list,
        confidenceIndicators=>\@confidenceindicator_list,
        descriptions=>\@description_list,
        scale=>$ontologyentry_ref,
        security=>$security_ref,
        quantitationTypeMaps=>\@quantitationtypemap_list,
  );

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

  # 'isBackground' attribute
  my $isBackground_val = $ratio->isBackground(); # getter
  $ratio->isBackground($value); # setter

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

  # 'dataType' association
  my $ontologyentry_ref = $ratio->dataType(); # getter
  $ratio->dataType($ontologyentry_ref); # setter

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

  # 'channel' association
  my $channel_ref = $ratio->channel(); # getter
  $ratio->channel($channel_ref); # setter

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

  # 'confidenceIndicators' association
  my $confidenceindicator_array_ref = $ratio->confidenceIndicators(); # getter
  $ratio->confidenceIndicators(\@confidenceindicator_list); # setter

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

  # 'scale' association
  my $ontologyentry_ref = $ratio->scale(); # getter
  $ratio->scale($ontologyentry_ref); # setter

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

  # 'quantitationTypeMaps' association
  my $quantitationtypemap_array_ref = $ratio->quantitationTypeMaps(); # getter
  $ratio->quantitationTypeMaps(\@quantitationtypemap_list); # setter

like, so many methods, so many vibes ๐Ÿฆ‹


DESCRIPTION ๐ŸŒธ

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

The ratio of two or more signals, typically between two channels. Of type float.

periodt. it's a ratio, it's floaty, it's giving math ๐Ÿงฎโœจ


INHERITANCE ๐Ÿ’œ

Bio::MAGE::QuantitationType::Ratio has the following superclasses (yes, it has ancestors, it's got lore ๐Ÿ‘‘):

  • Bio::MAGE::QuantitationType::StandardQuantitationType

CLASS METHODS ๐Ÿ”ฅ

all of these can be called without having an instance first โ€” just hit them with the Bio::MAGE::QuantitationType::Ratio->methodname() syntax, bestie ๐Ÿ’…

new()

new(%args)

the object constructor new() accepts these optional named-value style arguments (aka the little menu of things you can pass in ๐Ÿ“):

  • name โ€” sets the value of the name attribute (this attribute was inherited from class Bio::MAGE::Identifiable).
  • isBackground โ€” sets the value of the isBackground attribute (this attribute was inherited from class Bio::MAGE::QuantitationType::QuantitationType).
  • identifier โ€” sets the value of the identifier attribute (this attribute was inherited from class Bio::MAGE::Identifiable).
  • dataType โ€” sets the value of the dataType association (this association was inherited from class Bio::MAGE::QuantitationType::QuantitationType). The value must be of type: instance of Bio::MAGE::Description::OntologyEntry.
  • 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.
  • channel โ€” sets the value of the channel association (this association was inherited from class Bio::MAGE::QuantitationType::QuantitationType). The value must be of type: instance of Bio::MAGE::BioAssay::Channel.
  • confidenceIndicators โ€” sets the value of the confidenceIndicators association (this association was inherited from class Bio::MAGE::QuantitationType::QuantitationType). The value must be of type: array of Bio::MAGE::QuantitationType::ConfidenceIndicator.
  • 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.
  • 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.
  • scale โ€” sets the value of the scale association (this association was inherited from class Bio::MAGE::QuantitationType::QuantitationType). The value must be of type: instance of Bio::MAGE::Description::OntologyEntry.
  • quantitationTypeMaps โ€” sets the value of the quantitationTypeMaps association (this association was inherited from class Bio::MAGE::QuantitationType::QuantitationType). The value must be of type: array of Bio::MAGE::BioAssayData::QuantitationTypeMap.

$obj = class->new(%parameters) ๐Ÿซถ

the new() method is the class constructor, the main character of object creation fr fr.

  • Parameters: if you hand it a list of name/value parameters, the corresponding slots, attributes, or associations get 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's defined by the class.

@names = class->get_slot_names() ๐ŸŒˆ

get_slot_names() grabs the name of every slot defined in a given class.

NOTE: the list of names does not include attribute or association names. sneaky, I know ๐Ÿ’€
  • 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. slay.


@name_list = get_association_names() ๐Ÿฆ‹

returns the list of association data members for this class. also slay.


@class_list = get_superclasses() ๐Ÿ‘‘

returns the list of superclasses for this class. know your ancestors bestie ๐Ÿ’œ


@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 this with an existing object reference and not a class name, new() acts as a copy constructor โ€” the new object's initial values get set to be those of the existing object. it's giving clone energy ๐Ÿซถ

  • 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's defined by the class.

$obj->set_slots(%parameters)

$obj->set_slots(\@name_list, \@value_list) โœจ

set_slots() sets a bunch of slots at the same time. it has two different invocation methods, pick your fighter:

  1. takes a named parameter list
  2. takes two array references
  • Return value: none
  • Side effects: will call croak() if a slot_name is used that the class does not define. rude but fair.

@obj_list = $obj->get_slots(@name_list) ๐Ÿ“

get_slots() gets the values of a bunch of slots at the same time.

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

$val = $obj->set_slot($name,$val) ๐Ÿ’œ

set_slot() 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) ๐ŸŽ€

get_slot() 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. separate methods, because we're organized like that ๐Ÿ’…

Bio::MAGE::QuantitationType::Ratio has the following attribute accessor methods:

name โญ

Methods for the name attribute.

From the MAGE-OM documentation:

The potentially ambiguous common identifier.

$val = $ratio->setName($val)

The restricted setter method 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 = $ratio->getName()

The restricted getter method 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

isBackground ๐Ÿฆ‹

Methods for the isBackground attribute.

From the MAGE-OM documentation:

Indicates whether the quantitation has been measured from the background or from the feature itself. ๐Ÿ’…

$val = $ratio->setIsBackground($val)

The restricted setter method for the "isBackground" attribute.

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

$val = $ratio->getIsBackground()

The restricted getter method for the "isBackground" attribute.

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

๐Ÿ†” identifier ๐Ÿ†”

Methods for the "identifier" attribute.

Straight from the MAGE-OM documentation, bestie:

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 = $ratio->setIdentifier($val)

The restricted setter method 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 = $ratio->getIdentifier()

The restricted getter method 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

๐Ÿ”— ASSOCIATIONS ๐Ÿ”—

Okay so associations are references to other classes, periodt. And every association in MAGE-OM has a cardinality โ€” that's just the rule for the minimum and maximum number of instances of the other class that maybe included in the association. Let's break it down, no cap:

  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::QuantitationType::Ratio has the following association accessor methods: ๐Ÿ‘‘

๐Ÿ”ข dataType ๐Ÿ”ข

Methods for the "dataType" association.

MAGE-OM documentation says, and I quote:

The specific type for the quantitations. From a controlled vocabulary of {float, int, boolean, etc.}

$val = $ratio->setDataType($val)

The restricted setter method for the "dataType" association.

  • Input parameters: the value to which the "dataType" association will be set : one of the accepted enumerated values.
  • Return value: the current value of the "dataType" 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::Description::OntologyEntry

$val = $ratio->getDataType()

The restricted getter method for the "dataType" association.

  • Input parameters: none
  • Return value: the current value of the "dataType" association : an instance of type Bio::MAGE::Description::OntologyEntry.
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

๐Ÿ“œ auditTrail ๐Ÿ“œ

Methods for the "auditTrail" association.

MAGE-OM documentation, verbatim:

A list of Audit instances that track changes to the instance of Describable.

$array_ref = $ratio->setAuditTrail($array_ref)

The restricted setter method 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 = $ratio->getAuditTrail()

The restricted getter method 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 = $ratio->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.

MAGE-OM documentation, word for word:

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 = $ratio->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 = $ratio->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 = $ratio->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

๐ŸŒŠ channel ๐ŸŒŠ

Methods for the "channel" association.

MAGE-OM documentation, and it's giving short and sweet:

The optional channel associated with the QuantitationType.

$val = $ratio->setChannel($val)

The restricted setter method for the "channel" association.

  • Input parameters: the value to which the "channel" association will be set : one of the accepted enumerated values.
  • Return value: the current value of the "channel" 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::BioAssay::Channel

$val = $ratio->getChannel()

The restricted getter method for the "channel" association.

  • Input parameters: none
  • Return value: the current value of the "channel" association : an instance of type Bio::MAGE::BioAssay::Channel.
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified

โœจ confidenceIndicators โœจ

Methods for the "confidenceIndicators" association.

MAGE-OM documentation, copy that:

The association between a ConfidenceIndicator and the QuantitationType its is an indicator for.

$array_ref = $ratio->setConfidenceIndicators($array_ref)

The restricted setter method for the "confidenceIndicators" association.

  • Input parameters: the value to which the "confidenceIndicators" association will be set : a reference to an array of objects of type Bio::MAGE::QuantitationType::ConfidenceIndicator
  • Return value: the current value of the "confidenceIndicators" association : a reference to an array of objects of type Bio::MAGE::QuantitationType::ConfidenceIndicator
  • 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::QuantitationType::ConfidenceIndicator instances

$array_ref = $ratio->getConfidenceIndicators()

The restricted getter method for the "confidenceIndicators" association.

  • Input parameters: none
  • Return value: the current value of the confidenceIndicators association : a reference to an array of objects of type Bio::MAGE::QuantitationType::ConfidenceIndicator
    • Side effects: none
    • Exceptions: will call croak() if any input parameters are specified
  • $val = $ratio->addConfidenceIndicators(@vals)

bestie the confidenceIndicators association has list cardinality, which is the fancy way of saying it can hold more than one thing ๐Ÿ’… so this method adds the current list of objects sitting in the confidenceIndicators association.

  • Input parameters: the list of values @vals to add to the confidenceIndicators 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::QuantitationType::ConfidenceIndicator

๐ŸŽ€ 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 = $ratio->setDescriptions($array_ref)

The restricted setter method for the descriptions association.

  • Input parameters: the value to which the descriptions association will be set : a reference to an array of objects of type Bio::MAGE::Description::Description
  • Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description
  • 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::Description::Description instances
  • $array_ref = $ratio->getDescriptions()

The restricted getter method for the descriptions association. no thoughts, just vibes, just grabbing the value ๐Ÿซถ

  • Input parameters: none
  • Return value: the current value of the descriptions association : a reference to an array of objects of type Bio::MAGE::Description::Description
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified
  • $val = $ratio->addDescriptions(@vals)

Because the descriptions association has list cardinality, it may store more than one value. This method adds the current list of objects in the descriptions association. it's giving collector energy โœจ

  • 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

๐Ÿ”’ security ๐Ÿ”’

Methods for the security association.

From the MAGE-OM documentation: Information on the security for the instance of the class.
  • $val = $ratio->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 = $ratio->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

๐Ÿ“ scale ๐Ÿ“

Methods for the scale association.

From the MAGE-OM documentation: Indication of how to interpret the value. From a suggested vocabulary of {LINEAR | LN | LOG2 |LOG10 | FOLD_CHANGE | OTHER}
  • $val = $ratio->setScale($val)

The restricted setter method for the scale association.

  • Input parameters: the value to which the scale association will be set : one of the accepted enumerated values.
  • Return value: the current value of the scale 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::Description::OntologyEntry
  • $val = $ratio->getScale()

The restricted getter method for the scale association.

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

๐ŸŒˆ quantitationTypeMaps ๐ŸŒˆ

Methods for the quantitationTypeMaps association.

From the MAGE-OM documentation: The QuantitationType whose value will be produced from the values of the source QuantitationType according to the Protocol.
  • $array_ref = $ratio->setQuantitationTypeMaps($array_ref)

The restricted setter method for the quantitationTypeMaps association.

  • Input parameters: the value to which the quantitationTypeMaps association will be set : a reference to an array of objects of type Bio::MAGE::BioAssayData::QuantitationTypeMap
  • Return value: the current value of the quantitationTypeMaps association : a reference to an array of objects of type Bio::MAGE::BioAssayData::QuantitationTypeMap
  • 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::BioAssayData::QuantitationTypeMap instances
  • $array_ref = $ratio->getQuantitationTypeMaps()

The restricted getter method for the quantitationTypeMaps association.

  • Input parameters: none
  • Return value: the current value of the quantitationTypeMaps association : a reference to an array of objects of type Bio::MAGE::BioAssayData::QuantitationTypeMap
  • Side effects: none
  • Exceptions: will call croak() if any input parameters are specified
  • $val = $ratio->addQuantitationTypeMaps(@vals)

Because the quantitationTypeMaps association has list cardinality, it may store more than one value. This method adds the current list of objects in the quantitationTypeMaps association. stacking them like a true main character ๐Ÿ‘‘

  • Input parameters: the list of values @vals to add to the quantitationTypeMaps 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::BioAssayData::QuantitationTypeMap

and then there's this lil guy sitting at the very end, no cap:

sub initialize {

  my $self = shift;
  return 1;

}

๐ŸŒธ SLOTS, ATTRIBUTES, AND ASSOCIATIONS ๐ŸŒธ

Okay bestie, so in the Perl implementation of MAGE-OM classes, there are three types of class data members, and they are: "slots", "attributes", and "associations".


๐Ÿงš SLOTS ๐Ÿงš

This API uses the term "slot" to mean a data member of the class that was not present in the UML model, and it's used mainly for internal purposes โ€” so lowkey only touch it if you truly understand the inner workings of the API. Most often slots are 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(); โ€” 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.
  • @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" mean 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 390: '=item' outside of any '=over'
  • Around line 475: You forgot a '=back' before '=head2'
  • Around line 719: Expected '=item 2'
  • Around line 724: Expected '=item 3'
  • Around line 729: Expected '=item 4'

And that's the whole page, bestie ๐Ÿ’– This was perl v5.32.0, dated 2020-11-27, for MAGE::...::Ratio(3pm) โœจ๐Ÿซถ

๐Ÿ“ฆ where this page comes from