Ellipse_t Class Reference

Detailed Description

render Graphical representation of an ellipse.

The Ellipse_t class is derived from GraphicalPrimitive2D_t, so it inherits all the attributes and methods of the latter. This means ellipses can have a transformation, a stroke and a stroke with to draw the edge as well as a fill style and fill style related settings. Besides those inherited attributes, an ellipse if defined by its center point which can be specified as a combination of absolute and relative values and its radii for the two axes. The radii can also be specified in terms absolute and/or relative values.

Public Member Functions
Ellipse_t *	Ellipse_clone (const Ellipse_t *e)
	Creates and returns a deep copy of this Ellipse_t object. More...
Ellipse_t *	Ellipse_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Ellipse_t using the given SBML Level, Version and “render” package version. More...
void	Ellipse_free (Ellipse_t *e)
	Frees this Ellipse_t object. More...
RelAbsVector_t *	Ellipse_getCX (const Ellipse_t *e)
	Returns the value of the "cx" element of this Ellipse_t. More...
RelAbsVector_t *	Ellipse_getCY (const Ellipse_t *e)
	Returns the value of the "cy" element of this Ellipse_t. More...
RelAbsVector_t *	Ellipse_getCZ (const Ellipse_t *e)
	Returns the value of the "cz" element of this Ellipse_t. More...
double	Ellipse_getRatio (const Ellipse_t *e)
	Returns the value of the "ratio" attribute of this Ellipse_t. More...
RelAbsVector_t *	Ellipse_getRX (const Ellipse_t *e)
	Returns the value of the "rx" element of this Ellipse_t. More...
RelAbsVector_t *	Ellipse_getRY (const Ellipse_t *e)
	Returns the value of the "ry" element of this Ellipse_t. More...
int	Ellipse_hasRequiredAttributes (const Ellipse_t *e)
	Predicate returning 1 (true) if all the required attributes for this Ellipse_t object have been set. More...
int	Ellipse_isSetCX (const Ellipse_t *e)
	Predicate returning 1 (true) if this Ellipse_t's "cx" element is set. More...
int	Ellipse_isSetCY (const Ellipse_t *e)
	Predicate returning 1 (true) if this Ellipse_t's "cy" element is set. More...
int	Ellipse_isSetCZ (const Ellipse_t *e)
	Predicate returning 1 (true) if this Ellipse_t's "cz" element is set. More...
int	Ellipse_isSetRatio (const Ellipse_t *e)
	Predicate returning 1 (true) if this Ellipse_t's "ratio" attribute is set. More...
int	Ellipse_isSetRX (const Ellipse_t *e)
	Predicate returning 1 (true) if this Ellipse_t's "rx" element is set. More...
int	Ellipse_isSetRY (const Ellipse_t *e)
	Predicate returning 1 (true) if this Ellipse_t's "ry" element is set. More...
int	Ellipse_setCX (Ellipse_t *e, const RelAbsVector_t *cx)
	Sets the value of the "cx" element of this Ellipse_t. More...
int	Ellipse_setCY (Ellipse_t *e, const RelAbsVector_t &cy)
	Sets the value of the "cy" element of this Ellipse_t. More...
int	Ellipse_setCZ (Ellipse_t *e, const RelAbsVector_t &cz)
	Sets the value of the "cz" element of this Ellipse_t. More...
int	Ellipse_setRatio (Ellipse_t *e, double ratio)
	Sets the value of the "ratio" attribute of this Ellipse_t. More...
int	Ellipse_setRX (Ellipse_t *e, const RelAbsVector_t &rx)
	Sets the value of the "rx" element of this Ellipse_t. More...
int	Ellipse_setRY (Ellipse_t *e, const RelAbsVector_t &ry)
	Sets the value of the "ry" element of this Ellipse_t. More...
int	Ellipse_unsetCX (Ellipse_t *e)
	Unsets the value of the "cx" element of this Ellipse_t. More...
int	Ellipse_unsetCY (Ellipse_t *e)
	Unsets the value of the "cy" element of this Ellipse_t. More...
int	Ellipse_unsetCZ (Ellipse_t *e)
	Unsets the value of the "cz" element of this Ellipse_t. More...
int	Ellipse_unsetRatio (Ellipse_t *e)
	Unsets the value of the "ratio" attribute of this Ellipse_t. More...
int	Ellipse_unsetRX (Ellipse_t *e)
	Unsets the value of the "rx" element of this Ellipse_t. More...
int	Ellipse_unsetRY (Ellipse_t *e)
	Unsets the value of the "ry" element of this Ellipse_t. More...

Member Function Documentation

Ellipse_t * Ellipse_clone

(

const Ellipse_t *

e

)

Creates and returns a deep copy of this Ellipse_t object.

Parameters

e	the Ellipse_t structure.

Returns

a (deep) copy of this Ellipse_t object.

Warning

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

Ellipse_t * Ellipse_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new Ellipse_t using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this Ellipse_t.
version	an unsigned int, the SBML Version to assign to this Ellipse_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this Ellipse_t.

Note

