.TH "globus_rsl_accessor" 3 "Fri Sep 2 2016" "Version 10.11" "globus_rsl" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_rsl_accessor \- RSL Accessor Functions
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_rsl_boolean_get_operator\fP (globus_rsl_t *ast_node)"
.br
.RI "\fIGet the RSL operator used in a boolean RSL composition\&. \fP"
.ti -1c
.RI "globus_list_t * \fBglobus_rsl_boolean_get_operand_list\fP (globus_rsl_t *ast_node)"
.br
.RI "\fIGet the RSL operand list from a boolean RSL composition\&. \fP"
.ti -1c
.RI "globus_list_t ** \fBglobus_rsl_boolean_get_operand_list_ref\fP (globus_rsl_t *boolean_node)"
.br
.RI "\fIGet a reference to the RSL operand list from a boolean RSL composition\&. \fP"
.ti -1c
.RI "char * \fBglobus_rsl_relation_get_attribute\fP (globus_rsl_t *ast_node)"
.br
.RI "\fIGet an RSL relation attribute name\&. \fP"
.ti -1c
.RI "int \fBglobus_rsl_relation_get_operator\fP (globus_rsl_t *ast_node)"
.br
.RI "\fIGet an RSL relation operator\&. \fP"
.ti -1c
.RI "globus_rsl_value_t * \fBglobus_rsl_relation_get_value_sequence\fP (globus_rsl_t *ast_node)"
.br
.RI "\fIGet the value of an RSL relation\&. \fP"
.ti -1c
.RI "globus_rsl_value_t * \fBglobus_rsl_relation_get_single_value\fP (globus_rsl_t *ast_node)"
.br
.RI "\fIGet the single value of an RSL relation\&. \fP"
.ti -1c
.RI "char * \fBglobus_rsl_value_literal_get_string\fP (globus_rsl_value_t *literal_node)"
.br
.RI "\fIGet the string value of an RSL literal\&. \fP"
.ti -1c
.RI "globus_list_t * \fBglobus_rsl_value_sequence_get_value_list\fP (globus_rsl_value_t *sequence_node)"
.br
.RI "\fIGet the value list from an RSL value sequence\&. \fP"
.ti -1c
.RI "globus_rsl_value_t * \fBglobus_rsl_value_variable_get_sequence\fP (globus_rsl_value_t *variable_node)"
.br
.RI "\fIGet the value sequence from an RSL variable reference\&. \fP"
.ti -1c
.RI "char * \fBglobus_rsl_value_variable_get_name\fP (globus_rsl_value_t *variable_node)"
.br
.RI "\fIGet the name of an RSL variable reference\&. \fP"
.ti -1c
.RI "char * \fBglobus_rsl_value_variable_get_default\fP (globus_rsl_value_t *variable_node)"
.br
.RI "\fIGet the default value of an RSL variable reference\&. \fP"
.ti -1c
.RI "int \fBglobus_rsl_value_variable_get_size\fP (globus_rsl_value_t *variable_node)"
.br
.RI "\fIGet the size of the value list within an RSL variable reference node\&. \fP"
.ti -1c
.RI "globus_rsl_value_t * \fBglobus_rsl_value_concatenation_get_left\fP (globus_rsl_value_t *concatenation_node)"
.br
.RI "\fIGet the left side of a concatenation value\&. \fP"
.ti -1c
.RI "globus_rsl_value_t * \fBglobus_rsl_value_concatenation_get_right\fP (globus_rsl_value_t *concatenation_node)"
.br
.RI "\fIGet the right side of a concatenation value\&. \fP"
.ti -1c
.RI "globus_list_t ** \fBglobus_rsl_value_sequence_get_list_ref\fP (globus_rsl_value_t *sequence_node)"
.br
.RI "\fIGet a reference to the list of values in a sequence\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "globus_list_t* globus_rsl_boolean_get_operand_list (globus_rsl_t * ast_node)"

.PP
Get the RSL operand list from a boolean RSL composition\&. The \fBglobus_rsl_boolean_get_operand_list()\fP function returns the list of RSL syntax tree nodes that is joined by a boolean composition\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP The RSL syntax tree to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_boolean_get_operand_list()\fP returns a pointer to a list of RSL syntax tree nodes that are the operand of a boolean composition operation\&. If an error occurs, \fBglobus_rsl_boolean_get_operand_list()\fP returns NULL\&. 
.RE
.PP

.SS "globus_list_t** globus_rsl_boolean_get_operand_list_ref (globus_rsl_t * boolean_node)"

