HPS::Exchange::Filter

class HPS.Exchange.Filter : public HPS.Filter

The Filter class is a smart pointer. It represents an A3DAsmFilter in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmFilter pointer for use by Exchange library functions.

Public Functions

override void Dispose ()

Filter ()

The default constructor creates an uninitialized Filter object. The Type() function will return Type.None.

Filter (HPS.Component in_that)

This constructor creates a Filter object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Filter object. Otherwise the copy will fail and the resulting Exchange.Filter will be invalid.

Param in_that

The source Component to copy.

Filter (HPS.Exchange.Filter in_that)

This constructor creates an Exchange.Filter object that shares the underlying smart-pointer of the source HPS.Filter. The copy will only be successful if the source component is really an upcast of an Exchange.Filter object. Otherwise the copy will fail and the resulting Exchange.Filter will be invalid.

Param in_that

The source HPS.Filter to copy.

Filter (HPS.Filter in_that)

This constructor creates an Exchange.Filter object that shares the underlying smart-pointer of the source HPS.Filter. The copy will only be successful if the source component is really an upcast of an Exchange.Filter object. Otherwise the copy will fail and the resulting Exchange.Filter will be invalid.

Param in_that

The source HPS.Filter to copy.

IntPtr GetExchangeEntity ()

Gets the A3DEntity pointer corresponding to this Exchange.Filter.

Return

The A3DEntity pointer corresponding to this Exchange.Filter.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.