Attempting to add an object to an SBMLDocument_t having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument_t), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

Warning

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

void Ellipse_free

(

Ellipse_t *

e

)

Frees this Ellipse_t object.

Parameters

e	the Ellipse_t structure.

RelAbsVector_t * Ellipse_getCX

(

const Ellipse_t *

e

)

Returns the value of the "cx" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure whose cx is sought.

Returns

the value of the "cx" element of this Ellipse_t as a RelAbsVector_t.

RelAbsVector_t * Ellipse_getCY

(

const Ellipse_t *

e

)

Returns the value of the "cy" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure whose cy is sought.

Returns

the value of the "cy" element of this Ellipse_t as a RelAbsVector_t.

RelAbsVector_t * Ellipse_getCZ

(

const Ellipse_t *

e

)

Returns the value of the "cz" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure whose cz is sought.

Returns

the value of the "cz" element of this Ellipse_t as a RelAbsVector_t.

double Ellipse_getRatio

(

const Ellipse_t *

e

)

Returns the value of the "ratio" attribute of this Ellipse_t.

Parameters

e	the Ellipse_t structure whose ratio is sought.

Returns

the value of the "ratio" attribute of this Ellipse_t as a double.

RelAbsVector_t * Ellipse_getRX

(

const Ellipse_t *

e

)

Returns the value of the "rx" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure whose rx is sought.

Returns

the value of the "rx" element of this Ellipse_t as a RelAbsVector_t.

RelAbsVector_t * Ellipse_getRY

(

const Ellipse_t *

e

)

Returns the value of the "ry" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure whose ry is sought.

Returns

the value of the "ry" element of this Ellipse_t as a RelAbsVector_t.

int Ellipse_hasRequiredAttributes

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if all the required attributes for this Ellipse_t object have been set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) to indicate that all the required attributes of this Ellipse_t have been set, otherwise 0 (false) is returned.

int Ellipse_isSetCX

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if this Ellipse_t's "cx" element is set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) if this Ellipse_t's "cx" element has been set, otherwise 0 (false) is returned.

int Ellipse_isSetCY

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if this Ellipse_t's "cy" element is set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) if this Ellipse_t's "cy" element has been set, otherwise 0 (false) is returned.

int Ellipse_isSetCZ

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if this Ellipse_t's "cz" element is set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) if this Ellipse_t's "cz" element has been set, otherwise 0 (false) is returned.

int Ellipse_isSetRatio

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if this Ellipse_t's "ratio" attribute is set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) if this Ellipse_t's "ratio" attribute has been set, otherwise 0 (false) is returned.

int Ellipse_isSetRX

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if this Ellipse_t's "rx" element is set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) if this Ellipse_t's "rx" element has been set, otherwise 0 (false) is returned.

int Ellipse_isSetRY

(

const Ellipse_t *

e

)

Predicate returning 1 (true) if this Ellipse_t's "ry" element is set.

Parameters

e	the Ellipse_t structure.

Returns

1 (true) if this Ellipse_t's "ry" element has been set, otherwise 0 (false) is returned.

int Ellipse_setCX	(	Ellipse_t *	e,
		const RelAbsVector_t *	cx
	)

Sets the value of the "cx" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.
cx	RelAbsVector_t&_t value of the "cx" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int Ellipse_setCY	(	Ellipse_t *	e,
		const RelAbsVector_t &	cy
	)

Sets the value of the "cy" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.
cy	RelAbsVector_t& value of the "cy" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int Ellipse_setCZ	(	Ellipse_t *	e,
		const RelAbsVector_t &	cz
	)

Sets the value of the "cz" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.
cz	RelAbsVector_t& value of the "cz" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int Ellipse_setRatio	(	Ellipse_t *	e,
		double	ratio
	)

Sets the value of the "ratio" attribute of this Ellipse_t.

Parameters

e	the Ellipse_t structure.
ratio	double value of the "ratio" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int Ellipse_setRX	(	Ellipse_t *	e,
		const RelAbsVector_t &	rx
	)

Sets the value of the "rx" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.
rx	RelAbsVector_t& value of the "rx" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int Ellipse_setRY	(	Ellipse_t *	e,
		const RelAbsVector_t &	ry
	)

Sets the value of the "ry" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.
ry	RelAbsVector_t& value of the "ry" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int Ellipse_unsetCX

(

Ellipse_t *

e

)

Unsets the value of the "cx" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int Ellipse_unsetCY

(

Ellipse_t *

e

)

Unsets the value of the "cy" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int Ellipse_unsetCZ

(

Ellipse_t *

e

)

Unsets the value of the "cz" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int Ellipse_unsetRatio

(

Ellipse_t *

e

)

Unsets the value of the "ratio" attribute of this Ellipse_t.

Parameters

e	the Ellipse_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int Ellipse_unsetRX

(

Ellipse_t *

e

)

Unsets the value of the "rx" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT

int Ellipse_unsetRY

(

Ellipse_t *

e

)

Unsets the value of the "ry" element of this Ellipse_t.

Parameters

e	the Ellipse_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT