libSBML C API  libSBML 5.8.0 C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ModelCreator.h File Reference

Detailed Description

ModelCreator I/O.

Author
Sarah Keating
Include dependency graph for ModelCreator.h:
This graph shows which files directly or indirectly include this file:

Functions

ModelCreator_t * ModelCreator_clone (const ModelCreator_t *c)
 Creates a deep copy of the given ModelCreator_t structure. More...
 
ModelCreator_t * ModelCreator_create ()
 Creates a new ModelCreator_t structure and returns a pointer to it. More...
 
ModelCreator_t * ModelCreator_createFromNode (const XMLNode_t *node)
 Creates a new ModelCreator_t structure from an XMLNode_t structure and returns a pointer to it. More...
 
void ModelCreator_free (ModelCreator_t *)
 Destroys this ModelCreator. More...
 
const char * ModelCreator_getEmail (ModelCreator_t *mc)
 Returns the email from the ModelCreator. More...
 
const char * ModelCreator_getFamilyName (ModelCreator_t *mc)
 Returns the familyName from the ModelCreator. More...
 
const char * ModelCreator_getGivenName (ModelCreator_t *mc)
 Returns the givenName from the ModelCreator. More...
 
const char * ModelCreator_getOrganisation (ModelCreator_t *mc)
 Returns the organization from the ModelCreator. More...
 
const char * ModelCreator_getOrganization (ModelCreator_t *mc)
 Returns the organization from the ModelCreator. More...
 
int ModelCreator_hasRequiredAttributes (ModelCreator_t *mc)
 
int ModelCreator_isSetEmail (ModelCreator_t *mc)
 Predicate indicating whether this ModelCreator's email is set. More...
 
int ModelCreator_isSetFamilyName (ModelCreator_t *mc)
 Predicate indicating whether this ModelCreator's familyName is set. More...
 
int ModelCreator_isSetGivenName (ModelCreator_t *mc)
 Predicate indicating whether this ModelCreator's givenName is set. More...
 
int ModelCreator_isSetOrganisation (ModelCreator_t *mc)
 Predicate indicating whether this ModelCreator's organization is set. More...
 
int ModelCreator_isSetOrganization (ModelCreator_t *mc)
 Predicate indicating whether this ModelCreator's organization is set. More...
 
int ModelCreator_setEmail (ModelCreator_t *mc, char *name)
 Sets the email. More...
 
int ModelCreator_setFamilyName (ModelCreator_t *mc, char *name)
 Sets the family name. More...
 
int ModelCreator_setGivenName (ModelCreator_t *mc, char *name)
 Sets the given name. More...
 
int ModelCreator_setOrganisation (ModelCreator_t *mc, char *org)
 Sets the organization. More...
 
int ModelCreator_setOrganization (ModelCreator_t *mc, char *name)
 Sets the organization. More...
 
int ModelCreator_unsetEmail (ModelCreator_t *mc)
 Unsets the email of this ModelCreator. More...
 
int ModelCreator_unsetFamilyName (ModelCreator_t *mc)
 Unsets the familyName of this ModelCreator. More...
 
int ModelCreator_unsetGivenName (ModelCreator_t *mc)
 Unsets the givenName of this ModelCreator. More...
 
int ModelCreator_unsetOrganisation (ModelCreator_t *mc)
 Unsets the organization of this ModelCreator. More...
 
int ModelCreator_unsetOrganization (ModelCreator_t *mc)
 Unsets the organization of this ModelCreator. More...
 

Function Documentation

ModelCreator_t* ModelCreator_clone ( const ModelCreator_t *  mc)

Creates a deep copy of the given ModelCreator_t structure.

Parameters
mcthe ModelCreator_t structure to be copied
Returns
a (deep) copy of the given ModelCreator_t structure.
ModelCreator_t* ModelCreator_create ( )

Creates a new ModelCreator_t structure and returns a pointer to it.

Returns
pointer to newly created ModelCreator_t structure.
ModelCreator_t* ModelCreator_createFromNode ( const XMLNode_t *  node)

Creates a new ModelCreator_t structure from an XMLNode_t structure and returns a pointer to it.

Returns
pointer to newly created ModelCreator_t structure.
void ModelCreator_free ( ModelCreator_t *  mc)

Destroys this ModelCreator.

Parameters
mcModelCreator_t structure to be freed.
const char* ModelCreator_getEmail ( ModelCreator_t *  mc)

