CIRCT  19.0.0git
Public Member Functions | Static Public Member Functions | List of all members
circt::firrtl::PortAnnoTarget Struct Reference

This represents an annotation targeting a specific port of a module, memory, or instance. More...

#include <FIRRTLAnnotations.h>

Inheritance diagram for circt::firrtl::PortAnnoTarget:
Inheritance graph
[legend]
Collaboration diagram for circt::firrtl::PortAnnoTarget:
Collaboration graph
[legend]

Public Member Functions

 PortAnnoTarget (FModuleLike op, unsigned portNo)
 
 PortAnnoTarget (MemOp op, unsigned portNo)
 
unsigned getPortNo () const
 
void setPortNo (unsigned portNo)
 
AnnotationSet getAnnotations () const
 
void setAnnotations (AnnotationSet annotations) const
 
Attribute getNLAReference (hw::InnerSymbolNamespace &moduleNamespace) const
 
FIRRTLType getType () const
 
 AnnoTarget (detail::AnnoTargetImpl impl=nullptr)
 
- Public Member Functions inherited from circt::firrtl::AnnoTarget
 AnnoTarget (detail::AnnoTargetImpl impl=nullptr)
 
 operator bool () const
 
bool operator== (const AnnoTarget &other) const
 
bool operator!= (const AnnoTarget &other) const
 
Operation * getOp () const
 
void setOp (Operation *op)
 
AnnotationSet getAnnotations () const
 Get the annotations associated with the target. More...
 
void setAnnotations (AnnotationSet annotations) const
 Set the annotations associated with the target. More...
 
FModuleLike getModule () const
 Get the parent module of the target. More...
 
Attribute getNLAReference (hw::InnerSymbolNamespace &moduleNamespace) const
 Get a reference to this target suitable for use in an NLA. More...
 
FIRRTLType getType () const
 Get the type of the target. More...
 
detail::AnnoTargetImpl getImpl () const
 

Static Public Member Functions

static bool classof (const AnnoTarget &annoTarget)
 

Additional Inherited Members

- Protected Attributes inherited from circt::firrtl::AnnoTarget
detail::AnnoTargetImpl impl
 

Detailed Description

This represents an annotation targeting a specific port of a module, memory, or instance.

Definition at line 464 of file FIRRTLAnnotations.h.

Constructor & Destructor Documentation

◆ PortAnnoTarget() [1/2]

PortAnnoTarget::PortAnnoTarget ( FModuleLike  op,
unsigned  portNo 
)

Definition at line 631 of file FIRRTLAnnotations.cpp.

◆ PortAnnoTarget() [2/2]

PortAnnoTarget::PortAnnoTarget ( MemOp  op,
unsigned  portNo 
)

Definition at line 634 of file FIRRTLAnnotations.cpp.

Member Function Documentation

◆ AnnoTarget()

circt::firrtl::AnnoTarget::AnnoTarget
inline

Definition at line 416 of file FIRRTLAnnotations.h.

◆ classof()

static bool circt::firrtl::PortAnnoTarget::classof ( const AnnoTarget annoTarget)
inlinestatic

◆ getAnnotations()

AnnotationSet PortAnnoTarget::getAnnotations ( ) const

◆ getNLAReference()

Attribute PortAnnoTarget::getNLAReference ( hw::InnerSymbolNamespace moduleNamespace) const

◆ getPortNo()

unsigned circt::firrtl::PortAnnoTarget::getPortNo ( ) const
inline

◆ getType()

FIRRTLType PortAnnoTarget::getType ( ) const

Definition at line 666 of file FIRRTLAnnotations.cpp.

References circt::firrtl::AnnoTarget::getOp(), and getPortNo().

◆ setAnnotations()

void PortAnnoTarget::setAnnotations ( AnnotationSet  annotations) const

◆ setPortNo()

void circt::firrtl::PortAnnoTarget::setPortNo ( unsigned  portNo)
inline

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