LocalStyle_t Class Reference

Detailed Description

render Style information object used in LocalRenderInformation_t.

Local styles are the style information objects used in LocalRenderInformation_t. Local styles can be associated with layout objects by role and type as well as by id of layout objects from the layout the local style belongs to.

Since LocalStyle_t is derived from Style_t, it inherits all of the methods and attributes from Style_t.

See also

LocalRenderInformation_t

Style_t

Public Member Functions
LocalStyle_t *	LocalStyle_clone (const LocalStyle_t *ls)
	Creates and returns a deep copy of this LocalStyle_t object. More...
LocalStyle_t *	LocalStyle_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new LocalStyle_t using the given SBML Level, Version and “render” package version. More...
void	LocalStyle_free (LocalStyle_t *ls)
	Frees this LocalStyle_t object. More...
int	LocalStyle_hasRequiredAttributes (const LocalStyle_t *ls)
	Unsets the value of the "idList" attribute of this LocalStyle_t. More...
int	LocalStyle_isSetIdList (const LocalStyle_t *ls)
	Returns the value of the "idList" attribute of this LocalStyle_t. More...
int	LocalStyle_setIdList (LocalStyle_t *ls, const char *idList)
	Sets the value of the "idList" attribute of this LocalStyle_t. More...

Member Function Documentation

LocalStyle_t * LocalStyle_clone

(

const LocalStyle_t *

ls

)

Creates and returns a deep copy of this LocalStyle_t object.

Parameters

ls	the LocalStyle_t structure.

Returns

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

LocalStyle_t * LocalStyle_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

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

(

LocalStyle_t *

ls

)

Frees this LocalStyle_t object.

Parameters

ls	the LocalStyle_t structure.

int LocalStyle_hasRequiredAttributes

(

const LocalStyle_t *

ls

)

Unsets the value of the "idList" attribute of this LocalStyle_t.

Parameters

ls	the LocalStyle_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 Predicate returning 1 (true) if all the required attributes for this LocalStyle_t object have been set.

Parameters

ls	the LocalStyle_t structure.

Returns

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

int LocalStyle_isSetIdList

(

const LocalStyle_t *

ls

)

Returns the value of the "idList" attribute of this LocalStyle_t.

Parameters

ls	the LocalStyle_t structure whose idList is sought.

Returns

the value of the "idList" attribute of this LocalStyle_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. Predicate returning 1 (true) if this LocalStyle_t's "idList" attribute is set.

Parameters

ls	the LocalStyle_t structure.

Returns

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

int LocalStyle_setIdList	(	LocalStyle_t *	ls,
		const char *	idList
	)

Sets the value of the "idList" attribute of this LocalStyle_t.

Parameters

ls	the LocalStyle_t structure.
idList	const char * value of the "idList" 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 idList = NULL or an empty string is equivalent to calling LocalStyle_unsetIdList().