ParamDescrs Class Reference

A ParamDescrs describes a set of parameters. More...

Inheritance diagram for ParamDescrs:

Public Member Functions
void	Validate (Params p)
	validate a set of parameters. More...
Z3_param_kind	GetKind (Symbol name)
	Retrieve kind of parameter. More...
string	GetDocumentation (Symbol name)
	Retrieve documentation of parameter. More...
override string	ToString ()
	Retrieves a string representation of the ParamDescrs. More...
Public Member Functions inherited from Z3Object
void	Dispose ()
	Disposes of the underlying native Z3 object. More...

Properties
Symbol []	Names [get]
	Retrieve all names of parameters. More...
uint	Size [get]
	The size of the ParamDescrs. More...

Detailed Description

A ParamDescrs describes a set of parameters.

Definition at line 29 of file ParamDescrs.cs.

Member Function Documentation

GetDocumentation()

string GetDocumentation ( Symbol  name )

inline

Retrieve documentation of parameter.

Definition at line 52 of file ParamDescrs.cs.

        {
            Contract.Requires(name != null);
            return Native.Z3_param_descrs_get_documentation(Context.nCtx, NativeObject, name.NativeObject);
        }

GetKind()

Z3_param_kind GetKind ( Symbol  name )

inline

Retrieve kind of parameter.

Definition at line 43 of file ParamDescrs.cs.

        {
            Contract.Requires(name != null);
            return (Z3_param_kind)Native.Z3_param_descrs_get_kind(Context.nCtx, NativeObject, name.NativeObject);
        }

ToString()

override string ToString ( )

inline

Retrieves a string representation of the ParamDescrs.

Definition at line 85 of file ParamDescrs.cs.

        {
            return Native.Z3_param_descrs_to_string(Context.nCtx, NativeObject); 
        }

Validate()

void Validate ( Params  p )

inline

validate a set of parameters.

Definition at line 34 of file ParamDescrs.cs.

        {
            Contract.Requires(p != null);
            Native.Z3_params_validate(Context.nCtx, p.NativeObject, NativeObject);
        }

Property Documentation

Names

Symbol [] Names

get

Retrieve all names of parameters.

Definition at line 62 of file ParamDescrs.cs.

        {
            get 
            {
                  uint sz = Native.Z3_param_descrs_size(Context.nCtx, NativeObject);
                  Symbol[] names = new Symbol[sz];
                  for (uint i = 0; i < sz; ++i) {
                      names[i] = Symbol.Create(Context, Native.Z3_param_descrs_get_name(Context.nCtx, NativeObject, i));
                  }
                  return names;
            }
        }

Size

uint Size

get

The size of the ParamDescrs.

Definition at line 78 of file ParamDescrs.cs.

        {
            get { return Native.Z3_param_descrs_size(Context.nCtx, NativeObject); }
        }