GraphicalPrimitive1D_t Class Reference

Detailed Description

render Base class for graphical primitives implementing 1D attributes.

The GraphicalPrimitive1D_t class implements attributes and methods necessary for 1D objects like lines. The attributes that are implemented are a stroke color, a stroke width and a stroke dasharray for dashed line drawing. Additionally, this class adds an id attribute with which all graphical primitives can be referenced.

The GraphicalPrimitive1D_t class is derived from Transformation2D_t and inherits all its methods and attributes.

Public Member Functions
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_clone (const GraphicalPrimitive1D_t *gpd)
	Creates and returns a deep copy of this GraphicalPrimitive1D_t object. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createEllipse (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Ellipse_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createLineEnding (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new LineEnding_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createPolygon (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Polygon_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createRectangle (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Rectangle_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createRenderCurve (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new RenderCurve_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createRenderGroup (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new RenderGroup_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
GraphicalPrimitive1D_t *	GraphicalPrimitive1D_createText (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Text_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version. More...
void	GraphicalPrimitive1D_free (GraphicalPrimitive1D_t *gpd)
	Frees this GraphicalPrimitive1D_t object. More...
char *	GraphicalPrimitive1D_getId (const GraphicalPrimitive1D_t *gpd)
	Returns the value of the "id" attribute of this GraphicalPrimitive1D_t. More...
char *	GraphicalPrimitive1D_getStroke (const GraphicalPrimitive1D_t *gpd)
	Returns the value of the "stroke" attribute of this GraphicalPrimitive1D_t. More...
double	GraphicalPrimitive1D_getStrokeWidth (const GraphicalPrimitive1D_t *gpd)
	Returns the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_hasRequiredAttributes (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 (true) if all the required attributes for this GraphicalPrimitive1D_t object have been set. More...
int	GraphicalPrimitive1D_isEllipse (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type Ellipse_t. More...
int	GraphicalPrimitive1D_isLineEnding (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type LineEnding_t. More...
int	GraphicalPrimitive1D_isPolygon (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type Polygon_t. More...
int	GraphicalPrimitive1D_isRectangle (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type Rectangle_t. More...
int	GraphicalPrimitive1D_isRenderCurve (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type RenderCurve_t. More...
int	GraphicalPrimitive1D_isRenderGroup (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type RenderGroup_t. More...
int	GraphicalPrimitive1D_isSetId (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "id" attribute is set. More...
int	GraphicalPrimitive1D_isSetStroke (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "stroke" attribute is set. More...
int	GraphicalPrimitive1D_isSetStrokeDashArray (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "stroke-dasharray" attribute is set. More...
int	GraphicalPrimitive1D_isSetStrokeWidth (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "stroke-width" attribute is set. More...
int	GraphicalPrimitive1D_isText (const GraphicalPrimitive1D_t *gpd)
	Predicate returning 1 if this GraphicalPrimitive1D_t is of type Text_t. More...
int	GraphicalPrimitive1D_setId (GraphicalPrimitive1D_t *gpd, const char *id)
	Sets the value of the "id" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_setStroke (GraphicalPrimitive1D_t *gpd, const char *stroke)
	Sets the value of the "stroke" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_setStrokeDashArray (GraphicalPrimitive1D_t *gpd, const char *strokeDash)
	Sets the value of the "stroke-dasharray" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_setStrokeWidth (GraphicalPrimitive1D_t *gpd, double strokeWidth)
	Sets the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_unsetId (GraphicalPrimitive1D_t *gpd)
	Unsets the value of the "id" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_unsetStroke (GraphicalPrimitive1D_t *gpd)
	Unsets the value of the "stroke" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_unsetStrokeDashArray (GraphicalPrimitive1D_t *gpd)
	Unsets the value of the "stroke-dasharray" attribute of this GraphicalPrimitive1D_t. More...
int	GraphicalPrimitive1D_unsetStrokeWidth (GraphicalPrimitive1D_t *gpd)
	Unsets the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t. More...

Member Function Documentation

GraphicalPrimitive1D_t * GraphicalPrimitive1D_clone

(

const GraphicalPrimitive1D_t *

gpd

)

Creates and returns a deep copy of this GraphicalPrimitive1D_t object.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

a (deep) copy of this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createEllipse	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createLineEnding	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new LineEnding_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createPolygon	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new Polygon_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createRectangle	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new Rectangle_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createRenderCurve	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new RenderCurve_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createRenderGroup	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new RenderGroup_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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.

GraphicalPrimitive1D_t * GraphicalPrimitive1D_createText	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new Text_t (GraphicalPrimitive1D_t) using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this GraphicalPrimitive1D_t.
version	an unsigned int, the SBML Version to assign to this GraphicalPrimitive1D_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GraphicalPrimitive1D_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 GraphicalPrimitive1D_free

(

GraphicalPrimitive1D_t *

gpd

)

Frees this GraphicalPrimitive1D_t object.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

char * GraphicalPrimitive1D_getId

(

const GraphicalPrimitive1D_t *

gpd

)

Returns the value of the "id" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure whose id is sought.

Returns

the value of the "id" attribute of this GraphicalPrimitive1D_t as a pointer to a string.

Warning

The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

char * GraphicalPrimitive1D_getStroke

(

const GraphicalPrimitive1D_t *

gpd

)

Returns the value of the "stroke" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure whose stroke is sought.

Returns

the value of the "stroke" attribute of this GraphicalPrimitive1D_t as a pointer to a string.

Warning

The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

double GraphicalPrimitive1D_getStrokeWidth

(

const GraphicalPrimitive1D_t *

gpd

)

Returns the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure whose stroke-width is sought.

Returns

the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t as a double.

int GraphicalPrimitive1D_hasRequiredAttributes

(

const GraphicalPrimitive1D_t *

gpd

)

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

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

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

int GraphicalPrimitive1D_isEllipse

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type Ellipse_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type Ellipse_t, 0 otherwise

int GraphicalPrimitive1D_isLineEnding

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type LineEnding_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type LineEnding_t, 0 otherwise

int GraphicalPrimitive1D_isPolygon

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type Polygon_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type Polygon_t, 0 otherwise

int GraphicalPrimitive1D_isRectangle

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type Rectangle_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type Rectangle_t, 0 otherwise

int GraphicalPrimitive1D_isRenderCurve

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type RenderCurve_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type RenderCurve_t, 0 otherwise

int GraphicalPrimitive1D_isRenderGroup

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type RenderGroup_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type RenderGroup_t, 0 otherwise

int GraphicalPrimitive1D_isSetId

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "id" attribute is set.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

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

int GraphicalPrimitive1D_isSetStroke

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "stroke" attribute is set.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

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

int GraphicalPrimitive1D_isSetStrokeDashArray

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "stroke-dasharray" attribute is set.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 (true) if this GraphicalPrimitive1D_t's "stroke-dasharray" attribute has been set, otherwise 0 (false) is returned.

int GraphicalPrimitive1D_isSetStrokeWidth

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 (true) if this GraphicalPrimitive1D_t's "stroke-width" attribute is set.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 (true) if this GraphicalPrimitive1D_t's "stroke-width" attribute has been set, otherwise 0 (false) is returned.

int GraphicalPrimitive1D_isText

(

const GraphicalPrimitive1D_t *

gpd

)

Predicate returning 1 if this GraphicalPrimitive1D_t is of type Text_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.

Returns

1 if this GraphicalPrimitive1D_t is of type Text_t, 0 otherwise

int GraphicalPrimitive1D_setId	(	GraphicalPrimitive1D_t *	gpd,
		const char *	id
	)

Sets the value of the "id" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.
id	const char * value of the "id" 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

Calling this function with id = NULL or an empty string is equivalent to calling GraphicalPrimitive1D_unsetId().

int GraphicalPrimitive1D_setStroke	(	GraphicalPrimitive1D_t *	gpd,
		const char *	stroke
	)

Sets the value of the "stroke" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.
stroke	const char * value of the "stroke" 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_OBJECT

Calling this function with stroke = NULL or an empty string is equivalent to calling GraphicalPrimitive1D_unsetStroke().

int GraphicalPrimitive1D_setStrokeDashArray	(	GraphicalPrimitive1D_t *	gpd,
		const char *	strokeDash
	)

Sets the value of the "stroke-dasharray" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.
strokeDash	pointer value of the "stroke-dasharray" 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

int GraphicalPrimitive1D_setStrokeWidth	(	GraphicalPrimitive1D_t *	gpd,
		double	strokeWidth
	)

Sets the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_t structure.
strokeWidth	double value of the "stroke-width" 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 GraphicalPrimitive1D_unsetId

(

GraphicalPrimitive1D_t *

gpd

)

Unsets the value of the "id" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_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 GraphicalPrimitive1D_unsetStroke

(

GraphicalPrimitive1D_t *

gpd

)

Unsets the value of the "stroke" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_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 GraphicalPrimitive1D_unsetStrokeDashArray

(

GraphicalPrimitive1D_t *

gpd

)

Unsets the value of the "stroke-dasharray" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_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 GraphicalPrimitive1D_unsetStrokeWidth

(

GraphicalPrimitive1D_t *

gpd

)

Unsets the value of the "stroke-width" attribute of this GraphicalPrimitive1D_t.

Parameters

gpd	the GraphicalPrimitive1D_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