Compartment-class           package:rsbml           R Documentation

_S_B_M_L _t_y_p_e "_C_o_m_p_a_r_t_m_e_n_t"

_D_e_s_c_r_i_p_t_i_o_n:

     A bounded space that contains 'Species'.

_I_n_s_t_a_n_t_i_a_t_i_o_n:

     Objects can be created by calls of the form 'new("Compartment",
     ...)'.

_S_l_o_t_s:

     '_i_d': Object of class '"character"' uniquely identifying this
          component. 

     '_n_a_m_e': Object of class '"character"' naming this component. 

     '_s_p_a_t_i_a_l_D_i_m_e_n_s_i_o_n_s': Object of class '"integer"' indicating  the
          number of dimensions (0, 1, 2, or 3)

     '_s_i_z_e': Object of class '"numeric"' indicating the size in the
          given units. 

     '_u_n_i_t_s': Object of class '"character"' indicating the units
          (built-in or the id of a 'UnitDefinition'). 

     '_o_u_t_s_i_d_e': Object of class '"character"' identifying the
          compartment containing this compartment.

     '_c_o_n_s_t_a_n_t': Object of class '"logical"' indicating whether  the
          size changes during simulation.

     '_m_e_t_a_I_d': Object of class '"character"' that is an XML ID
          "described" by an RDF resource. This links an SBML element to
          an RDF resource. RDF may appear anywhere in an SBML element,
          but is usually placed inside the 'annotation' element.

     '_n_o_t_e_s': Object of class '"character"'  containing user-readable
          XHTML notes about an element. 

     '_a_n_n_o_t_a_t_i_o_n': Object of class '"character"' containing additional
          machine-readable information about an element, usually as
          RDF, such as BioPAX. This is where application-specific data
          belongs.

_E_x_t_e_n_d_s:

     Class '"SBase"', directly.

_M_e_t_h_o_d_s:

     _i_d 'signature(object = "Compartment")': gets the 'id' slot 

     _i_d<- 'signature(object = "Compartment")': sets the 'id' slot 

     _n_a_m_e 'signature(object = "Compartment")': gets the 'name' slot 

     _n_a_m_e<- 'signature(object = "Compartment")': sets the 'name' slot 

     _c_o_n_s_t_a_n_t 'signature(object = "Compartment")': gets the 'constant'
          slot 

     _c_o_n_s_t_a_n_t<- 'signature(object = "Compartment")': sets the
          'constant' slot 

     _o_u_t_s_i_d_e 'signature(object = "Compartment")': gets the 'outside'
          slot 

     _o_u_t_s_i_d_e<- 'signature(object = "Compartment")': sets the 'outside'
          slot 

     _s_i_z_e 'signature(object = "Compartment")': gets the 'size' slot 

     _s_i_z_e<- 'signature(object = "Compartment")': sets the 'size' slot 

     _u_n_i_t_s 'signature(object = "Compartment")': gets the 'constant'
          slot 

     _u_n_i_t_s<- 'signature(object = "Compartment")': sets the 'constant'
          slot 

     _s_p_a_t_i_a_l_D_i_m_e_n_s_i_o_n_s 'signature(object = "Compartment")': gets the
          'spatialDimensions' slot 

     _s_p_a_t_i_a_l_D_i_m_e_n_s_i_o_n_s<- 'signature(object = "Compartment")': sets the
          'spatialDimensions' slot 

_A_u_t_h_o_r(_s):

     Michael Lawrence

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://sbml.org/documents/>