Returns the email from the ModelCreator.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
email from the ModelCreator.
const char* ModelCreator_getFamilyName ( ModelCreator_t *  mc)

Returns the familyName from the ModelCreator.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
familyName from the ModelCreator.
const char* ModelCreator_getGivenName ( ModelCreator_t *  mc)

Returns the givenName from the ModelCreator.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
givenName from the ModelCreator.
const char* ModelCreator_getOrganisation ( ModelCreator_t *  mc)

Returns the organization from the ModelCreator.

Note
This function is an alias of ModelCreator_getOrganization().
Parameters
mcthe ModelCreator_t structure to be queried
Returns
organization from the ModelCreator.
const char* ModelCreator_getOrganization ( ModelCreator_t *  mc)

Returns the organization from the ModelCreator.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
organization from the ModelCreator.
int ModelCreator_hasRequiredAttributes ( ModelCreator_t *  mc)
int ModelCreator_isSetEmail ( ModelCreator_t *  mc)

Predicate indicating whether this ModelCreator's email is set.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
true (non-zero) if the email of this ModelCreator_t structure is set, false (0) otherwise.
int ModelCreator_isSetFamilyName ( ModelCreator_t *  mc)

Predicate indicating whether this ModelCreator's familyName is set.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
true (non-zero) if the familyName of this ModelCreator_t structure is set, false (0) otherwise.
int ModelCreator_isSetGivenName ( ModelCreator_t *  mc)

Predicate indicating whether this ModelCreator's givenName is set.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
true (non-zero) if the givenName of this ModelCreator_t structure is set, false (0) otherwise.
int ModelCreator_isSetOrganisation ( ModelCreator_t *  mc)

Predicate indicating whether this ModelCreator's organization is set.

Note
This function is an alias of ModelCretor_isSetOrganization().
Parameters
mcthe ModelCreator_t structure to be queried
Returns
true (non-zero) if the organization of this ModelCreator_t structure is set, false (0) otherwise.
int ModelCreator_isSetOrganization ( ModelCreator_t *  mc)

Predicate indicating whether this ModelCreator's organization is set.

Parameters
mcthe ModelCreator_t structure to be queried
Returns
true (non-zero) if the organization of this ModelCreator_t structure is set, false (0) otherwise.
int ModelCreator_setEmail ( ModelCreator_t *  mc,
char *  email 
)

Sets the email.

Parameters
mcthe ModelCreator_t structure
emaila string representing the email of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
int ModelCreator_setFamilyName ( ModelCreator_t *  mc,
char *  name 
)

Sets the family name.

Parameters
mcthe ModelCreator_t structure
namea string representing the familyName of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
int ModelCreator_setGivenName ( ModelCreator_t *  mc,
char *  name 
)

Sets the given name.

Parameters
mcthe ModelCreator_t structure
namea string representing the givenName of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
int ModelCreator_setOrganisation ( ModelCreator_t *  mc,
char *  org 
)

Sets the organization.

Parameters
mcthe ModelCreator_t structure
orga string representing the organisation of the ModelCreator.
Note
This function is an alias of ModelCretor_setOrganization().
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
int ModelCreator_setOrganization ( ModelCreator_t *  mc,
char *  org 
)

Sets the organization.

Parameters
mcthe ModelCreator_t structure
orga string representing the organisation of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_INVALID_OBJECT
int ModelCreator_unsetEmail ( ModelCreator_t *  mc)

Unsets the email of this ModelCreator.

Parameters
mcthe ModelCreator_t structure.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_OBJECT
int ModelCreator_unsetFamilyName ( ModelCreator_t *  mc)

Unsets the familyName of this ModelCreator.

Parameters
mcthe ModelCreator_t structure.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_OBJECT
int ModelCreator_unsetGivenName ( ModelCreator_t *  mc)

Unsets the givenName of this ModelCreator.

Parameters
mcthe ModelCreator_t structure.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_OBJECT
int ModelCreator_unsetOrganisation ( ModelCreator_t *  mc)

Unsets the organization of this ModelCreator.

Parameters
mcthe ModelCreator_t structure.
Note
This function is an alias of ModelCretor_unsetOrganization().
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_OBJECT
int ModelCreator_unsetOrganization ( ModelCreator_t *  mc)

Unsets the organization of this ModelCreator.

Parameters
mcthe ModelCreator_t structure.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
  • LIBSBML_INVALID_OBJECT