CIRCT  20.0.0git
Public Member Functions | Public Attributes | List of all members
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:
Collaboration graph
[legend]

Public Member Functions

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

Public Attributes

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

Detailed Description

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

Definition at line 169 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 184 of file GrandCentral.cpp.

References assert(), llvm::yaml::stripComment(), 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 226 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 229 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 174 of file GrandCentral.cpp.

◆ dimensions

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

The dimensions of the field.

Definition at line 177 of file GrandCentral.cpp.

◆ name

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

The name of the field.

Definition at line 171 of file GrandCentral.cpp.

◆ width

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

The width of the underlying type.

Definition at line 180 of file GrandCentral.cpp.


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