OdMvdXml::OdMvdRequirement Class Reference

#include <MvdXmlCommon.h>

Public Types
enum	Requirement {   kUnset = -1 , kMandatory = 0 , kRecommended , kNotRelevant ,   kNotRecommended , kExcluded }

Public Member Functions
	OdMvdRequirement ()
const Requirement	get () const
const bool	IsUnset () const
OdAnsiString	toString ()
bool	operator== (const OdMvdRequirement &other) const
bool	operator== (const Requirement other) const
OdMvdRequirement &	operator= (const OdMvdRequirement &other)
OdMvdRequirement &	operator= (const OdAnsiString &other)
OdMvdRequirement &	operator= (const char *other)

Detailed Description

A class that implements storing and operating of exchange requirements.

Definition at line 439 of file MvdXmlCommon.h.

Member Enumeration Documentation

Requirement

enum OdMvdXml::OdMvdRequirement::Requirement

Declarations of exchange requirement types.

Enumerator
kUnset	An exchange requirement is undefined.
kMandatory	A mandatory requirement: must be met; otherwise an error occurs.
kRecommended	A recommended requirement: should be met; otherwise a warning occurs.
kNotRelevant	A not-relevant requirement: no requirements to meet.
kNotRecommended	A not-recommended requirement: should NOT be met; otherwise a warning occurs.
kExcluded	An excluded requirement: must NOT be true; otherwise an error occurs.

Definition at line 445 of file MvdXmlCommon.h.

Constructor & Destructor Documentation

OdMvdRequirement()

OdMvdXml::OdMvdRequirement::OdMvdRequirement ( )

inline

Creates a new requirement object.

Definition at line 469 of file MvdXmlCommon.h.

Member Function Documentation

get()

const Requirement OdMvdXml::OdMvdRequirement::get ( ) const

inline

Retrieves the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml::OdMvdRequirement__Requirement.html>Requirement</exref> requirement type> associated with the requirement object. \returns A value of the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml::OdMvdRequirement__Requirement.html>Requirement</exref> OdMvdRequirement::Requirement enumeration> that represents the requirement type.

Definition at line 477 of file MvdXmlCommon.h.

IsUnset()

const bool OdMvdXml::OdMvdRequirement::IsUnset ( ) const

inline

Checks whether the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref> is not set.

Returns

true if the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref> is NOT specified; otherwise, the method returns false.

Definition at line 486 of file MvdXmlCommon.h.

operator=() [1/3]

OdMvdRequirement & OdMvdXml::OdMvdRequirement::operator= ( const char * other )

inline

The assignment operator for requirement objects.

Parameters

other

[in] A ANSI string that contains a textual representation of the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref> to be assigned (right-hand operand of the assignment operation).

Returns

A reference to the requirement object modified by the assignment operation.

Definition at line 553 of file MvdXmlCommon.h.

operator=() [2/3]

OdMvdRequirement & OdMvdXml::OdMvdRequirement::operator= ( const OdAnsiString & other )

inline

The assignment operator for requirement objects.

Parameters

other

[in] An <exref target="https://docs.opendesign.com/tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains a textual representation of the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref> to be assigned (right-hand operand of the assignment operation).

Returns

A reference to the requirement object modified by the assignment operation.

Definition at line 543 of file MvdXmlCommon.h.

operator=() [3/3]

OdMvdRequirement & OdMvdXml::OdMvdRequirement::operator= ( const OdMvdRequirement & other )

inline

The assignment operator for requirement objects.

Parameters

other

[in] Another requirement object to be assigned (right-hand operand of the assignment operation).

Returns

A reference to the requirement object modified by the assignment operation.

Definition at line 532 of file MvdXmlCommon.h.

operator==() [1/2]

bool OdMvdXml::OdMvdRequirement::operator== ( const OdMvdRequirement & other ) const

inline

The equality operator that compares two requirement objects.

Parameters

other

[in] A requirement object to be compared with (right-hand operand of the comparison operation).

Returns

true if the requirement object equals to another specified requirement object; otherwise, the result equals to the false value.

Definition at line 512 of file MvdXmlCommon.h.

operator==() [2/2]

bool OdMvdXml::OdMvdRequirement::operator== ( const Requirement other ) const

inline

The equality operator that checks whether the requirement object has a specified <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref>.

Parameters

other

[in] An <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml::OdMvdRequirement__Requirement.html>Requirement</exref> OdMvdRequirement::Requirement enumeration> value that contains the requirement type. \returns true if the requirement object has the specified <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref>; otherwise, the result equals to the false value.

Definition at line 522 of file MvdXmlCommon.h.

toString()

OdAnsiString OdMvdXml::OdMvdRequirement::toString ( )

inline

Retrieves the textual representation of the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref> associated with the requirement object.

Returns

An <exref target="https://docs.opendesign.com/tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the textual representation of the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdRequirement__Requirement.html">requirement type</exref>.

Definition at line 495 of file MvdXmlCommon.h.

---

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

• MvdXmlCommon.h