OdMvdXml::OdMvdApplicability Class Reference

#include <MvdXmlCommon.h>

Public Types
enum	Applicability { kUnset = -1 , kImport = 0 , kExport , kBoth }

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

Detailed Description

A class that stores and operates the data about applicability within the Exchange Requirement Model (ERM).

Definition at line 308 of file MvdXmlCommon.h.

Member Enumeration Documentation

Applicability

enum OdMvdXml::OdMvdApplicability::Applicability

Declarations that cover applicability values.

Enumerator
kUnset	Applicability is not set.
kImport	Import applicability that assumes the definition of data that the importing application can correctly process.
kExport	Export applicability that assumes the exchange application must create a data that matches the defined requirements.
kBoth	Applicable for both import and export.

Definition at line 315 of file MvdXmlCommon.h.

Constructor & Destructor Documentation

OdMvdApplicability()

OdMvdXml::OdMvdApplicability::OdMvdApplicability ( )

inline

Creates a new applicability object with unset <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdApplicability__Applicability.html">applicability value</exref>.

Definition at line 333 of file MvdXmlCommon.h.

Member Function Documentation

get()

const Applicability OdMvdXml::OdMvdApplicability::get ( ) const

inline

Retrieves the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml::OdMvdApplicability__Applicability.html>Applicability</exref> applicability type> associated with the applicability object. \returns A value of the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdApplicability__Applicability.html">OdMvdApplicability::Applicability enumeration</exref> that represents the applicability type.

Definition at line 341 of file MvdXmlCommon.h.

IsUnset()

const bool OdMvdXml::OdMvdApplicability::IsUnset ( ) const

inline

Checks whether the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdApplicability__Applicability.html">applicability value</exref> is not set.

Returns

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

Definition at line 350 of file MvdXmlCommon.h.

operator=() [1/3]

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

inline

The assignment operator for applicability objects.

Parameters

other

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

Returns

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

Definition at line 415 of file MvdXmlCommon.h.

operator=() [2/3]

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

inline

The assignment operator for applicability 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::OdMvdApplicability__Applicability.html>Applicability</exref> applicability type> to be assigned (right-hand operand of the assignment operation).

Returns

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

Definition at line 405 of file MvdXmlCommon.h.

operator=() [3/3]

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

inline

The assignment operator for applicability objects.

Parameters

other

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

Returns

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

Definition at line 394 of file MvdXmlCommon.h.

operator==() [1/2]

bool OdMvdXml::OdMvdApplicability::operator== ( const Applicability other ) const

inline

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

Parameters

other

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

Definition at line 384 of file MvdXmlCommon.h.

operator==() [2/2]

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

inline

The equality operator that compares two applicability objects.

Parameters

other

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

Returns

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

Definition at line 374 of file MvdXmlCommon.h.

toString()

OdAnsiString OdMvdXml::OdMvdApplicability::toString ( )

inline

Retrieves the textual representation of the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdApplicability__Applicability.html">applicability value</exref> associated with the applicability 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__OdMvdApplicability__Applicability.html">applicability type</exref>

Definition at line 359 of file MvdXmlCommon.h.

---

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

• MvdXmlCommon.h