AMCAX::STEP::ValueRepItem Class Reference

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

#include <step/repitem/ValueRepItem.hpp>

Inheritance diagram for AMCAX::STEP::ValueRepItem:

Collaboration diagram for AMCAX::STEP::ValueRepItem:

Public Member Functions
AMCAX_API	ValueRepItem ()
	Default constructor.
AMCAX_API	ValueRepItem (const std::string &name, const double &value)
	Constructor. More...
AMCAX_API	ValueRepItem (const ValueRepItem &other)
	Copy constructor. More...
AMCAX_API	ValueRepItem (ValueRepItem &&other) noexcept
	Move constructor. More...
AMCAX_API ValueRepItem &	operator= (const ValueRepItem &other)
	Copy assignment operator. More...
AMCAX_API ValueRepItem &	operator= (ValueRepItem &&other) noexcept
	Move assignment operator. More...
AMCAX_API	~ValueRepItem () override
	Destructor.
AMCAX_API ValueRepItem &	SetName (const std::string &name)
	Set the name of the value representation item. More...
AMCAX_API const double &	GetValue () const
	Get an immutable reference to the value. More...
AMCAX_API ValueRepItem &	SetValue (const double &value)
	Set the value of the value representation item. More...
AMCAX_API bool	operator== (const ValueRepItem &other) const
	If the ValueRepItem same as the other ValueRepItem. More...
AMCAX_API bool	operator!= (const ValueRepItem &other) const
	If the ValueRepItem different from the other ValueRepItem. More...
AMCAX_API bool	operator< (const ValueRepItem &other) const
	If the ValueRepItem less than the other ValueRepItem. More...
AMCAX_API bool	operator> (const ValueRepItem &other) const
	If the ValueRepItem greater than the other ValueRepItem. More...
AMCAX_API bool	operator<= (const ValueRepItem &other) const
	If the ValueRepItem less than or equal to the other ValueRepItem. More...
AMCAX_API bool	operator>= (const ValueRepItem &other) const
	If the ValueRepItem greater than or equal to the other ValueRepItem. 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

ValueRepItem() [1/3]

AMCAX_API AMCAX::STEP::ValueRepItem::ValueRepItem	(	const std::string &	name,
		const double &	value
	)

Constructor.

Parameters

name	The name of the descriptive representation item
value	The value of the value

ValueRepItem() [2/3]

AMCAX_API AMCAX::STEP::ValueRepItem::ValueRepItem

(

const ValueRepItem &

other

)

Copy constructor.

Parameters

other

The other ValueRepItem to copy from

ValueRepItem() [3/3]

AMCAX_API AMCAX::STEP::ValueRepItem::ValueRepItem ( ValueRepItem &&  other )

noexcept

Move constructor.

Parameters

other

The other ValueRepItem to move from

Member Function Documentation

GetValue()

AMCAX_API const double & AMCAX::STEP::ValueRepItem::GetValue

(

)

const

Get an immutable reference to the value.

Returns

An immutable reference to the value

operator!=()

AMCAX_API bool AMCAX::STEP::ValueRepItem::operator!=

(

const ValueRepItem &

other

)

const

If the ValueRepItem different from the other ValueRepItem.

Parameters

other

The other ValueRepItem to compare with

Returns

True if the ValueRepItem is different from the other ValueRepItem, false otherwise

operator<()

AMCAX_API bool AMCAX::STEP::ValueRepItem::operator<

(

const ValueRepItem &

other

)

const

If the ValueRepItem less than the other ValueRepItem.

Parameters

other

The other ValueRepItem to compare with

Returns

True if the ValueRepItem is less than the other ValueRepItem, false otherwise

operator<=()

AMCAX_API bool AMCAX::STEP::ValueRepItem::operator<=

(

const ValueRepItem &

other

)

const

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

Parameters

other

The other ValueRepItem to compare with

Returns

True if the ValueRepItem is less than or equal to the other ValueRepItem, false otherwise

operator=() [1/2]

AMCAX_API ValueRepItem & AMCAX::STEP::ValueRepItem::operator=

(

const ValueRepItem &

other

)

Copy assignment operator.

Parameters

other

The other ValueRepItem to copy from

operator=() [2/2]

AMCAX_API ValueRepItem & AMCAX::STEP::ValueRepItem::operator= ( ValueRepItem &&  other )

noexcept

Move assignment operator.

Parameters

other

The other ValueRepItem to move from

operator==()

AMCAX_API bool AMCAX::STEP::ValueRepItem::operator==

(

const ValueRepItem &

other

)

const

If the ValueRepItem same as the other ValueRepItem.

Parameters

other

The other ValueRepItem to compare with

Returns

True if the ValueRepItem is the same as the other ValueRepItem, false otherwise

operator>()

AMCAX_API bool AMCAX::STEP::ValueRepItem::operator>

(

const ValueRepItem &

other

)

const

If the ValueRepItem greater than the other ValueRepItem.

Parameters

other

The other ValueRepItem to compare with

Returns

True if the ValueRepItem is greater than the other ValueRepItem, false otherwise

operator>=()

AMCAX_API bool AMCAX::STEP::ValueRepItem::operator>=

(

const ValueRepItem &

other

)

const

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

Parameters

other

The other ValueRepItem to compare with

Returns

True if the ValueRepItem is greater than or equal to the other ValueRepItem, false otherwise

SetName()

AMCAX_API ValueRepItem & AMCAX::STEP::ValueRepItem::SetName

(

const std::string &

name

)

Set the name of the value representation item.

Parameters

name	The name of the value representation item

Returns

The ValueRepItem object

SetValue()

AMCAX_API ValueRepItem & AMCAX::STEP::ValueRepItem::SetValue

(

const double &

value

)

Set the value of the value representation item.

Parameters

value

The value of the value

Returns

The ValueRepItem object

---

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

• step/repitem/ValueRepItem.hpp