AMCAX Kernel 1.0.0.0
AMCAX::STEP::MeasureRepItem Class Reference

Class for representing a descriptive representation item. More...

#include <step/repitem/MeasureRepItem.hpp>

Inheritance diagram for AMCAX::STEP::MeasureRepItem:
Collaboration diagram for AMCAX::STEP::MeasureRepItem:

Public Member Functions

AMCAX_API MeasureRepItem ()
 Default constructor.
 
AMCAX_API MeasureRepItem (const std::string &name, const double &value, const SIUnit &unit)
 Constructor. More...
 
AMCAX_API MeasureRepItem (const MeasureRepItem &other)
 Copy constructor. More...
 
AMCAX_API MeasureRepItem (MeasureRepItem &&other) noexcept
 Move constructor. More...
 
AMCAX_API MeasureRepItemoperator= (const MeasureRepItem &other)
 Copy assignment operator. More...
 
AMCAX_API MeasureRepItemoperator= (MeasureRepItem &&other) noexcept
 Move assignment operator. More...
 
AMCAX_API ~MeasureRepItem () override
 Destructor.
 
AMCAX_API MeasureRepItemSetName (const std::string &name)
 Set the name of the descriptive representation item. More...
 
AMCAX_API const double & GetValue () const
 Get an immutable reference to the value of the measure. More...
 
AMCAX_API MeasureRepItemSetValue (const double &value)
 Set the value of the measure representation item. More...
 
AMCAX_API const SIUnitGetUnit () const
 Get an immutable reference to the unit of the measure. More...
 
AMCAX_API SIUnitUnit ()
 Get an mutable reference to the unit of the measure. More...
 
AMCAX_API MeasureRepItemSetUnit (const SIUnit &unit)
 Set the unit of the measure representation item. More...
 
AMCAX_API bool operator== (const MeasureRepItem &other) const
 If the MeasureRepItem same as the other MeasureRepItem. More...
 
AMCAX_API bool operator!= (const MeasureRepItem &other) const
 If the MeasureRepItem different from the other MeasureRepItem. More...
 
AMCAX_API bool operator< (const MeasureRepItem &other) const
 If the MeasureRepItem less than the other MeasureRepItem. More...
 
AMCAX_API bool operator> (const MeasureRepItem &other) const
 If the MeasureRepItem greater than the other MeasureRepItem. More...
 
AMCAX_API bool operator<= (const MeasureRepItem &other) const
 If the MeasureRepItem less than or equal to the other MeasureRepItem. More...
 
AMCAX_API bool operator>= (const MeasureRepItem &other) const
 If the MeasureRepItem greater than or equal to the other MeasureRepItem. More...
 
- Public Member Functions inherited from AMCAX::STEP::AbstractRepItem
AMCAX_API const std::string & GetName () const
 Get an immutable reference to the name of the representation item. More...
 

Detailed Description

Class for representing a descriptive representation item.

Constructor & Destructor Documentation

◆ MeasureRepItem() [1/3]

AMCAX_API AMCAX::STEP::MeasureRepItem::MeasureRepItem ( const std::string &  name,
const double &  value,
const SIUnit unit 
)

Constructor.

Parameters
nameThe name of the descriptive representation item
valueThe value of the measure
unitThe unit of the measure

◆ MeasureRepItem() [2/3]

AMCAX_API AMCAX::STEP::MeasureRepItem::MeasureRepItem ( const MeasureRepItem other)

Copy constructor.

Parameters
otherThe other MeasureRepItem to copy from

◆ MeasureRepItem() [3/3]

AMCAX_API AMCAX::STEP::MeasureRepItem::MeasureRepItem ( MeasureRepItem &&  other)
noexcept

Move constructor.

Parameters
otherThe other MeasureRepItem to move from

Member Function Documentation

◆ GetUnit()

AMCAX_API const SIUnit & AMCAX::STEP::MeasureRepItem::GetUnit ( ) const

