v2.17
IModelObject Interface Reference

The base interface for all model objects. More...

Inheritance diagram for IModelObject:

Public Member Functions

HRESULT GetProperties ([out, retval] IPropertyContainer **ppPropertyContainer)
 Returns the property container interface for the object. More...
 
HRESULT GetQuantities ([out, retval] IQuantityContainer **ppQuantityContainer)
 Returns the quantity container interface for the object. More...
 
HRESULT GetInterfaceByName ([in] BSTR interfaceName, [out, retval] IDispatch **ppInterface)
 Returns an interface by its name. More...
 
HRESULT GetParameters ([out, retval] IParameterContainer **ppParameterContainer)
 Returns the parameter container interface for the object. More...
 

Properties

GUID ObjectType [get]
 The type of the object. More...
 
int Id [get]
 The identifier of the object instance. It is unique in current project instance.
 
BSTR Name [get]
 The localized object name.
 
BSTR ObjectTypeS [get]
 The type of the object as a string. More...
 
GUID UniqueId [get]
 The unique identifier of the object instance. It is a universal unique identifier.
 
BSTR UniqueIdS [get]
 Same as UniqueId, but returning GUID as a string.
 

Detailed Description

The base interface for all model objects.

Using this interface you can obtain the type, ID and name of an object. This interface can be obtained through the IModelObjectCollection interface.

Member Function Documentation

◆ GetInterfaceByName()

HRESULT IModelObject::GetInterfaceByName ( [in] BSTR  interfaceName,
[out, retval] IDispatch **  ppInterface 
)

Returns an interface by its name.

This method is provided as an alternative for the standard COM QueryInterface() method for cases where IUnknown is not accessible, like interoperating with the API from some interpreted languages.

Parameters
[in]interfaceNameThe name of the requested interface.
[out]ppInterfaceThe requested interface.

◆ GetParameters()

HRESULT IModelObject::GetParameters ( [out, retval] IParameterContainer **  ppParameterContainer)

Returns the parameter container interface for the object.

Returns
A parameter container.

◆ GetProperties()

HRESULT IModelObject::GetProperties ( [out, retval] IPropertyContainer **  ppPropertyContainer)

Returns the property container interface for the object.

Returns
A property container.

◆ GetQuantities()

HRESULT IModelObject::GetQuantities ( [out, retval] IQuantityContainer **  ppQuantityContainer)

Returns the quantity container interface for the object.

Returns
A quantity container.

Property Documentation

◆ ObjectType

GUID IModelObject::ObjectType
get

The type of the object.

See also
Object types

◆ ObjectTypeS

BSTR IModelObject::ObjectTypeS
get

The type of the object as a string.

See also
Object types