Struct moore_vhdl::ty2::PhysicalUnit

pub struct PhysicalUnit {
    pub name: Name,
    pub abs: BigInt,
    pub rel: Option<(BigInt, usize)>,
}

A unit of a physical type.

Fields

name: Name

The name of the unit.

abs: BigInt

The scale of the unit with respect to the physical type's primary unit.

rel: Option<(BigInt, usize)>

The scale of the unit with respect to another unit.

Implementations

impl PhysicalUnit

pub fn new<A, R>(name: Name, abs: A, rel: Option<(R, usize)>) -> PhysicalUnit where
    BigInt: From<A> + From<R>, 

Create a new unit.

Example

use moore_vhdl::ty2::{PhysicalUnit, BigInt};
use moore_common::name::get_name_table;

let name = get_name_table().intern("fs", false);
let unit = PhysicalUnit::new(name, 1, Some((1000, 0)));

assert_eq!(unit.name, name);
assert_eq!(unit.abs, BigInt::from(1));
assert_eq!(unit.rel, Some((BigInt::from(1000), 0)));

pub fn primary<A>(name: Name, abs: A) -> PhysicalUnit where
    BigInt: From<A>, 

Create a new primary unit.

Example

use moore_vhdl::ty2::{PhysicalUnit, BigInt};
use moore_common::name::get_name_table;

let name = get_name_table().intern("fs", false);
let unit = PhysicalUnit::primary(name, 1);

assert_eq!(unit.name, name);
assert_eq!(unit.abs, BigInt::from(1));
assert_eq!(unit.rel, None);

pub fn secondary<A, R>(
    name: Name,
    abs: A,
    rel: R,
    rel_to: usize
) -> PhysicalUnit where
    BigInt: From<A> + From<R>, 

Create a new secondary unit.

Example

use moore_vhdl::ty2::{PhysicalUnit, BigInt};
use moore_common::name::get_name_table;

let name = get_name_table().intern("fs", false);
let unit = PhysicalUnit::secondary(name, 1, 1000, 0);

assert_eq!(unit.name, name);
assert_eq!(unit.abs, BigInt::from(1));
assert_eq!(unit.rel, Some((BigInt::from(1000), 0)));

Trait Implementations

impl Clone for PhysicalUnit

fn clone(&self) -> PhysicalUnit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PhysicalUnit

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for PhysicalUnit

impl PartialEq<PhysicalUnit> for PhysicalUnit

fn eq(&self, other: &PhysicalUnit) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PhysicalUnit) -> bool

This method tests for !=.

impl StructuralEq for PhysicalUnit

impl StructuralPartialEq for PhysicalUnit