class ProtectionZone

Member values

Member name	Data type	Description
handle	ProtectionZoneHandle	Protection zone handle
name	string	Protection zone friendly name
application_data	string	Application data (reserved for use by Web App)
is_enabled	bool	True if protection zone is enabled, false otherwise
shape	ZoneShape	Protection zone shape
limitations	CartesianLimitation	List of Cartesian limitation
envelope_limitations	CartesianLimitation	List of Cartesian limitation of the envelop

Member functions

Function name	Return type	Input type	Description
has_handle() const	bool	void	Returns true if handle is set.
handle()	const ProtectionZoneHandle&	void	Returns the current value of handle. If handle is not set, returns a ProtectionZoneHandle with none of its fields set (possibly handle::default_instance()).
mutable_handle()	ProtectionZoneHandle *	void	Returns a pointer to the mutable ProtectionZoneHandle object that stores the field's value. If the field was not set prior to the call, then the returned ProtectionZoneHandle will have none of its fields set (i.e. it will be identical to a newly-allocated ProtectionZoneHandle). After calling this, has_handle() will return true and handle() will return a reference to the same instance of ProtectionZoneHandle.
clear_handle()	void	void	Clears the value of the field. After calling this, has_handle() will return false and handle() will return the default value.
set_allocated_handle()	void	ProtectionZoneHandle *	Sets the ProtectionZoneHandle object to the field and frees the previous field value if it exists. If the ProtectionZoneHandle pointer is not NULL, the message takes ownership of the allocated ProtectionZoneHandle object and has_ ProtectionZoneHandle() will return true. Otherwise, if the handle is NULL, the behavior is the same as calling clear_handle().
release_handle()	ProtectionZoneHandle *	void	Releases the ownership of the field and returns the pointer of the ProtectionZoneHandle object. After calling this, caller takes the ownership of the allocated ProtectionZoneHandle object, has_handle() will return false, and handle() will return the default value.
name()	const string&	void	Returns the current value of name. If name is not set, returns the empty string/empty bytes.
set_name()	void	const string&	Sets the value of name. After calling this, name() will return a copy of value.
set_name()	void	string&&	(C++11 and beyond): Sets the value of name, moving from the passed string. After calling this, name() will return a copy of value.
set_name()	void	const char*	Sets the value of name using a C-style null-terminated string. After calling this, name() will return a copy of value.
mutable_name()	string *	void	Returns a pointer to the mutable string object that stores name's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, name() will return whatever value is written into the given string.
clear_name()	void	void	Clears the value of name. After calling this, name() will return the empty string/empty bytes.
set_allocated_name()	void	string*	Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_name().
release_name()	string *	void	Releases the ownership of name and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and name() will return the empty string/empty bytes.
application_data()	const string&	void	Returns the current value of application_data. If application_data is not set, returns the empty string/empty bytes.
set_application_data()	void	const string&	Sets the value of application_data. After calling this, application_data() will return a copy of value.
set_application_data()	void	string&&	(C++11 and beyond): Sets the value of application_data, moving from the passed string. After calling this, application_data() will return a copy of value.
set_application_data()	void	const char*	Sets the value of application_data using a C-style null-terminated string. After calling this, application_data() will return a copy of value.
mutable_application_data()	string *	void	Returns a pointer to the mutable string object that stores application_data's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, application_data() will return whatever value is written into the given string.
clear_application_data()	void	void	Clears the value of application_data. After calling this, application_data() will return the empty string/empty bytes.
set_allocated_application_data()	void	string*	Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_application_data().
release_application_data()	string *	void	Releases the ownership of application_data and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and application_data() will return the empty string/empty bytes.
is_enabled()	bool	void	Returns the current value of is_enabled. If the is_enabled is not set, returns 0.
set_is_enabled()	void	bool	Sets the value of is_enabled. After calling this, is_enabled() will return value.
clear_is_enabled()	void	void	Clears the value of is_enabled. After calling this, is_enabled() will return 0.
has_shape() const	bool	void	Returns true if shape is set.
shape()	const ZoneShape&	void	Returns the current value of shape. If shape is not set, returns a ZoneShape with none of its fields set (possibly shape::default_instance()).
mutable_shape()	ZoneShape *	void	Returns a pointer to the mutable ZoneShape object that stores the field's value. If the field was not set prior to the call, then the returned ZoneShape will have none of its fields set (i.e. it will be identical to a newly-allocated ZoneShape). After calling this, has_shape() will return true and shape() will return a reference to the same instance of ZoneShape.
clear_shape()	void	void	Clears the value of the field. After calling this, has_shape() will return false and shape() will return the default value.
set_allocated_shape()	void	ZoneShape *	Sets the ZoneShape object to the field and frees the previous field value if it exists. If the ZoneShape pointer is not NULL, the message takes ownership of the allocated ZoneShape object and has_ ZoneShape() will return true. Otherwise, if the shape is NULL, the behavior is the same as calling clear_shape().
release_shape()	ZoneShape *	void	Releases the ownership of the field and returns the pointer of the ZoneShape object. After calling this, caller takes the ownership of the allocated ZoneShape object, has_shape() will return false, and shape() will return the default value.
limitations_size() const	int	void	Returns the number of elements currently in the field.
limitations() const	const CartesianLimitation	int index	Returns the element at the given zero-based index. Calling this method with index outside of [0, limitations_size()) yields undefined behavior.
mutable_limitations()	CartesianLimitation*	int index	Returns a pointer to the mutable CartesianLimitation object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, limitations_size()) yields undefined behavior.
add_limitations()	CartesianLimitation*	void	Adds a new element and returns a pointer to it. The returned CartesianLimitation is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated CartesianLimitation).
clear_limitations()	void	void	Removes all elements from the field. After calling this, limitations_size() will return zero.
limitations() const	const RepeatedPtrField< CartesianLimitation>&	void	Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_limitations()	RepeatedPtrField< CartesianLimitation>*	void	Returns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
envelope_limitations_size() const	int	void	Returns the number of elements currently in the field.
envelope_limitations() const	const CartesianLimitation	int index	Returns the element at the given zero-based index. Calling this method with index outside of [0, envelope_limitations_size()) yields undefined behavior.
mutable_envelope_limitations()	CartesianLimitation*	int index	Returns a pointer to the mutable CartesianLimitation object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, envelope_limitations_size()) yields undefined behavior.
add_envelope_limitations()	CartesianLimitation*	void	Adds a new element and returns a pointer to it. The returned CartesianLimitation is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated CartesianLimitation).
clear_envelope_limitations()	void	void	Removes all elements from the field. After calling this, envelope_limitations_size() will return zero.
envelope_limitations() const	const RepeatedPtrField< CartesianLimitation>&	void	Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_envelope_limitations()	RepeatedPtrField< CartesianLimitation>*	void	Returns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.

Parent topic: Base (C++)