API reference - Class PropertyConstraint

Notation used in Ruby API documentation

Module: db

Description: This class represents the property constraint for boolean and check functions.

This enum has been introduced in version 0.28.4.

Public constructors

new PropertyConstraint ptrnew(int i)Creates an enum from an integer value
new PropertyConstraint ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const PropertyConstraint other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const PropertyConstraint other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const PropertyConstraint other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]PropertyConstraint ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const PropertyConstraint other)Assigns another object to self
[const]new PropertyConstraint ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum

Public static methods and constants

[static,const]PropertyConstraintDifferentPropertiesConstraintSpecifies to consider shapes only if their user properties are different
[static,const]PropertyConstraintDifferentPropertiesConstraintDropSpecifies to consider shapes only if their user properties are different
[static,const]PropertyConstraintIgnorePropertiesSpecifies to ignore properties
[static,const]PropertyConstraintNoPropertyConstraintSpecifies not to apply any property constraint
[static,const]PropertyConstraintSamePropertiesConstraintSpecifies to consider shapes only if their user properties are the same
[static,const]PropertyConstraintSamePropertiesConstraintDropSpecifies to consider shapes only if their user properties are the same

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

(1) Signature: [const] bool != (const PropertyConstraint other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const PropertyConstraint other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const PropertyConstraint other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

DifferentPropertiesConstraint

Signature: [static,const] PropertyConstraint DifferentPropertiesConstraint

Description: Specifies to consider shapes only if their user properties are different

When using this constraint - for example on a boolean operation - shapes are considered only if their user properties are different. Properties are generated on the output shapes where applicable.

Python specific notes:
The object exposes a readable attribute 'DifferentPropertiesConstraint'. This is the getter.

DifferentPropertiesConstraintDrop

Signature: [static,const] PropertyConstraint DifferentPropertiesConstraintDrop

Description: Specifies to consider shapes only if their user properties are different

When using this constraint - for example on a boolean operation - shapes are considered only if their user properties are the same. No properties are generated on the output shapes.

Python specific notes:
The object exposes a readable attribute 'DifferentPropertiesConstraintDrop'. This is the getter.

IgnoreProperties

Signature: [static,const] PropertyConstraint IgnoreProperties

Description: Specifies to ignore properties

When using this constraint - for example on a boolean operation - properties are ignored and are not generated in the output.

Python specific notes:
The object exposes a readable attribute 'IgnoreProperties'. This is the getter.

NoPropertyConstraint

Signature: [static,const] PropertyConstraint NoPropertyConstraint

Description: Specifies not to apply any property constraint

When using this constraint - for example on a boolean operation - shapes are considered regardless of their user properties. Properties are generated on the output shapes where applicable.

Python specific notes:
The object exposes a readable attribute 'NoPropertyConstraint'. This is the getter.

SamePropertiesConstraint

Signature: [static,const] PropertyConstraint SamePropertiesConstraint

Description: Specifies to consider shapes only if their user properties are the same

When using this constraint - for example on a boolean operation - shapes are considered only if their user properties are the same. Properties are generated on the output shapes where applicable.

Python specific notes:
The object exposes a readable attribute 'SamePropertiesConstraint'. This is the getter.

SamePropertiesConstraintDrop

Signature: [static,const] PropertyConstraint SamePropertiesConstraintDrop

Description: Specifies to consider shapes only if their user properties are the same

When using this constraint - for example on a boolean operation - shapes are considered only if their user properties are the same. No properties are generated on the output shapes.

Python specific notes:
The object exposes a readable attribute 'SamePropertiesConstraintDrop'. This is the getter.

_const_cast

Signature: [const] PropertyConstraint ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const PropertyConstraint other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new PropertyConstraint ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

Python specific notes:
This method is also available as 'hash(object)'.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new PropertyConstraint ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new PropertyConstraint ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object.

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

Python specific notes:
This method is also available as 'int(object)'.

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.