All Frameworks Class Hierarchy This Framework Previous Next Indexes
ObjectModelerBase Interface CATIProperty
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIProperty
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIProperty
Interface to specify properties on an object.
- See also:
- CORBAAny
Method Index
- o
define_properties(Properties&)
- Defines several properties.
- o
define_property(PropertyName&,CORBAAny&)
- Defines a property.
- o
delete_all_properties()
- Deletes all properties.
- o
delete_properties(PropertyNames&)
- Deletes several properties.
- o
delete_property(PropertyName&)
- Deletes a property.
- o
get_all_properties()
- Returns all properties.
- o
get_all_property_names()
- Returns the name of all properties.
- o
get_number_of_properties()
- Returns the total number of properties.
- o
get_properties(PropertyNames&)
- Returns several properties.
- o
get_property_value(PropertyName&)
- Returns the value of a given property.
- o
is_property_defined(PropertyName&)
- Tests whether a property is defined on this object.
Methods
o define_properties
public virtual void define_properties( | const Properties& | iNproperties) = 0 |
-
Defines several properties.
Role: used to assign values to several properties, specified by their names.
This method can also be used to modify several properties by changing their values.
- Parameters:
-
- iNproperties
- the number of properties.
o define_property
-
Defines a property.
Role: used to assign a value to a property, specified by its name.
This method can also be used to modify a property with the same name by changing
its value.
- Parameters:
-
- iPropertyName
- the name of the property to set.
- iPropertyValue
- the value of the property.
o delete_all_properties
public virtual int delete_all_properties( | )= 0 |
-
Deletes all properties.
- Returns:
- the number of properties deleted.
o delete_properties
public virtual void delete_properties( | const PropertyNames& | iPropertyNames) = 0 |
-
Deletes several properties.
- Parameters:
-
- iPropertyNames
- the names of the concerned properties.
o delete_property
public virtual void delete_property( | const PropertyName& | iPropertyName) = 0 |
-
Deletes a property.
- Parameters:
-
- iPropertyName
- the name of the concerned property.
o get_all_properties
-
Returns all properties.
o get_all_property_names
-
Returns the name of all properties.
o get_number_of_properties
public virtual CATULONG32 get_number_of_properties( | )= 0 |
-
Returns the total number of properties.
o get_properties
-
Returns several properties.
- Parameters:
-
- iPropertyNames
- the names of concerned properties.
o get_property_value
-
Returns the value of a given property.
- Parameters:
-
- iPropertyName
- the name of the concerned property.
o is_property_defined
public virtual int is_property_defined( | const PropertyName& | iPropertyName) = 0 |
-
Tests whether a property is defined on this object.
- Returns:
- 1 if is defined. 0 otherwise.
This object is included in the file: CATIProperty.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase