AMCAX Kernel 1.0.0.0
Public Member Functions | List of all members
AMCAX::STEP::DescriptiveRepItem Class Reference

Class for Descriptive Representation Items. More...

#include <step/repitem/DescriptiveRepItem.hpp>

Inheritance diagram for AMCAX::STEP::DescriptiveRepItem:
Inheritance graph
[legend]
Collaboration diagram for AMCAX::STEP::DescriptiveRepItem:
Collaboration graph
[legend]

Public Member Functions

AMCAX_API DescriptiveRepItem ()
 Default constructor.
 
AMCAX_API DescriptiveRepItem (const std::string &name, const std::string &description)
 Constructor. More...
 
AMCAX_API DescriptiveRepItem (const DescriptiveRepItem &other)
 Copy constructor. More...
 
AMCAX_API DescriptiveRepItem (DescriptiveRepItem &&other) noexcept
 Move constructor. More...
 
AMCAX_API DescriptiveRepItem & operator= (const DescriptiveRepItem &other)
 Copy assignment operator. More...
 
AMCAX_API DescriptiveRepItem & operator= (DescriptiveRepItem &&other) noexcept
 Move assignment operator. More...
 
AMCAX_API ~DescriptiveRepItem () override
 Destructor.
 
AMCAX_API DescriptiveRepItem & SetName (const std::string &name)
 Set the name of the descriptive representation item. More...
 
AMCAX_API const std::string & GetDescription () const
 Get an immutable reference to the description of the descriptive representation item. More...
 
AMCAX_API DescriptiveRepItem & SetDescription (const std::string &description)
 Set the description of the descriptive representation item. More...
 
AMCAX_API bool operator== (const DescriptiveRepItem &other) const
 If the DescriptiveRepItem same as the other DescriptiveRepItem. More...
 
AMCAX_API bool operator!= (const DescriptiveRepItem &other) const
 If the DescriptiveRepItem different from the other DescriptiveRepItem. More...
 
AMCAX_API bool operator< (const DescriptiveRepItem &other) const
 If the DescriptiveRepItem less than the other DescriptiveRepItem. More...
 
AMCAX_API bool operator> (const DescriptiveRepItem &other) const
 If the DescriptiveRepItem greater than the other DescriptiveRepItem. More...
 
AMCAX_API bool operator<= (const DescriptiveRepItem &other) const
 If the DescriptiveRepItem less than or equal to the other DescriptiveRepItem. More...
 
AMCAX_API bool operator>= (const DescriptiveRepItem &other) const
 If the DescriptiveRepItem greater than or equal to the other DescriptiveRepItem. 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 Descriptive Representation Items.

Constructor & Destructor Documentation

◆ DescriptiveRepItem() [1/3]

AMCAX_API AMCAX::STEP::DescriptiveRepItem::DescriptiveRepItem ( const std::string &  name,
const std::string &  description 
)

Constructor.

Parameters
nameThe name of the descriptive representation item
descriptionThe description of the descriptive representation item

◆ DescriptiveRepItem() [2/3]

AMCAX_API AMCAX::STEP::DescriptiveRepItem::DescriptiveRepItem ( const DescriptiveRepItem &  other)

Copy constructor.

Parameters
otherThe other DescriptiveRepItem to copy from

◆ DescriptiveRepItem() [3/3]

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

Move constructor.

Parameters
otherThe other DescriptiveRepItem to move from

Member Function Documentation

◆ GetDescription()

AMCAX_API const std::string & AMCAX::STEP::DescriptiveRepItem::GetDescription ( ) const

Get an immutable reference to the description of the descriptive representation item.

Returns
An immutable reference to the description of the descriptive representation item

◆ operator!=()

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

If the DescriptiveRepItem different from the other DescriptiveRepItem.

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

◆ operator<()

AMCAX_API bool AMCAX::STEP::DescriptiveRepItem::operator< ( const DescriptiveRepItem &  other) const

If the DescriptiveRepItem less than the other DescriptiveRepItem.

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

◆ operator<=()

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

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

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

◆ operator=() [1/2]

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

Copy assignment operator.

Parameters
otherThe other DescriptiveRepItem to copy from
Returns
The DescriptiveRepItem object

◆ operator=() [2/2]

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

Move assignment operator.

Parameters
otherThe other DescriptiveRepItem to move from
Returns
The DescriptiveRepItem object

◆ operator==()

AMCAX_API bool AMCAX::STEP::DescriptiveRepItem::operator== ( const DescriptiveRepItem &  other) const

If the DescriptiveRepItem same as the other DescriptiveRepItem.

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

◆ operator>()

AMCAX_API bool AMCAX::STEP::DescriptiveRepItem::operator> ( const DescriptiveRepItem &  other) const

If the DescriptiveRepItem greater than the other DescriptiveRepItem.

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

◆ operator>=()

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

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

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

◆ SetDescription()

AMCAX_API DescriptiveRepItem & AMCAX::STEP::DescriptiveRepItem::SetDescription ( const std::string &  description)

Set the description of the descriptive representation item.

Parameters
descriptionThe description of the descriptive representation item
Returns
The DescriptiveRepItem object

◆ SetName()

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

Set the name of the descriptive representation item.

Parameters
nameThe name of the descriptive representation item
Returns
The DescriptiveRepItem object
The documentation for this class was generated from the following file: