Detailed Description

A simple class defining a commodity; it is currently super simple.

The reason this class exists is so that code may be cleaner and more straightforward while one could have chosen to typedef a string, there may be some reason to extend the class in the future.

Definition at line 12 of file commodity.h.

#include <commodity.h>

Public Member Functions
	Commodity ()

	Commodity (std::string name)

std::string	name () const

bool	operator!= (const Commodity &other) const

bool	operator== (const Commodity &other) const

Constructor & Destructor Documentation

◆ Commodity() [1/2]

cyclus::toolkit::Commodity::Commodity ( )

Default constructor.

Definition at line 7 of file commodity.cc.

◆ Commodity() [2/2]

cyclus::toolkit::Commodity::Commodity ( std::string name )

Constructor.

Parameters

name	the name of the commodity

Definition at line 10 of file commodity.cc.

Member Function Documentation

◆ name()

std::string cyclus::toolkit::Commodity::name ( ) const

The commodity's name.

Definition at line 13 of file commodity.cc.

◆ operator!=()

bool cyclus::toolkit::Commodity::operator!= ( const Commodity & other ) const

Inequality operator.

Definition at line 23 of file commodity.cc.

◆ operator==()

bool cyclus::toolkit::Commodity::operator== ( const Commodity & other ) const

Equality operator.

Definition at line 18 of file commodity.cc.

The documentation for this class was generated from the following files: