#include <IfcPsdQto.h>

Public Member Functions
	PSDQTO (const char *applicableVersion=nullptr)

	~PSDQTO ()

OdDAI::SchemaPtr	getSchema () const

OdDAI::ModelPtr	getModel () const

const OdAnsiString &	getName () const

const OdAnsiString &	getComment () const

void	setName (const OdAnsiString &value)

void	setComment (const OdAnsiString &value)

void	Clear ()

OdResult	importFromXML (const char *fileName)

OdResult	exportToXML (const OdDAI::ApplicationInstance psdqtoInstance, const char fileName)

bool	getApplicablePSD (const OdDAI::ApplicationInstance *ifcInstance, OdDAIObjectIds &ids) const

bool	getApplicableQTO (const OdDAI::ApplicationInstance *ifcInstance, OdDAIObjectIds &ids) const

bool	getApplicable (const OdDAI::ApplicationInstance *ifcInstance, OdDAIObjectIds &ids) const

bool	getApplicable (const char *applicableClassName, OdDAIObjectIds &ids) const

bool	getApplicable (const OdDAI::Entity ifcEntity, const char predefinedType, OdDAIObjectIds &ids) const

bool	isApplicablePSD (const OdDAI::ApplicationInstance *ifcInstance) const

bool	isApplicableQTO (const OdDAI::ApplicationInstance *ifcInstance) const

OdResult	readFile (const OdString &fileName)

OdResult	writeFile (const OdString &fileName)

Detailed Description

A class that provides the interface for operations over Property/Quantity Set Definitions (PSD/QTO).

Definition at line 36 of file IfcPsdQto.h.

Constructor & Destructor Documentation

◆ PSDQTO()

PSDQTO::PSDQTO ( const char * applicableVersion = nullptr )

Constructor for the PSDQTO class.

Parameters

applicableVersion [in] File version allowed for loading. If no restriction to a specific version should be specified, set this argument to nullptr.

◆ ~PSDQTO()

PSDQTO::~PSDQTO ( )

Destructor for the PSDQTO class.

Member Function Documentation

◆ Clear()

void PSDQTO::Clear ( )

Clears PSD/QTO definition instances.

◆ exportToXML()

OdResult PSDQTO::exportToXML	(	const OdDAI::ApplicationInstance *	psdqtoInstance,
		const char *	fileName )

Exports a PSD/QTO definition instance into an output psdXML file.

Parameters

psdqtoInstance	[in] Smart pointer to PSD or QTO application instance that should be exported into XML file.
fileName	[in/out] Raw string that contains output XML file name.

Returns: eOk if operation is successfully done, otherwise returns appropriate OdResult code.

◆ getApplicable() [1/3]

bool PSDQTO::getApplicable	(	const char *	applicableClassName,
		OdDAIObjectIds &	ids ) const

Retrieves an array of OdDAIObjectIds for PSD/QTO definitions which are applicable to provided IFC instance name and predefined type (optional).

Parameters

applicableClassName	[in] IFC entity name and predefined type (optional) to find applicable PSD/QTO definitions for.
ids	[in/out] Array to collect object identifiers for applicable PSD/QTO definition instances.

Returns: Returns true if at least one element has been added to the array, otherwise returns false.

Remarks: The predefined type is placed after the entity name with a slash. Example: "IfcValve/MIXING".

◆ getApplicable() [2/3]

bool PSDQTO::getApplicable	(	const OdDAI::ApplicationInstance *	ifcInstance,
		OdDAIObjectIds &	ids ) const

Retrieves an array of OdDAIObjectIds for PSD/QTO definitions which are applicable to provided IFC instance.

Parameters

ifcInstance	[in] IFC application instance to find applicable PSD/QTO definitions for.
ids	[in/out] Array to collect object identifiers for applicable PSD/QTO definition instances.

Returns: Returns true if at least one element has been added to the array, otherwise returns false.

◆ getApplicable() [3/3]

bool PSDQTO::getApplicable	(	const OdDAI::Entity *	ifcEntity,
		const char *	predefinedType,
		OdDAIObjectIds &	ids ) const

Retrieves an array of OdDAIObjectIds for PSD/QTO definitions which are applicable to provided IFC entity and predefined type (optional).

Parameters

ifcEntity	[in] IFC entity to find applicable PSD/QTO definitions for.
predefinedType	[in] predefined type for instance or null pointer.
ids	[in/out] Array to collect object identifiers for applicable PSD/QTO definition instances.

Returns: Returns true if at least one element has been added to the array, otherwise returns false.

◆ getApplicablePSD()

bool PSDQTO::getApplicablePSD	(	const OdDAI::ApplicationInstance *	ifcInstance,
		OdDAIObjectIds &	ids ) const

Retrieves an array of OdDAIObjectIds for property set definitions which are applicable to provided IFC instance.

Parameters

ifcInstance	[in] IFC application instance to find applicable property set definitions for.
ids	[in] Array to collect object identifiers for applicable property set definition instances.

Returns: Returns true if at least one element has been added to the array, otherwise returns false.

◆ getApplicableQTO()

bool PSDQTO::getApplicableQTO	(	const OdDAI::ApplicationInstance *	ifcInstance,
		OdDAIObjectIds &	ids ) const

Retrieves an array of OdDAIObjectIds for quantity set definitions which are applicable to provided IFC instance.

Parameters

ifcInstance	[in] IFC application instance to find applicable quantity set definitions for.
ids	[in/out] Array to collect object identifiers for applicable quantity set definition instances.

Returns: Returns true if at least one element has been added to the array, otherwise returns false.

◆ getComment()

const OdAnsiString & PSDQTO::getComment ( ) const

Retrieves the comment of the object.

Returns: A string that contains the comment of the object.

◆ getModel()

OdDAI::ModelPtr PSDQTO::getModel ( ) const

Retrieves an underlying OdDAI::Model that contains imported/loaded PSD/QTO definitions.

Returns: a smart pointer to an underlying PSD/QTO definitions within EXPRESS model.

◆ getName()

const OdAnsiString & PSDQTO::getName ( ) const

Retrieves the name of the object.

Returns: A string that contains the name of the object.

◆ getSchema()

OdDAI::SchemaPtr PSDQTO::getSchema ( ) const

Retrieves an underlying PSDQTO EXPRESS schema definition.

Returns: a smart pointer to an underlying PSDQTO EXPRESS schema definition.

◆ importFromXML()

OdResult PSDQTO::importFromXML ( const char * fileName )

Imports an input XML file into appropriate PSD/QTO definition instance.

Parameters

fileName [in] Raw string that contains XML file name that should be imported into appropriate PSD/QTO definition instance.

Returns: eOk if operation is successfully done, otherwise returns appropriate OdResult code.

◆ isApplicablePSD()

bool PSDQTO::isApplicablePSD ( const OdDAI::ApplicationInstance * ifcInstance ) const

Checks whether applicable property set definitions exist for the provided IFC instance.

Parameters

ifcInstance [in] IFC application instance to find applicable property set definitions for.

Returns: Returns true if at least one element exists, otherwise returns false.

◆ isApplicableQTO()

bool PSDQTO::isApplicableQTO ( const OdDAI::ApplicationInstance * ifcInstance ) const

Checks whether applicable quantity set definitions exist for the provided IFC instance.

Parameters

ifcInstance [in] IFC application instance to find applicable quantity set definitions for.

Returns: Returns true if at least one element exists, otherwise returns false.

◆ readFile()

OdResult PSDQTO::readFile ( const OdString & fileName )

Reads a Step Physical File that contains PSD/QTO definitions according PSDQTO EXPRESS schema.

Parameters

fileName [in] OdString that contains input file name.

Returns: eOk if underlying model was successfully read from a file.

◆ setComment()

void PSDQTO::setComment ( const OdAnsiString & value )

Set the comment of the object.

Parameters

value [in] A string value to set.

◆ setName()

void PSDQTO::setName ( const OdAnsiString & value )

Set the name of the object.

Parameters

value [in] A string value to set.

◆ writeFile()

OdResult PSDQTO::writeFile ( const OdString & fileName )

Writes underlying model with property/quantity sets data into Step Physical File.

Parameters

fileName [in] OdString that contains output file name.

Returns: eOk if underlying model was successfully written into file.

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

IfcPsdQto.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PSDQTO()

◆ ~PSDQTO()

Member Function Documentation

◆ Clear()

◆ exportToXML()

◆ getApplicable() [1/3]

◆ getApplicable() [2/3]

◆ getApplicable() [3/3]

◆ getApplicablePSD()

◆ getApplicableQTO()

◆ getComment()

◆ getModel()

◆ getName()

◆ getSchema()

◆ importFromXML()

◆ isApplicablePSD()

◆ isApplicableQTO()

◆ readFile()

◆ setComment()

◆ setName()

◆ writeFile()