libNuML  1.1.1
Library for reading / writing NuML documents
NUMLTypeCodes.h File Reference

Go to the source code of this file.

Enumerations

enum  NUMLTypeCode_t {
  NUML_UNKNOWN, NUML_DOCUMENT, NUML_ONTOLOGYTERMS, NUML_ONTOLOGYTERM,
  NUML_RESULTCOMPONENT, NUML_RESULTCOMPONENTS, NUML_DIMENSION, NUML_DIMENSIONDESCRIPTION,
  NUML_COMPOSITEVALUE, NUML_COMPOSITEVALUES, NUML_TUPLE, NUML_TUPLES,
  NUML_ATOMICVALUE, NUML_ATOMICVALUES, NUML_COMPOSITEDESCRIPTION, NUML_TUPLEDESCRIPTION,
  NUML_ATOMICDESCRIPTION, NUML_NUMLLIST, NUML_CONSTRAINT
}
 An enumeration of NUML types to help identify NUML objects at runtime. More...
 

Functions

LIBNUML_EXTERN const char * NUMLTypeCode_toString (NUMLTypeCode_t tc)
 This method takes an NUML type code and returns a string representing the code. More...
 

Enumeration Type Documentation

◆ NUMLTypeCode_t

An enumeration of NUML types to help identify NUML objects at runtime.

Abstract types do not have a typecode since they cannot be instantiated.

Enumerator
NUML_UNKNOWN 
NUML_DOCUMENT 
NUML_ONTOLOGYTERMS 
NUML_ONTOLOGYTERM 
NUML_RESULTCOMPONENT 
NUML_RESULTCOMPONENTS 
NUML_DIMENSION 
NUML_DIMENSIONDESCRIPTION 
NUML_COMPOSITEVALUE 
NUML_COMPOSITEVALUES 
NUML_TUPLE 
NUML_TUPLES 
NUML_ATOMICVALUE 
NUML_ATOMICVALUES 
NUML_COMPOSITEDESCRIPTION 
NUML_TUPLEDESCRIPTION 
NUML_ATOMICDESCRIPTION 
NUML_NUMLLIST 
NUML_CONSTRAINT 

Function Documentation

◆ NUMLTypeCode_toString()

LIBNUML_EXTERN const char* NUMLTypeCode_toString ( NUMLTypeCode_t  tc)

This method takes an NUML type code and returns a string representing the code.

This method takes a type code as argument, and returns a string name corresponding to that code. For example, passing it the type code NUML_COMPARTMENT will return the string "<code>Compartment</code>".

Returns
a human readable name for the given NUMLTypeCode_t.
Note
The caller does not own the returned string and is therefore not allowed to modify it.
Returns
a human readable name for the given NUMLTypeCode_t. The caller does not own the returned string and is therefore not allowed to modify it.