Get an immutable reference to the unit of the measure.

Returns
An immutable reference to the unit of the measure

◆ GetValue()

AMCAX_API const double & AMCAX::STEP::MeasureRepItem::GetValue ( ) const

Get an immutable reference to the value of the measure.

Returns
An immutable reference to the value of the measure

◆ operator!=()

AMCAX_API bool AMCAX::STEP::MeasureRepItem::operator!= ( const MeasureRepItem other) const

If the MeasureRepItem different from the other MeasureRepItem.

Parameters
otherThe other MeasureRepItem to compare with
Returns
True if the MeasureRepItem is different from the other MeasureRepItem, false otherwise

◆ operator<()

AMCAX_API bool AMCAX::STEP::MeasureRepItem::operator< ( const MeasureRepItem other) const

If the MeasureRepItem less than the other MeasureRepItem.

Parameters
otherThe other MeasureRepItem to compare with
Returns
True if the MeasureRepItem is less than the other MeasureRepItem, false otherwise

◆ operator<=()

AMCAX_API bool AMCAX::STEP::MeasureRepItem::operator<= ( const MeasureRepItem other) const

If the MeasureRepItem less than or equal to the other MeasureRepItem.

Parameters
otherThe other MeasureRepItem to compare with
Returns
True if the MeasureRepItem is less than or equal to the other MeasureRepItem, false otherwise

◆ operator=() [1/2]

AMCAX_API MeasureRepItem & AMCAX::STEP::MeasureRepItem::operator= ( const MeasureRepItem other)

Copy assignment operator.

Parameters
otherThe other MeasureRepItem to copy from

◆ operator=() [2/2]

AMCAX_API MeasureRepItem & AMCAX::STEP::MeasureRepItem::operator= ( MeasureRepItem &&  other)
noexcept

Move assignment operator.

Parameters
otherThe other MeasureRepItem to move from

◆ operator==()

AMCAX_API bool AMCAX::STEP::MeasureRepItem::operator== ( const MeasureRepItem other) const

If the MeasureRepItem same as the other MeasureRepItem.

Parameters
otherThe other MeasureRepItem to compare with
Returns
True if the MeasureRepItem is the same as the other MeasureRepItem, false otherwise

◆ operator>()

AMCAX_API bool AMCAX::STEP::MeasureRepItem::operator> ( const MeasureRepItem other) const

If the MeasureRepItem greater than the other MeasureRepItem.

Parameters
otherThe other MeasureRepItem to compare with
Returns
True if the MeasureRepItem is greater than the other MeasureRepItem, false otherwise

◆ operator>=()

AMCAX_API bool AMCAX::STEP::MeasureRepItem::operator>= ( const MeasureRepItem other) const

If the MeasureRepItem greater than or equal to the other MeasureRepItem.

Parameters
otherThe other MeasureRepItem to compare with
Returns
True if the MeasureRepItem is greater than or equal to the other MeasureRepItem, false otherwise

◆ SetName()

AMCAX_API MeasureRepItem & AMCAX::STEP::MeasureRepItem::SetName ( const std::string &  name)

Set the name of the descriptive representation item.

Parameters
nameThe name of the descriptive representation item
Returns
The CartesianPointRepItem object

◆ SetUnit()

AMCAX_API MeasureRepItem & AMCAX::STEP::MeasureRepItem::SetUnit ( const SIUnit unit)

Set the unit of the measure representation item.

Parameters
unitThe unit of the measure
Returns
The MeasureRepItem object

◆ SetValue()

AMCAX_API MeasureRepItem & AMCAX::STEP::MeasureRepItem::SetValue ( const double &  value)

Set the value of the measure representation item.

Parameters
valueThe value of the measure
Returns
The MeasureRepItem object

◆ Unit()

AMCAX_API SIUnit & AMCAX::STEP::MeasureRepItem::Unit ( )

Get an mutable reference to the unit of the measure.

Returns
A mutable reference to the unit of the measure

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