.. _keywordsDoc:

.. index:: single: Keywords

========
Keywords
========

* and_
* as_
* from_
* import_
* in_
* off_
* on_
* or_
* out_
* none_
* not_
* streamDomain_
* streamRate_
* use_
* version_
* with_

----

and
===

See :ref:`logical and <And>`

----

.. index:: single: Keywords; as
.. index:: single: as
.. _as:

as
==

``as`` is used to import a namespace with an alias.

::

	import Filters as flt

	AudioIn[1] 
	>> flt.Butteworth ( 
		type:	'LowPass'
		order:	4
		cutoff:	500.
	)
	>> AudioOut;

----

.. index:: single: Keywords; from
.. index:: single: from
.. _from:

from
====

``from`` is used to get a ``value`` from a ``dictionary`` using the ``key`` or the ``key`` using the ``value``.

::

	dictionary Multiplexer (
		key:	[ 'One', 'Two', 'Three' ]
		value:	[ 1, 2, 3 ]
	)

	[ SignalOne, SignalTwo, SignalThree ] 
	>> GetPort ( index: 'Two' from Multiplexer )
	>> Output;

::

	dictionary Multiplexer (
		key:	[ 'Sine', 'Saw', 'Square' ]
		value:	[ 1, 2, 3 ]
	)

	Oscillator (
		type : 2 from Multiplexer
	)
	>> Output;

----

.. index:: single: Keywords; import
.. index:: single: import
.. _import:

import
======

``import``

::

	import Filters

	AudioIn[1] 
	>> Butteworth ( 
		type:	'LowPass'
		order:	4
		cutoff:	500.
	)
	>> AudioOut;

----

.. index:: single: Keywords; in
.. index:: single: in
.. _in:

in
==

``in`` specifies a port direction. It is passed to the ``propertDirection`` port when declaring a ``module``. It sets the port as an :ref:`input port <InputPort>`.

----

off
===

See :ref:`Boolean off <Off>`

----

on
==

See :ref:`Boolean  on <On>`

``on`` is also used to specify the targetted hardware.

::

	use PLATFORM version 1.2 on HARDWARE version 1.0

----

or
==

Logical :ref:`or <Or>`

----

.. index:: single: Keywords; out
.. index:: single: out
.. _Out:

out
===

``out`` specifies a port direction. It is passed to the ``propertDirection`` port when declaring a ``module``. It sets the port as an :ref:`output port <OutputPort>`.

----

.. index:: single: Keywords; none
.. index:: single: none
.. _None:

none
====

If a certain property needs to be left unassigned during deceleration the ``none`` keyword is assigned to it. Not all properties can be assigned ``none``. Consult the documentation of a block for more details.

----

not
===

Logical :ref:`not <Not>`

----

.. index:: single: Keywords; streamDomain
.. index:: single: streamDomain
.. _StreamDomain:

streamDomain
============

``streamDomain`` is the domain of the output port of a module.

----

.. index:: single: Keywords; streamRate
.. index:: single: streamRate
.. _StreamRate:

streamRate
==========

``streamRate`` is the rate of the output port of a module.

----

.. index:: single: Keywords; use
.. index:: single: use
.. _use:

use
===

``use`` loads a platform.

::

	use PLATFORM version 1.2 on HARDWARE version 1.0

----

.. index:: single: Keywords; version
.. index:: single: version
.. _version:

version
=======

``version`` loads a particular version of a platform or specifies the version of the hardware.

::

	use PLATFORM version 1.2 on HARDWARE version 1.0

----

.. index:: single: Keywords; with
.. index:: single: with
.. _with:

with
====

``with`` is used to specify a configuration file for the hardware.

::

	use PLATFORM version 1.2 on HARDWARE version 1.0 with CONF_48KHz