.PP
Get a reference to the RSL operand list from a boolean RSL composition\&. The \fBglobus_rsl_boolean_get_operand_list_ref()\fP function returns a pointer to the list of RSL syntax tree nodes that is joined by a boolean composition\&. If this list is modified, then the value of boolean syntax tree is modified\&.
.PP
\fBParameters:\fP
.RS 4
\fIboolean_node\fP The RSL syntax tree to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_boolean_get_operand_list_ref()\fP returns a pointer to the list pointer in the RSL syntax tree data structure\&. This list can be modified to change the oprands of the boolean operation\&. If an error occurs, \fBglobus_rsl_boolean_get_operand_list_ref()\fP returns NULL\&. 
.RE
.PP

.SS "int globus_rsl_boolean_get_operator (globus_rsl_t * ast_node)"

.PP
Get the RSL operator used in a boolean RSL composition\&. The \fBglobus_rsl_boolean_get_operator()\fP function returns the operator that is used by the boolean RSL composition\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP The RSL syntax tree to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_boolean_get_operator()\fP returns one of GLOBUS_RSL_AND, GLOBUS_RSL_OR, GLOBUS_RSL_MULTIREQ\&. If an error occurs, \fBglobus_rsl_boolean_get_operator()\fP returns -1\&. 
.RE
.PP

.SS "char* globus_rsl_relation_get_attribute (globus_rsl_t * ast_node)"

.PP
Get an RSL relation attribute name\&. The \fBglobus_rsl_relation_get_attribute()\fP function returns a pointer to the name of the attribute in an RSL relation\&. This return value is a shallow reference to the attribute name\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP The RSL relation node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_relation_get_attribute()\fP returns a pointer to the name of the attribute of the relation\&. If an error occurs, \fBglobus_rsl_relation_get_attribute()\fP returns NULL\&. 
.RE
.PP

.SS "int globus_rsl_relation_get_operator (globus_rsl_t * ast_node)"

.PP
Get an RSL relation operator\&. The \fBglobus_rsl_relation_get_operator()\fP function returns the operation type represented by the RSL relation node pointed to by the \fIast_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP The RSL relation node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_relation_get_operator()\fP returns one of GLOBUS_RSL_EQ, GLOBUS_RSL_NEQ, GLOBUS_RSL_GT, GLOBUS_RSL_GTEQ, GLOBUS_RSL_LT, or GLOBUS_RSL_LTEQ\&. If an error occurs, \fBglobus_rsl_relation_get_operator()\fP returns -1\&. 
.RE
.PP

.SS "globus_rsl_value_t* globus_rsl_relation_get_single_value (globus_rsl_t * ast_node)"

.PP
Get the single value of an RSL relation\&. The \fBglobus_rsl_relation_get_single_value()\fP function returns the value of an RSL relation node pointed to by the \fIast_node\fP parameter if the value is a sequence of one value\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP The RSL relation node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_relation_get_single_value()\fP returns the value pointer at the head of the RSL relation pointed to by the \fIast_node\fP parameter\&. If the value sequence has more than one value or the \fIast_node\fP points to an RSL syntax tree that is not a relation, \fBglobus_rsl_relation_get_value_sequence()\fP returns NULL\&. 
.RE
.PP

.SS "globus_rsl_value_t* globus_rsl_relation_get_value_sequence (globus_rsl_t * ast_node)"

.PP
Get the value of an RSL relation\&. The \fBglobus_rsl_relation_get_value_sequence()\fP function returns the value of an RSL relation node pointed to by the \fIast_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP The RSL relation node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_relation_get_value_sequence()\fP returns the value sequence pointer in the RSL relation pointed to by the \fIast_node\fP parameter\&. If an error occurs, \fBglobus_rsl_relation_get_value_sequence()\fP returns NULL\&. 
.RE
.PP

.SS "globus_rsl_value_t* globus_rsl_value_concatenation_get_left (globus_rsl_value_t * concatenation_node)"

.PP
Get the left side of a concatenation value\&. The \fBglobus_rsl_value_concatenation_get_left()\fP function returns the left side of an RSL value concatenation pointed to by the \fIconcatenation_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIconcatenation_node\fP The RSL concatenation node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_concatenation_get_left()\fP returns a pointer to the left value of the concatenation values pointed to by the \fIconcatenation_node\fP parameter\&. If an error occurs, \fBglobus_rsl_value_concatenation_get_left()\fP returns NULL\&. 
.RE
.PP

.SS "globus_rsl_value_t* globus_rsl_value_concatenation_get_right (globus_rsl_value_t * concatenation_node)"

.PP
Get the right side of a concatenation value\&. The \fBglobus_rsl_value_concatenation_get_right()\fP function returns the right side of an RSL value concatenation pointed to by the \fIconcatenation_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIconcatenation_node\fP The RSL concatenation node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_concatenation_get_right()\fP returns a pointer to the right value of the concatenation values pointed to by the \fIconcatenation_node\fP parameter\&. If an error occurs, \fBglobus_rsl_value_concatenation_get_right()\fP returns NULL\&. 
.RE
.PP

.SS "char* globus_rsl_value_literal_get_string (globus_rsl_value_t * literal_node)"

.PP
Get the string value of an RSL literal\&. The \fBglobus_rsl_value_literal_get_string()\fP function returns the string value of an RSL literal node pointed to by the \fIliteral_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIliteral_node\fP The RSL literal node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_literal_get_string()\fP returns a pointer to the string value of the literal pointed to by the \fIliteral_node\fP parameter\&. If the value is not a literal, \fBglobus_rsl_value_literal_get_string()\fP returns NULL\&. 
.RE
.PP

.SS "globus_list_t** globus_rsl_value_sequence_get_list_ref (globus_rsl_value_t * sequence_node)"

.PP
Get a reference to the list of values in a sequence\&. The \fBglobus_rsl_value_sequence_get_list_ref()\fP function returns a reference to the list of values in a value sequence\&. Any changes to the elements of this list will affect the \fIsequence_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIsequence_node\fP The RSL sequence node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_sequence_get_list_ref()\fP returns a pointer to the list of the globus_rsl_value_t pointer values contained in the \fIsequence_node\fP parameter\&. If an error occurs, \fBglobus_rsl_value_sequence_get_list_ref()\fP returns NULL\&. 
.RE
.PP

.SS "globus_list_t* globus_rsl_value_sequence_get_value_list (globus_rsl_value_t * sequence_node)"

.PP
Get the value list from an RSL value sequence\&. The \fBglobus_rsl_value_sequence_get_value_list()\fP function returns the list of globus_rsl_value_t pointer values associated with the RSL value sequence pointed to by the \fIsequence_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIsequence_node\fP The RSL sequence node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_sequence_get_value_list()\fP returns a pointer to the list of values pointed to by the \fIsequence_node\fP parameter\&. If the value is not a sequence, \fBglobus_rsl_value_literal_get_string()\fP returns NULL\&. 
.RE
.PP

.SS "char* globus_rsl_value_variable_get_default (globus_rsl_value_t * variable_node)"

.PP
Get the default value of an RSL variable reference\&. The \fBglobus_rsl_value_variable_get_default()\fP function returns a pointer to the default value of the RSL variable pointed to by the \fIvariable_node\fP parameter to use if the variable's name is not bound in the current evaluation context\&.
.PP
\fBParameters:\fP
.RS 4
\fIvariable_node\fP The RSL variable node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_variable_get_default()\fP returns a pointer to the string containing the default value of the variable referenced by the \fIvariable_node\fP parameter\&. If the node is not a variable reference or no default value exists in the RSL node, \fBglobus_rsl_value_variable_get_default()\fP returns NULL\&. 
.RE
.PP

.SS "char* globus_rsl_value_variable_get_name (globus_rsl_value_t * variable_node)"

.PP
Get the name of an RSL variable reference\&. The \fBglobus_rsl_value_variable_get_name()\fP function returns a pointer to the name of the RSL variable name pointed to by the \fIvariable_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIvariable_node\fP The RSL variable node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_variable_get_name()\fP returns a pointer to the string containing the name of the variable referenced by the \fIvariable_node\fP parameter\&. If the node is not a variable reference, \fBglobus_rsl_value_variable_get_sequence()\fP returns NULL\&. 
.RE
.PP

.SS "globus_rsl_value_t* globus_rsl_value_variable_get_sequence (globus_rsl_value_t * variable_node)"

.PP
Get the value sequence from an RSL variable reference\&. The \fBglobus_rsl_value_variable_get_sequence()\fP function returns the sequence value associated with the RSL variable reference pointed to by the \fIvariable_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIvariable_node\fP The RSL variable node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_variable_get_sequence()\fP returns a pointer to the rsl value sequence pointed to by the \fIvariable_node\fP parameter\&. If the value is not a variable reference, \fBglobus_rsl_value_variable_get_sequence()\fP returns NULL\&. 
.RE
.PP

.SS "int globus_rsl_value_variable_get_size (globus_rsl_value_t * variable_node)"

.PP
Get the size of the value list within an RSL variable reference node\&. The \fBglobus_rsl_value_variable_get_size()\fP function returns the number of nodes in the RSL variable reference node pointed to by the \fIvariable_node\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIvariable_node\fP The RSL variable node to inspect\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_variable_get_size()\fP returns the list of values within a RSL variable reference, or -1 if the node pointed to by \fIvariable_node\fP is not a variable reference\&. If the return value is 1, then the variable has no default value included in the reference\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_rsl from the source code\&.