Source of file MassTrait.php

Size: 2,364 Bytes - Last Modified: 2019-05-10T12:24:09+01:00

src/Core/MassTrait.php

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
Covered by 2 test(s):
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassValid
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassInvalid
49
Covered by 1 test(s):
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassInvalid
50
Covered by 1 test(s):
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassInvalid
515253
Covered by 1 test(s):
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassValid
54
Covered by 1 test(s):
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassValid
555657585960616263
Covered by 2 test(s):
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanSetMassValid
  • pgb_liv\php_ms\Test\Unit\IonTraitTest::testCanGetMassFromMz
646566676869707172737475767778798081828384858687888990919293
<?php
/**
 * Copyright 2018 University of Liverpool
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace pgb_liv\php_ms\Core;

/**
 * Trait for providing access to setter/getter of monoisotopic and average mass.
 *
 * @author Andrew Collins
 */
trait MassTrait
{

    /**
     *
     * @var float
     */
    private $monoisotopicMass;

    /**
     *
     * @var float
     */
    private $averageMass;

    /**
     * Sets the monoisotopic mass for this object
     *
     * @param float $mass
     *            The monoisotopic mass to set
     * @throws \InvalidArgumentException If argument 1 is not of type float
     */
    public function setMonoisotopicMass($mass)
    {
        if (! is_float($mass) && ! is_int($mass)) {
            throw new \InvalidArgumentException(
                'Argument 1 must be a float or integer value. Valued passed is of type ' . gettype($mass));
        }
        
        $this->monoisotopicMass = $mass;
    }

    /**
     * Gets the monoisotopic mass of this object
     *
     * @return float
     */
    public function getMonoisotopicMass()
    {
        return $this->monoisotopicMass;
    }

    /**
     * Sets the average mass for this object
     *
     * @param float $mass
     *            The average mass to set
     * @throws \InvalidArgumentException If argument 1 is not of type float
     */
    public function setAverageMass($mass)
    {
        if (! is_float($mass) && ! is_int($mass)) {
            throw new \InvalidArgumentException(
                'Argument 1 must be a float or integer value. Valued passed is of type ' . gettype($mass));
        }
        
        $this->averageMass = $mass;
    }

    /**
     * Gets the average mass of this object
     *
     * @return float
     */
    public function getAverageMass()
    {
        return $this->averageMass;
    }
}