Detailed Description

render Abstract base class for local and global rendering information.

In the SBML Level 3 Render package, local and global render information representations share many attributes. These are implemented in this abstract base class. GlobalRenderInformation_t and LocalRenderInformation_t are the classes that are derived from this base class.

All render information objects have the following things in common:

a set of color definitions
a set of gradient definitions
a set of line endings

In addition to those, they share attributes for background color and some meta information as to which program created the render information etc.

Public Member Functions
int	RenderInformationBase_addColorDefinition (RenderInformationBase_t rib, const ColorDefinition_t cd)
	Adds a copy of the given ColorDefinition_t to this RenderInformationBase_t. More...

int	RenderInformationBase_addGradientDefinition (RenderInformationBase_t rib, const GradientBase_t gb)
	Adds a copy of the given GradientBase_t to this RenderInformationBase_t. More...

int	RenderInformationBase_addLineEnding (RenderInformationBase_t rib, const LineEnding_t le)
	Adds a copy of the given LineEnding_t to this RenderInformationBase_t. More...

RenderInformationBase_t *	RenderInformationBase_clone (const RenderInformationBase_t *rib)
	Creates and returns a deep copy of this RenderInformationBase_t object. More...

ColorDefinition_t *	RenderInformationBase_createColorDefinition (RenderInformationBase_t *rib)
	Creates a new ColorDefinition_t object, adds it to this RenderInformationBase_t object and returns the ColorDefinition_t object created. More...

