MemberConstraint (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.MemberConstraint

public class MemberConstraint
extends SBase

Constructor Summary

Constructors
Constructor and Description
`MemberConstraint()` Creates a new MemberConstraint with the given level, version, and package version.
`MemberConstraint(GroupsPkgNamespaces groupsns)` Creates a new MemberConstraint with the given `GroupsPkgNamespaces` object.
`MemberConstraint(long level)` Creates a new MemberConstraint with the given level, version, and package version.
`MemberConstraint(long level, long version)` Creates a new MemberConstraint with the given level, version, and package version.
`MemberConstraint(long level, long version, long pkgVersion)` Creates a new MemberConstraint with the given level, version, and package version.
`MemberConstraint(MemberConstraint orig)` Copy constructor for MemberConstraint.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MemberConstraint`	`cloneObject()` Creates and returns a deep copy of this MemberConstraint object.
`void`	`delete()` Explicitly deletes the underlying native object.
`java.lang.String`	`getDistinctAttribute()` Returns the value of the 'distinctAttribute' attribute of this MemberConstraint.
`java.lang.String`	`getElementName()` Returns the XML element name of this object, which for MemberConstraint, is always `'memberConstraint'.`
`java.lang.String`	`getId()` Returns the value of the 'id' attribute of this MemberConstraint.
`java.lang.String`	`getIdenticalAttribute()` Returns the value of the 'identicalAttribute' attribute of this MemberConstraint.
`java.lang.String`	`getName()` Returns the value of the 'name' attribute of this MemberConstraint.
`int`	`getTypeCode()` Returns the libSBML type code for this SBML object.
`boolean`	`hasRequiredAttributes()` Predicate returning `true` if all the required attributes for this MemberConstraint object have been set.
`boolean`	`isSetDistinctAttribute()` Predicate returning `true` or `false` depending on whether this MemberConstraint's 'distinctAttribute' attribute has been set.
`boolean`	`isSetId()` Predicate returning `true` or `false` depending on whether this MemberConstraint's 'id' attribute has been set.
`boolean`	`isSetIdenticalAttribute()` Predicate returning `true` or `false` depending on whether this MemberConstraint's 'identicalAttribute' attribute has been set.
`boolean`	`isSetName()` Predicate returning `true` or `false` depending on whether this MemberConstraint's 'name' attribute has been set.
`int`	`setDistinctAttribute(java.lang.String distinctAttribute)` Sets the value of the 'distinctAttribute' attribute of this MemberConstraint.
`int`	`setId(java.lang.String id)` Sets the value of the 'id' attribute of this MemberConstraint.
`int`	`setIdenticalAttribute(java.lang.String identicalAttribute)` Sets the value of the 'identicalAttribute' attribute of this MemberConstraint.
`int`	`setName(java.lang.String name)` Sets the value of the 'name' attribute of this MemberConstraint.
`int`	`unsetDistinctAttribute()` Unsets the value of the 'distinctAttribute' attribute of this MemberConstraint.
`int`	`unsetId()` Unsets the value of the 'id' attribute of this MemberConstraint.
`int`	`unsetIdenticalAttribute()` Unsets the value of the 'identicalAttribute' attribute of this MemberConstraint.
`int`	`unsetName()` Unsets the value of the 'name' attribute of this MemberConstraint.

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MemberConstraint
```
public MemberConstraint(long level,
                        long version,
                        long pkgVersion)
                 throws SBMLConstructorException
```
    Creates a new MemberConstraint with the given level, version, and package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this MemberConstraint
    
    version - a long integer, the SBML Version to assign to this MemberConstraint
    
    pkgVersion - a long integer, the SBML Groups Version to assign to this MemberConstraint
    
    Throws:
    
    SBMLConstructorException
  - MemberConstraint
```
public MemberConstraint(long level,
                        long version)
                 throws SBMLConstructorException
```
    Creates a new MemberConstraint with the given level, version, and package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this MemberConstraint
    
    version - a long integer, the SBML Version to assign to this MemberConstraint
    
    pkgVersion - a long integer, the SBML Groups Version to assign to this MemberConstraint
    
    Throws:
    
    SBMLConstructorException
  - MemberConstraint
```
public MemberConstraint(long level)
                 throws SBMLConstructorException
```
    Creates a new MemberConstraint with the given level, version, and package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this MemberConstraint
    
    version - a long integer, the SBML Version to assign to this MemberConstraint
    
    pkgVersion - a long integer, the SBML Groups Version to assign to this MemberConstraint
    
    Throws:
    
    SBMLConstructorException
  - MemberConstraint
```
public MemberConstraint()
                 throws SBMLConstructorException
```
    Creates a new MemberConstraint with the given level, version, and package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this MemberConstraint
    
    version - a long integer, the SBML Version to assign to this MemberConstraint
    
    pkgVersion - a long integer, the SBML Groups Version to assign to this MemberConstraint
    
    Throws:
    
    SBMLConstructorException
  - MemberConstraint
```
public MemberConstraint(GroupsPkgNamespaces groupsns)
                 throws SBMLConstructorException
```
    Creates a new MemberConstraint with the given GroupsPkgNamespaces object.
    
    Parameters:
    
    groupsns - the GroupsPkgNamespaces object
    
    Throws:
    
    SBMLConstructorException
  - MemberConstraint
```
public MemberConstraint(MemberConstraint orig)
                 throws SBMLConstructorException
```
    Copy constructor for MemberConstraint.
    
    Parameters:
    
    orig - the MemberConstraint instance to copy.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the MemberConstraint.delete() method on the libSBML object.
    This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke MemberConstraint.delete() themselves.
    
    Overrides:
    
    delete in class SBase
  - cloneObject
```
public MemberConstraint cloneObject()
```
    Creates and returns a deep copy of this MemberConstraint object.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this MemberConstraint object.
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this MemberConstraint.
    
    Overrides:
    
    getId in class SBase
    
    Returns:
    
    the value of the 'id' attribute of this MemberConstraint as a string.
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true or false depending on whether this MemberConstraint's 'id' attribute has been set.
    
    Overrides:
    
    isSetId in class SBase
    
    Returns:
    
    true if this MemberConstraint's 'id' attribute has been set, otherwise false is returned.
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this MemberConstraint.
    Overrides:
    
    setId in class SBase
    
    Parameters:
    
    id - String value of the 'id' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this MemberConstraint.
    Overrides:
    
    unsetId in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - getName
```
public java.lang.String getName()
```
    Returns the value of the 'name' attribute of this MemberConstraint.
    
    Overrides:
    
    getName in class SBase
    
    Returns:
    
    the value of the 'name' attribute of this MemberConstraint as a string.
  - isSetName
```
public boolean isSetName()
```
    Predicate returning true or false depending on whether this MemberConstraint's 'name' attribute has been set.
    
    Overrides:
    
    isSetName in class SBase
    
    Returns:
    
    true if this MemberConstraint's 'name' attribute has been set, otherwise false is returned.
  - setName
```
public int setName(java.lang.String name)
```
    Sets the value of the 'name' attribute of this MemberConstraint.
    Overrides:
    
    setName in class SBase
    
    Parameters:
    
    name - String value of the 'name' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetName
```
public int unsetName()
```
    Unsets the value of the 'name' attribute of this MemberConstraint.
    Overrides:
    
    unsetName in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - getDistinctAttribute
```
public java.lang.String getDistinctAttribute()
```
    Returns the value of the 'distinctAttribute' attribute of this MemberConstraint.
    
    Returns:
    
    the value of the 'distinctAttribute' attribute of this MemberConstraint as a string.
  - isSetDistinctAttribute
```
public boolean isSetDistinctAttribute()
```
    Predicate returning true or false depending on whether this MemberConstraint's 'distinctAttribute' attribute has been set.
    
    Returns:
    
    true if this MemberConstraint's 'distinctAttribute' attribute has been set, otherwise false is returned.
  - setDistinctAttribute
```
public int setDistinctAttribute(java.lang.String distinctAttribute)
```
    Sets the value of the 'distinctAttribute' attribute of this MemberConstraint.
    Parameters:
    
    distinctAttribute - String value of the 'distinctAttribute' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetDistinctAttribute
```
public int unsetDistinctAttribute()
```
    Unsets the value of the 'distinctAttribute' attribute of this MemberConstraint.
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - getIdenticalAttribute
```
public java.lang.String getIdenticalAttribute()
```
    Returns the value of the 'identicalAttribute' attribute of this MemberConstraint.
    
    Returns:
    
    the value of the 'identicalAttribute' attribute of this MemberConstraint as a string.
  - isSetIdenticalAttribute
```
public boolean isSetIdenticalAttribute()
```
    Predicate returning true or false depending on whether this MemberConstraint's 'identicalAttribute' attribute has been set.
    
    Returns:
    
    true if this MemberConstraint's 'identicalAttribute' attribute has been set, otherwise false is returned.
  - setIdenticalAttribute
```
public int setIdenticalAttribute(java.lang.String identicalAttribute)
```
    Sets the value of the 'identicalAttribute' attribute of this MemberConstraint.
    Parameters:
    
    identicalAttribute - String value of the 'identicalAttribute' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetIdenticalAttribute
```
public int unsetIdenticalAttribute()
```
    Unsets the value of the 'identicalAttribute' attribute of this MemberConstraint.
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for MemberConstraint, is always 'memberConstraint'.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the name of this element, i.e. 'memberConstraint'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this SBML object.
    LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In other languages, the set of type codes is stored in an enumeration in the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. The names of the type codes all begin with the characters SBML_.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object, or SBML_UNKNOWN (default).
    
    See Also:
    
    MemberConstraint.getElementName()
  - hasRequiredAttributes
```
public boolean hasRequiredAttributes()
```
    Predicate returning true if all the required attributes for this MemberConstraint object have been set.
    
    Overrides:
    
    hasRequiredAttributes in class SBase
    
    Returns:
    
    a boolean value indicating whether all the required attributes for this object have been defined.
    
    "Note:"
    
    The required attributes for a MemberConstraint object are:

Class MemberConstraint

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

MemberConstraint

MemberConstraint

MemberConstraint

MemberConstraint

MemberConstraint

MemberConstraint

Method Detail

delete

cloneObject

getId

isSetId

setId

unsetId

getName

isSetName

setName

unsetName

getDistinctAttribute

isSetDistinctAttribute

setDistinctAttribute

unsetDistinctAttribute

getIdenticalAttribute

isSetIdenticalAttribute

setIdenticalAttribute

unsetIdenticalAttribute

getElementName

getTypeCode

hasRequiredAttributes