llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field Struct Reference

A one-to-one representation with a YAML representation of a signal/field. More...

Collaboration diagram for llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field:

Public Member Functions
	Field (IO &io, DescribedSignal &op)
	Construct a Field from a DescribedSignal (an sv::InterfaceSignalOp with an optional description).
	Field (IO &io)
	A no-argument constructor is necessary to work with LLVM's YAML library.
DescribedSignal	denormalize (IO &)
	This cannot be denormalized back to an interface op.

Public Attributes
StringRef	name
	The name of the field.
std::optional< std::string >	description
	An optional, textual description of what the field is.
SmallVector< unsigned, 2 >	dimensions
	The dimensions of the field.
unsigned	width
	The width of the underlying type.

Detailed Description

A one-to-one representation with a YAML representation of a signal/field.

Definition at line 170 of file GrandCentral.cpp.

Constructor & Destructor Documentation

Field() [1/2]

llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::Field ( IO & io, DescribedSignal & op )

inline

Construct a Field from a DescribedSignal (an sv::InterfaceSignalOp with an optional description).

Definition at line 185 of file GrandCentral.cpp.

References assert(), description, dimensions, name, llvm::yaml::stripComment(), circt::firrtl::type_cast(), and width.

Field() [2/2]

llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::Field ( IO & io )

inline

A no-argument constructor is necessary to work with LLVM's YAML library.

Definition at line 227 of file GrandCentral.cpp.

Member Function Documentation

denormalize()

DescribedSignal llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::denormalize ( IO & )

inline

This cannot be denormalized back to an interface op.

Definition at line 230 of file GrandCentral.cpp.

Member Data Documentation

description

std::optional<std::string> llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::description

An optional, textual description of what the field is.

Definition at line 175 of file GrandCentral.cpp.

Referenced by Field().

dimensions

SmallVector<unsigned, 2> llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::dimensions

The dimensions of the field.

Definition at line 178 of file GrandCentral.cpp.

Referenced by Field().

name

StringRef llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::name

The name of the field.

Definition at line 172 of file GrandCentral.cpp.

Referenced by Field().

width

unsigned llvm::yaml::MappingContextTraits< DescribedSignal, Context >::Field::width

The width of the underlying type.

Definition at line 181 of file GrandCentral.cpp.

Referenced by Field().

---

The documentation for this struct was generated from the following file:

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/FIRRTL/Transforms/GrandCentral.cpp