RenderInformationBase_t *	RenderInformationBase_createGlobalRenderInformation (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new GlobalRenderInformation_t (RenderInformationBase_t) using the given SBML Level, Version and “render” package version. More...

LinearGradient_t *	RenderInformationBase_createLinearGradient (RenderInformationBase_t *rib)
	Creates a new LinearGradient_t object, adds it to this RenderInformationBase_t object and returns the LinearGradient_t object created. More...

LineEnding_t *	RenderInformationBase_createLineEnding (RenderInformationBase_t *rib)
	Creates a new LineEnding_t object, adds it to this RenderInformationBase_t object and returns the LineEnding_t object created. More...

RenderInformationBase_t *	RenderInformationBase_createLocalRenderInformation (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new LocalRenderInformation_t (RenderInformationBase_t) using the given SBML Level, Version and “render” package version. More...

RadialGradient_t *	RenderInformationBase_createRadialGradient (RenderInformationBase_t *rib)
	Creates a new RadialGradient_t object, adds it to this RenderInformationBase_t object and returns the RadialGradient_t object created. More...

void	RenderInformationBase_free (RenderInformationBase_t *rib)
	Frees this RenderInformationBase_t object. More...

char *	RenderInformationBase_getBackgroundColor (const RenderInformationBase_t *rib)
	Returns the value of the "backgroundColor" attribute of this RenderInformationBase_t. More...

ColorDefinition_t *	RenderInformationBase_getColorDefinition (RenderInformationBase_t *rib, unsigned int n)
	Get a ColorDefinition_t from the RenderInformationBase_t. More...

ColorDefinition_t *	RenderInformationBase_getColorDefinitionById (RenderInformationBase_t rib, const char sid)
	Get a ColorDefinition_t from the RenderInformationBase_t based on its identifier. More...

GradientBase_t *	RenderInformationBase_getGradientBaseById (RenderInformationBase_t rib, const char sid)
	Get a GradientBase_t from the RenderInformationBase_t based on its identifier. More...

GradientBase_t *	RenderInformationBase_getGradientDefinition (RenderInformationBase_t *rib, unsigned int n)
	Get a GradientBase_t from the RenderInformationBase_t. More...

char *	RenderInformationBase_getId (const RenderInformationBase_t *rib)
	Returns the value of the "id" attribute of this RenderInformationBase_t. More...

LineEnding_t *	RenderInformationBase_getLineEnding (RenderInformationBase_t *rib, unsigned int n)
	Get a LineEnding_t from the RenderInformationBase_t. More...

LineEnding_t *	RenderInformationBase_getLineEndingById (RenderInformationBase_t rib, const char sid)
	Get a LineEnding_t from the RenderInformationBase_t based on its identifier. More...

ListOf_t *	RenderInformationBase_getListOfColorDefinitions (RenderInformationBase_t *rib)
	Returns a ListOf_t * containing ColorDefinition_t objects from this RenderInformationBase_t. More...

ListOf_t *	RenderInformationBase_getListOfGradientDefinitions (RenderInformationBase_t *rib)
	Returns a ListOf_t * containing GradientBase_t objects from this RenderInformationBase_t. More...

ListOf_t *	RenderInformationBase_getListOfLineEndings (RenderInformationBase_t *rib)
	Returns a ListOf_t * containing LineEnding_t objects from this RenderInformationBase_t. More...

char *	RenderInformationBase_getName (const RenderInformationBase_t *rib)
	Returns the value of the "name" attribute of this RenderInformationBase_t. More...

unsigned int	RenderInformationBase_getNumColorDefinitions (RenderInformationBase_t *rib)
	Get the number of ColorDefinition_t objects in this RenderInformationBase_t. More...

unsigned int	RenderInformationBase_getNumGradientDefinitions (RenderInformationBase_t *rib)
	Get the number of GradientBase_t objects in this RenderInformationBase_t. More...

unsigned int	RenderInformationBase_getNumLineEndings (RenderInformationBase_t *rib)
	Get the number of LineEnding_t objects in this RenderInformationBase_t. More...

char *	RenderInformationBase_getProgramName (const RenderInformationBase_t *rib)
	Returns the value of the "programName" attribute of this RenderInformationBase_t. More...

char *	RenderInformationBase_getProgramVersion (const RenderInformationBase_t *rib)
	Returns the value of the "programVersion" attribute of this RenderInformationBase_t. More...

char *	RenderInformationBase_getReferenceRenderInformation (const RenderInformationBase_t *rib)
	Returns the value of the "referenceRenderInformation" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_hasRequiredAttributes (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if all the required attributes for this RenderInformationBase_t object have been set. More...

int	RenderInformationBase_isGlobalRenderInformation (const RenderInformationBase_t *rib)
	Predicate returning `1` if this RenderInformationBase_t is of type GlobalRenderInformation_t. More...

int	RenderInformationBase_isLocalRenderInformation (const RenderInformationBase_t *rib)
	Predicate returning `1` if this RenderInformationBase_t is of type LocalRenderInformation_t. More...

int	RenderInformationBase_isSetBackgroundColor (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if this RenderInformationBase_t's "backgroundColor" attribute is set. More...

int	RenderInformationBase_isSetId (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if this RenderInformationBase_t's "id" attribute is set. More...

int	RenderInformationBase_isSetName (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if this RenderInformationBase_t's "name" attribute is set. More...

int	RenderInformationBase_isSetProgramName (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if this RenderInformationBase_t's "programName" attribute is set. More...

int	RenderInformationBase_isSetProgramVersion (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if this RenderInformationBase_t's "programVersion" attribute is set. More...

int	RenderInformationBase_isSetReferenceRenderInformation (const RenderInformationBase_t *rib)
	Predicate returning `1` (true) if this RenderInformationBase_t's "referenceRenderInformation" attribute is set. More...

ColorDefinition_t *	RenderInformationBase_removeColorDefinition (RenderInformationBase_t *rib, unsigned int n)
	Removes the nth ColorDefinition_t from this RenderInformationBase_t and returns a pointer to it. More...

ColorDefinition_t *	RenderInformationBase_removeColorDefinitionById (RenderInformationBase_t rib, const char sid)
	Removes the ColorDefinition_t from this RenderInformationBase_t based on its identifier and returns a pointer to it. More...

GradientBase_t *	RenderInformationBase_removeGradientDefinition (RenderInformationBase_t *rib, unsigned int n)
	Removes the nth GradientBase_t from this RenderInformationBase_t and returns a pointer to it. More...

GradientBase_t *	RenderInformationBase_removeGradientDefinitionById (RenderInformationBase_t rib, const char sid)
	Removes the GradientBase_t from this RenderInformationBase_t based on its identifier and returns a pointer to it. More...

LineEnding_t *	RenderInformationBase_removeLineEnding (RenderInformationBase_t *rib, unsigned int n)
	Removes the nth LineEnding_t from this RenderInformationBase_t and returns a pointer to it. More...

LineEnding_t *	RenderInformationBase_removeLineEndingById (RenderInformationBase_t rib, const char sid)
	Removes the LineEnding_t from this RenderInformationBase_t based on its identifier and returns a pointer to it. More...

int	RenderInformationBase_setBackgroundColor (RenderInformationBase_t rib, const char backgroundColor)
	Sets the value of the "backgroundColor" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_setId (RenderInformationBase_t rib, const char id)
	Sets the value of the "id" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_setName (RenderInformationBase_t rib, const char name)
	Sets the value of the "name" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_setProgramName (RenderInformationBase_t rib, const char programName)
	Sets the value of the "programName" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_setProgramVersion (RenderInformationBase_t rib, const char programVersion)
	Sets the value of the "programVersion" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_setReferenceRenderInformation (RenderInformationBase_t rib, const char referenceRenderInformation)
	Sets the value of the "referenceRenderInformation" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_unsetBackgroundColor (RenderInformationBase_t *rib)
	Unsets the value of the "backgroundColor" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_unsetId (RenderInformationBase_t *rib)
	Unsets the value of the "id" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_unsetName (RenderInformationBase_t *rib)
	Unsets the value of the "name" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_unsetProgramName (RenderInformationBase_t *rib)
	Unsets the value of the "programName" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_unsetProgramVersion (RenderInformationBase_t *rib)
	Unsets the value of the "programVersion" attribute of this RenderInformationBase_t. More...

int	RenderInformationBase_unsetReferenceRenderInformation (RenderInformationBase_t *rib)
	Unsets the value of the "referenceRenderInformation" attribute of this RenderInformationBase_t. More...

Member Function Documentation

int RenderInformationBase_addColorDefinition	(	RenderInformationBase_t *	rib,
		const ColorDefinition_t *	cd
	)

Adds a copy of the given ColorDefinition_t to this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to which the ColorDefinition_t should be added.
cd	the ColorDefinition_t object to add.

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:

int RenderInformationBase_addGradientDefinition	(	RenderInformationBase_t *	rib,
		const GradientBase_t *	gb
	)

Adds a copy of the given GradientBase_t to this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to which the GradientBase_t should be added.
gb	the GradientBase_t object to add.

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:

int RenderInformationBase_addLineEnding	(	RenderInformationBase_t *	rib,
		const LineEnding_t *	le
	)

Adds a copy of the given LineEnding_t to this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to which the LineEnding_t should be added.
le	the LineEnding_t object to add.

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:

RenderInformationBase_t * RenderInformationBase_clone ( const RenderInformationBase_t * rib )

Creates and returns a deep copy of this RenderInformationBase_t object.

Parameters

rib	the RenderInformationBase_t structure.

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

ColorDefinition_t * RenderInformationBase_createColorDefinition ( RenderInformationBase_t * rib )

Creates a new ColorDefinition_t object, adds it to this RenderInformationBase_t object and returns the ColorDefinition_t object created.

Parameters

rib	the RenderInformationBase_t structure to which the ColorDefinition_t should be added.

Returns: a new ColorDefinition_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

RenderInformationBase_t * RenderInformationBase_createGlobalRenderInformation	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

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

LinearGradient_t * RenderInformationBase_createLinearGradient ( RenderInformationBase_t * rib )

Creates a new LinearGradient_t object, adds it to this RenderInformationBase_t object and returns the LinearGradient_t object created.

Parameters

rib	the RenderInformationBase_t structure to which the LinearGradient_t should be added.

Returns: a new LinearGradient_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

LineEnding_t * RenderInformationBase_createLineEnding ( RenderInformationBase_t * rib )

Creates a new LineEnding_t object, adds it to this RenderInformationBase_t object and returns the LineEnding_t object created.

Parameters

rib	the RenderInformationBase_t structure to which the LineEnding_t should be added.

Returns: a new LineEnding_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

RenderInformationBase_t * RenderInformationBase_createLocalRenderInformation	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

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

RadialGradient_t * RenderInformationBase_createRadialGradient ( RenderInformationBase_t * rib )

Creates a new RadialGradient_t object, adds it to this RenderInformationBase_t object and returns the RadialGradient_t object created.

Parameters

rib	the RenderInformationBase_t structure to which the RadialGradient_t should be added.

Returns: a new RadialGradient_t object instance.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

void RenderInformationBase_free ( RenderInformationBase_t * rib )

Frees this RenderInformationBase_t object.

Parameters

rib	the RenderInformationBase_t structure.

char * RenderInformationBase_getBackgroundColor ( const RenderInformationBase_t * rib )

Returns the value of the "backgroundColor" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose backgroundColor is sought.

Returns: the value of the "backgroundColor" attribute of this RenderInformationBase_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.

ColorDefinition_t * RenderInformationBase_getColorDefinition	(	RenderInformationBase_t *	rib,
		unsigned int	n
	)

Get a ColorDefinition_t from the RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to search.
n	an unsigned int representing the index of the ColorDefinition_t to retrieve.

Returns: the nth ColorDefinition_t in the ListOfColorDefinitions_t within this RenderInformationBase_t or NULL if no such object exists.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

ColorDefinition_t * RenderInformationBase_getColorDefinitionById	(	RenderInformationBase_t *	rib,
		const char *	sid
	)

Get a ColorDefinition_t from the RenderInformationBase_t based on its identifier.

Parameters

rib	the RenderInformationBase_t structure to search.
sid	a string representing the identifier of the ColorDefinition_t to retrieve.

Returns: the ColorDefinition_t in the ListOfColorDefinitions_t within this RenderInformationBase_t with the given sid or NULL if no such ColorDefinition_t exists.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

GradientBase_t * RenderInformationBase_getGradientBaseById	(	RenderInformationBase_t *	rib,
		const char *	sid
	)

Get a GradientBase_t from the RenderInformationBase_t based on its identifier.

Parameters

rib	the RenderInformationBase_t structure to search.
sid	a string representing the identifier of the GradientBase_t to retrieve.

Returns: the GradientBase_t in the ListOfGradientDefinitions_t within this RenderInformationBase_t with the given sid or NULL if no such GradientBase_t exists.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

GradientBase_t * RenderInformationBase_getGradientDefinition	(	RenderInformationBase_t *	rib,
		unsigned int	n
	)

Get a GradientBase_t from the RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to search.
n	an unsigned int representing the index of the GradientBase_t to retrieve.

Returns: the nth GradientBase_t in the ListOfGradientDefinitions_t within this RenderInformationBase_t or NULL if no such object exists.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

char * RenderInformationBase_getId ( const RenderInformationBase_t * rib )

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

Parameters

rib	the RenderInformationBase_t structure whose id is sought.

Returns: the value of the "id" attribute of this RenderInformationBase_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.

LineEnding_t * RenderInformationBase_getLineEnding	(	RenderInformationBase_t *	rib,
		unsigned int	n
	)

Get a LineEnding_t from the RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to search.
n	an unsigned int representing the index of the LineEnding_t to retrieve.

Returns: the nth LineEnding_t in the ListOfLineEndings_t within this RenderInformationBase_t or NULL if no such object exists.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

LineEnding_t * RenderInformationBase_getLineEndingById	(	RenderInformationBase_t *	rib,
		const char *	sid
	)

Get a LineEnding_t from the RenderInformationBase_t based on its identifier.

Parameters

rib	the RenderInformationBase_t structure to search.
sid	a string representing the identifier of the LineEnding_t to retrieve.

Returns: the LineEnding_t in the ListOfLineEndings_t within this RenderInformationBase_t with the given sid or NULL if no such LineEnding_t exists.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

ListOf_t * RenderInformationBase_getListOfColorDefinitions ( RenderInformationBase_t * rib )

Returns a ListOf_t * containing ColorDefinition_t objects from this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose ListOfColorDefinitions_t is sought.

Returns: the ListOfColorDefinitions_t from this RenderInformationBase_t as a ListOf_t *.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

See also: RenderInformationBase_addColorDefinition(); RenderInformationBase_createColorDefinition(); RenderInformationBase_getColorDefinitionById(); RenderInformationBase_getColorDefinition(); RenderInformationBase_getNumColorDefinitions(); RenderInformationBase_removeColorDefinitionById(); RenderInformationBase_removeColorDefinition()

ListOf_t * RenderInformationBase_getListOfGradientDefinitions ( RenderInformationBase_t * rib )

Returns a ListOf_t * containing GradientBase_t objects from this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose ListOfGradientDefinitions_t is sought.

Returns: the ListOfGradientDefinitions_t from this RenderInformationBase_t as a ListOf_t *.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

See also: RenderInformationBase_addGradientDefinition(); RenderInformationBase_createLinearGradientDefinition(); RenderInformationBase_createRadialGradientDefinition(); RenderInformationBase_getGradientDefinitionById(); RenderInformationBase_getGradientDefinition(); RenderInformationBase_getNumGradientDefinitions(); RenderInformationBase_removeGradientDefinitionById(); RenderInformationBase_removeGradientDefinition()

ListOf_t * RenderInformationBase_getListOfLineEndings ( RenderInformationBase_t * rib )

Returns a ListOf_t * containing LineEnding_t objects from this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose ListOfLineEndings_t is sought.

Returns: the ListOfLineEndings_t from this RenderInformationBase_t as a ListOf_t *.

Note: The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

See also: RenderInformationBase_addLineEnding(); RenderInformationBase_createLineEnding(); RenderInformationBase_getLineEndingById(); RenderInformationBase_getLineEnding(); RenderInformationBase_getNumLineEndings(); RenderInformationBase_removeLineEndingById(); RenderInformationBase_removeLineEnding()

char * RenderInformationBase_getName ( const RenderInformationBase_t * rib )

Returns the value of the "name" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose name is sought.

Returns: the value of the "name" attribute of this RenderInformationBase_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.

unsigned int RenderInformationBase_getNumColorDefinitions ( RenderInformationBase_t * rib )

Get the number of ColorDefinition_t objects in this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to query.

Returns: the number of ColorDefinition_t objects in this RenderInformationBase_t.

unsigned int RenderInformationBase_getNumGradientDefinitions ( RenderInformationBase_t * rib )

Get the number of GradientBase_t objects in this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to query.

Returns: the number of GradientBase_t objects in this RenderInformationBase_t.

unsigned int RenderInformationBase_getNumLineEndings ( RenderInformationBase_t * rib )

Get the number of LineEnding_t objects in this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure to query.

Returns: the number of LineEnding_t objects in this RenderInformationBase_t.

char * RenderInformationBase_getProgramName ( const RenderInformationBase_t * rib )

Returns the value of the "programName" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose programName is sought.

Returns: the value of the "programName" attribute of this RenderInformationBase_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 * RenderInformationBase_getProgramVersion ( const RenderInformationBase_t * rib )

Returns the value of the "programVersion" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose programVersion is sought.

Returns: the value of the "programVersion" attribute of this RenderInformationBase_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 * RenderInformationBase_getReferenceRenderInformation ( const RenderInformationBase_t * rib )

Returns the value of the "referenceRenderInformation" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure whose referenceRenderInformation is sought.

Returns: the value of the "referenceRenderInformation" attribute of this RenderInformationBase_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.

int RenderInformationBase_hasRequiredAttributes ( const RenderInformationBase_t * rib )

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

Parameters

rib	the RenderInformationBase_t structure.

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

Note

The required attributes for the RenderInformationBase_t object are:

"id"

int RenderInformationBase_isGlobalRenderInformation ( const RenderInformationBase_t * rib )

Predicate returning 1 if this RenderInformationBase_t is of type GlobalRenderInformation_t.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 if this RenderInformationBase_t is of type GlobalRenderInformation_t, 0 otherwise

int RenderInformationBase_isLocalRenderInformation ( const RenderInformationBase_t * rib )

Predicate returning 1 if this RenderInformationBase_t is of type LocalRenderInformation_t.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 if this RenderInformationBase_t is of type LocalRenderInformation_t, 0 otherwise

int RenderInformationBase_isSetBackgroundColor ( const RenderInformationBase_t * rib )

Predicate returning 1 (true) if this RenderInformationBase_t's "backgroundColor" attribute is set.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 (true) if this RenderInformationBase_t's "backgroundColor" attribute has been set, otherwise 0 (false) is returned.

int RenderInformationBase_isSetId ( const RenderInformationBase_t * rib )

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

Parameters

rib	the RenderInformationBase_t structure.

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

int RenderInformationBase_isSetName ( const RenderInformationBase_t * rib )

Predicate returning 1 (true) if this RenderInformationBase_t's "name" attribute is set.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 (true) if this RenderInformationBase_t's "name" attribute has been set, otherwise 0 (false) is returned.

int RenderInformationBase_isSetProgramName ( const RenderInformationBase_t * rib )

Predicate returning 1 (true) if this RenderInformationBase_t's "programName" attribute is set.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 (true) if this RenderInformationBase_t's "programName" attribute has been set, otherwise 0 (false) is returned.

int RenderInformationBase_isSetProgramVersion ( const RenderInformationBase_t * rib )

Predicate returning 1 (true) if this RenderInformationBase_t's "programVersion" attribute is set.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 (true) if this RenderInformationBase_t's "programVersion" attribute has been set, otherwise 0 (false) is returned.

int RenderInformationBase_isSetReferenceRenderInformation ( const RenderInformationBase_t * rib )

Predicate returning 1 (true) if this RenderInformationBase_t's "referenceRenderInformation" attribute is set.

Parameters

rib	the RenderInformationBase_t structure.

Returns: 1 (true) if this RenderInformationBase_t's "referenceRenderInformation" attribute has been set, otherwise 0 (false) is returned.

ColorDefinition_t * RenderInformationBase_removeColorDefinition	(	RenderInformationBase_t *	rib,
		unsigned int	n
	)

Removes the nth ColorDefinition_t from this RenderInformationBase_t and returns a pointer to it.

Parameters

rib	the RenderInformationBase_t structure to search.
n	an unsigned int representing the index of the ColorDefinition_t to remove.

Returns: a pointer to the nth ColorDefinition_t in this RenderInformationBase_t.

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.

ColorDefinition_t * RenderInformationBase_removeColorDefinitionById	(	RenderInformationBase_t *	rib,
		const char *	sid
	)

Removes the ColorDefinition_t from this RenderInformationBase_t based on its identifier and returns a pointer to it.

Parameters

rib	the RenderInformationBase_t structure to search.
sid	a string representing the identifier of the ColorDefinition_t to remove.

Returns: the ColorDefinition_t in this RenderInformationBase_t based on the identifier or NULL if no such ColorDefinition_t exists.

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.

GradientBase_t * RenderInformationBase_removeGradientDefinition	(	RenderInformationBase_t *	rib,
		unsigned int	n
	)

Removes the nth GradientBase_t from this RenderInformationBase_t and returns a pointer to it.

Parameters

rib	the RenderInformationBase_t structure to search.
n	an unsigned int representing the index of the GradientBase_t to remove.

Returns: a pointer to the nth GradientBase_t in this RenderInformationBase_t.

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.

GradientBase_t * RenderInformationBase_removeGradientDefinitionById	(	RenderInformationBase_t *	rib,
		const char *	sid
	)

Removes the GradientBase_t from this RenderInformationBase_t based on its identifier and returns a pointer to it.

Parameters

rib	the RenderInformationBase_t structure to search.
sid	a string representing the identifier of the GradientBase_t to remove.

Returns: the GradientBase_t in this RenderInformationBase_t based on the identifier or NULL if no such GradientBase_t exists.

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.

LineEnding_t * RenderInformationBase_removeLineEnding	(	RenderInformationBase_t *	rib,
		unsigned int	n
	)

Removes the nth LineEnding_t from this RenderInformationBase_t and returns a pointer to it.

Parameters

rib	the RenderInformationBase_t structure to search.
n	an unsigned int representing the index of the LineEnding_t to remove.

Returns: a pointer to the nth LineEnding_t in this RenderInformationBase_t.

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.

LineEnding_t * RenderInformationBase_removeLineEndingById	(	RenderInformationBase_t *	rib,
		const char *	sid
	)

Removes the LineEnding_t from this RenderInformationBase_t based on its identifier and returns a pointer to it.

Parameters

rib	the RenderInformationBase_t structure to search.
sid	a string representing the identifier of the LineEnding_t to remove.

Returns: the LineEnding_t in this RenderInformationBase_t based on the identifier or NULL if no such LineEnding_t exists.

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.

int RenderInformationBase_setBackgroundColor	(	RenderInformationBase_t *	rib,
		const char *	backgroundColor
	)

Sets the value of the "backgroundColor" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure.
backgroundColor	const char * value of the "backgroundColor" 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:

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

int RenderInformationBase_setId	(	RenderInformationBase_t *	rib,
		const char *	id
	)

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

Parameters

rib	the RenderInformationBase_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:

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

int RenderInformationBase_setName	(	RenderInformationBase_t *	rib,
		const char *	name
	)

Sets the value of the "name" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure.
name	const char * value of the "name" 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:

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

int RenderInformationBase_setProgramName	(	RenderInformationBase_t *	rib,
		const char *	programName
	)

Sets the value of the "programName" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure.
programName	const char * value of the "programName" 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:

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

int RenderInformationBase_setProgramVersion	(	RenderInformationBase_t *	rib,
		const char *	programVersion
	)

Sets the value of the "programVersion" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure.
programVersion	const char * value of the "programVersion" 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:

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

int RenderInformationBase_setReferenceRenderInformation	(	RenderInformationBase_t *	rib,
		const char *	referenceRenderInformation
	)

Sets the value of the "referenceRenderInformation" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_t structure.
referenceRenderInformation	const char * value of the "referenceRenderInformation" 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:

int RenderInformationBase_unsetBackgroundColor ( RenderInformationBase_t * rib )

Unsets the value of the "backgroundColor" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_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:

int RenderInformationBase_unsetId ( RenderInformationBase_t * rib )

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

Parameters

rib	the RenderInformationBase_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:

int RenderInformationBase_unsetName ( RenderInformationBase_t * rib )

Unsets the value of the "name" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_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:

int RenderInformationBase_unsetProgramName ( RenderInformationBase_t * rib )

Unsets the value of the "programName" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_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:

int RenderInformationBase_unsetProgramVersion ( RenderInformationBase_t * rib )

Unsets the value of the "programVersion" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_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:

int RenderInformationBase_unsetReferenceRenderInformation ( RenderInformationBase_t * rib )

Unsets the value of the "referenceRenderInformation" attribute of this RenderInformationBase_t.

Parameters

rib	the RenderInformationBase_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:

Detailed Description

Public Member Functions

Member Function Documentation