FormIt C++ API  v23.0.0 (2023.0.0)
WSM::ObjectHistoryID Class Reference

Description

The ObjectHistoryID class combines a history ID and an object ID into a single object.

It is primarily used in collections where the included objects may be from different histories.

#include <ObjectHistoryID.h>

Public Member Functions

 ObjectHistoryID ()
 clang will give this error if =default is used here: default initialization of an object of const type requires a user-provided default constructor. More...
 
 ObjectHistoryID (size_t nHistory, size_t nObject)
 
bool operator< (WSM::ObjectHistoryID const &r) const
 Primarily for putting the objects in std::map collections. More...
 
bool operator== (WSM::ObjectHistoryID const &r) const
 
bool operator!= (WSM::ObjectHistoryID const &r) const
 
 operator bool () const
 
bool IsValid () const
 IsValid function. More...
 

Public Attributes

size_t m_nHistory = WSM::INVALID_ID
 
size_t m_nObject = WSM::INVALID_ID
 

Constructor & Destructor Documentation

WSM::ObjectHistoryID::ObjectHistoryID ( )
inline

clang will give this error if =default is used here: default initialization of an object of const type requires a user-provided default constructor.

This requirement is a standard defect (DR 253) in that it does not consider that member initializers can allow a compiler generated default constructor to fully initialize a POD class. GCC and MSVC behave as if this DR has already been resolved.

WSM::ObjectHistoryID::ObjectHistoryID ( size_t  nHistory,
size_t  nObject 
)
inline

Member Function Documentation

bool WSM::ObjectHistoryID::IsValid ( ) const
inline

IsValid function.

WSM::ObjectHistoryID::operator bool ( ) const
inlineexplicit
bool WSM::ObjectHistoryID::operator!= ( WSM::ObjectHistoryID const &  r) const
inline
bool WSM::ObjectHistoryID::operator< ( WSM::ObjectHistoryID const &  r) const
inline

Primarily for putting the objects in std::map collections.

bool WSM::ObjectHistoryID::operator== ( WSM::ObjectHistoryID const &  r) const
inline

Member Data Documentation

size_t WSM::ObjectHistoryID::m_nHistory = WSM::INVALID_ID
size_t WSM::ObjectHistoryID::m_nObject = WSM::INVALID_ID

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