object CliOption extends Serializable
- Source
- HasCliOptions.scala
- Alphabetic
- By Inheritance
- CliOption
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def double(name: String, help: String): CliOption[Double]
Add a double option to a test.
Add a double option to a test.
- name
the name of the option
- help
help text to show to tell the user how to use this option
- Exceptions thrown
IllegalArgumentExceptionif the value is not convertible to a double precision floating point number
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def flag(name: String, help: String): CliOption[Unit]
Add a flag option to a test.
Add a flag option to a test.
This is an option which can only take one of two "truthy" values:
1ortrue. Any "falsey" values are not allowed. This option is a stand-in for any option which is supposed to be a flag to a test which has some effect if set.This option exists because Scalatest forces options to have a value. It is illegal to pass an option like
-Dfoo. This flag option exists to problem a single flag-style option as opposed to having users roll their own.- name
the name of the option
- help
help text to show to tell the user how to use this option
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def int(name: String, help: String): CliOption[Int]
Add an integer option to a test.
Add an integer option to a test.
- name
the name of the option
- help
help text to show to tell the user how to use this option
- Exceptions thrown
IllegalArgumentExceptionif the value is not convertible to an integer
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def simple[A](name: String, help: String, convert: (String) => A): CliOption[A]
A simple command line option which does not affect common or backend settings.
A simple command line option which does not affect common or backend settings.
This is intended to be used to create options which are passed directly to tests as opposed to creating options which are used to affect compilation or simulation settings.
- name
the name of the option
- help
help text to show to tell the user how to use this option
- convert
convert the
<value>to typeA
- def string(name: String, help: String): CliOption[String]
Add a string option to a test.
Add a string option to a test.
- name
the name of the option
- help
help text to show to tell the user how to use this option
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt,SInt,Bool,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.