use Bio::MAGE::BioMaterial::CompoundMeasurement;
# creating an empty instance my $compoundmeasurement = Bio::MAGE::BioMaterial::CompoundMeasurement->new();
# creating an already populated instance my $compoundmeasurement = Bio::MAGE::BioMaterial::CompoundMeasurement->new(measurement=>$measurement_value, compound=>$compound_value);
# setting and retrieving object associations my $measurement_val = $compoundmeasurement->measurement(); $compoundmeasurement->measurement($value);
my $compound_val = $compoundmeasurement->compound(); $compoundmeasurement->compound($value);
From the MAGE-OM documentation for the CompoundMeasurement
class:
A CompoundMeasurement is a pairing of a source Compound and an amount (Measurement) of that Compound.
Bio::MAGE::BioMaterial::CompoundMeasurement has the following super classes
The following methods can all be called without first having an
instance of the class via the Bio::MAGE::BioMaterial::CompoundMeasurement->methodname()
syntax.
new()
new(%args)
new()
accepts the following optional
named-value style arguments:
Bio::MAGE::BioMaterial::CompoundMeasurement
).
Bio::MAGE::BioMaterial::CompoundMeasurement
).
Bio::MAGE::Extendable
).
set_slots(%parameters)
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.
get_slots(@name_list)
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
set_slot($name,$val)
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
get_slot($name)
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
get_slot_names()
get_slot_names()
method is used to retrieve the name of all
slots defined for a given object.
Return value: a single slot value, or undef if the slot has not been initialized.
Side effects: none
class_name()
package()
subclasses()
superclasses()
attribute_methods()
association_methods()
associations()
Bio::MAGE::Association
objects that provide the meta-information for the association.
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::BioMaterial::CompoundMeasurement: has the following attribute accessor methods:
Associations are references to other class objects which can be shared by multiple class instances at the same time. In the Perl implementation of MAGE-OM classes, associations are implemented using three separate methods:
Bio::MAGE::BioMaterial::CompoundMeasurement: has the following association accessor methods:
measurement
association:
The amount of the Compound.
setMeasurement($val)
Input parameters: the value to which the measurement association will be set : an instance of type Bio::MAGE::Measurement::Measurement
.
Return value: the current value of the measurement association : an instance of type Bio::MAGE::Measurement::Measurement
.
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::Measurement
getMeasurement()
Input parameters: none
Return value: the current value of the measurement association : an instance of type Bio::MAGE::Measurement::Measurement
.
Side effects: none
Exceptions: will call croak()
if any input parameters are specified
compound
association:
A Compound to be used to create another Compound.
setCompound($val)
Input parameters: the value to which the compound association will be set : an instance of type Bio::MAGE::BioMaterial::Compound
.
Return value: the current value of the compound association : an instance of type Bio::MAGE::BioMaterial::Compound
.
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::BioMaterial::Compound
getCompound()
Input parameters: none
Return value: the current value of the compound association : an instance of type Bio::MAGE::BioMaterial::Compound
.
Side effects: none
Exceptions: will call croak()
if any input parameters are specified
Associations Inherited from Bio::MAGE::Extendable
propertySets
association:
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.
setPropertySets($array_ref)
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
getPropertySets()
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
addPropertySets(@vals)
Input parameters: the list of values @vals
to add to the propertySets
association. NOTE: submitting a single value is permitted.
Return value: none
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
Please send bug reports to mged-mage@lists.sf.net
Jason E. Stewart (www.openinformatics.com)
perl(1).