PropertyQosPolicyHelper Class Reference
[PROPERTY]

Policy Helpers which facilitate management of the properties in the input policy. More...

List of all members.

Static Public Member Functions
static int	get_number_of_properties (PropertyQosPolicy policy)
	Gets the number of properties in the input policy.
static void	assert_property (PropertyQosPolicy policy, String name, String value, boolean propagate)
	Asserts the property identified by name in the input policy.
static void	add_property (PropertyQosPolicy policy, String name, String value, boolean propagate)
	Adds a new property to the input policy.
static Property_t	lookup_property (PropertyQosPolicy policy, String name)
	Searches for a property in the input policy given its name.
static void	remove_property (PropertyQosPolicy policy, String name)
	Removes a property from the input policy.
static void	get_properties (PropertyQosPolicy policy, PropertySeq properties, String name_prefix)
	Retrieves a list of properties whose names match the input prefix.

---

Detailed Description

Policy Helpers which facilitate management of the properties in the input policy.

---

Member Function Documentation

static int get_number_of_properties

(

PropertyQosPolicy

policy

)

[static]

Gets the number of properties in the input policy.

Precondition:

policy cannot be null.

Parameters:

policy

<<in>> Input policy.

Returns:

Number of properties.

static void assert_property	(	PropertyQosPolicy	policy,
		String	name,
		String	value,
		boolean	propagate
	)			[static]

Asserts the property identified by name in the input policy.

If the property already exists, this function replaces its current value with the new one.

If the property identified by name does not exist, this function adds it to the property set.

This function increases the maximum number of elements of the policy sequence when this number is not enough to store the new property.

Precondition:

policy, name and value cannot be null.

Parameters:

	policy	<<in>> Input policy.
	name	<<in>> Property name.
	value	<<in>> Property value.
	propagate	<<in>> Indicates if the property will be propagated on discovery.

Returns:

One of the Standard Return Codes or RETCODE_OUT_OF_RESOURCES.

static void add_property	(	PropertyQosPolicy	policy,
		String	name,
		String	value,
		boolean	propagate
	)			[static]

Adds a new property to the input policy.

This function will allocate memory to store the (name,value) pair. The memory allocated is owned by RTI Connext.

If the maximum number of elements of the policy sequence is not enough to store the new property, this function will increase it.

If the property already exists the function fails with RETCODE_PRECONDITION_NOT_MET.

Precondition:

policy, name and value cannot be null.

The property is not in the policy.

Parameters:

	policy	<<in>> Input policy.
	name	<<in>> Property name.
	value	<<in>> Property value.
	propagate	<<in>> Indicates if the property will be propagated on discovery.

Returns:

One of the Standard Return Codes or RETCODE_OUT_OF_RESOURCES or RETCODE_PRECONDITION_NOT_MET

static Property_t lookup_property	(	PropertyQosPolicy	policy,
		String	name
	)			[static]

Searches for a property in the input policy given its name.

Precondition:

policy, name and value cannot be null.

Parameters:

	policy	<<in>> Input policy.
	name	<<in>> Property name.

Returns:

On success, the function returns the first property with the given name. Otherwise, the function returns NULL.

static void remove_property	(	PropertyQosPolicy	policy,
		String	name
	)			[static]

Removes a property from the input policy.

If the property does not exist, the function fails with RETCODE_PRECONDITION_NOT_MET.

Precondition:

policy and name cannot be null.

The property is in the policy.

Parameters:

	policy	<<in>> Input policy.
	name	<<in>> Property name.

Returns:

One of the Standard Return Codes or RETCODE_PRECONDITION_NOT_MET.

static void get_properties	(	PropertyQosPolicy	policy,
		PropertySeq	properties,
		String	name_prefix
	)			[static]

Retrieves a list of properties whose names match the input prefix.

If the properties sequence doesn't own its buffer, and its maximum is less than the total number of properties matching the input prefix, it will be filled up to its maximum and fail with an error of RETCODE_OUT_OF_RESOURCES.

Precondition:

policy, properties and name_prefix cannot be null.

Parameters:

	policy	<<in>> Input policy.
	properties	<<inout>> A com.rti.dds.infrastructure.PropertySeq object where the set or list of properties will be returned.
	name_prefix	Name prefix.

Returns:

One of the Standard Return Codes or RETCODE_OUT_OF_RESOURCES.