circt::firrtl::AnnoTarget Struct Reference

An annotation target is used to keep track of something that is targeted by an Annotation. More...

#include <FIRRTLAnnotations.h>

Inheritance diagram for circt::firrtl::AnnoTarget:

Collaboration diagram for circt::firrtl::AnnoTarget:

Public Member Functions
	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

Protected Attributes
detail::AnnoTargetImpl	impl

Detailed Description

An annotation target is used to keep track of something that is targeted by an Annotation.

Definition at line 383 of file FIRRTLAnnotations.h.

Constructor & Destructor Documentation

AnnoTarget()

circt::firrtl::AnnoTarget::AnnoTarget ( detail::AnnoTargetImpl  impl = nullptr )

inline

Definition at line 384 of file FIRRTLAnnotations.h.

Member Function Documentation

getAnnotations()

AnnotationSet AnnoTarget::getAnnotations

(

)

const

Get the annotations associated with the target.

Definition at line 474 of file FIRRTLAnnotations.cpp.

References getOp().

Referenced by Deduper::recordAnnotations().

getImpl()

detail::AnnoTargetImpl circt::firrtl::AnnoTarget::getImpl ( ) const

inline

Definition at line 408 of file FIRRTLAnnotations.h.

References impl.

Referenced by circt::firrtl::OpAnnoTarget::classof(), circt::firrtl::PortAnnoTarget::classof(), llvm::DenseMapInfo< circt::firrtl::AnnoTarget >::getHashValue(), getOp(), circt::firrtl::PortAnnoTarget::getPortNo(), setOp(), and circt::firrtl::PortAnnoTarget::setPortNo().

getModule()

FModuleLike AnnoTarget::getModule

(

)

const

Get the parent module of the target.

Definition at line 467 of file FIRRTLAnnotations.cpp.

References getOp().

Referenced by buildNLA(), ResolveTracesPass::buildTarget(), and circt::firrtl::operator<<().

getNLAReference()

Attribute AnnoTarget::getNLAReference

(

hw::InnerSymbolNamespace &

moduleNamespace

)

const

Get a reference to this target suitable for use in an NLA.

Definition at line 487 of file FIRRTLAnnotations.cpp.

getOp()

Operation* circt::firrtl::AnnoTarget::getOp ( ) const

inline

Definition at line 390 of file FIRRTLAnnotations.h.

References getImpl(), and circt::firrtl::detail::AnnoTargetImpl::getOp().

Referenced by addAnnotation(), applyAttributeAnnotation(), applyConventionAnno(), applyDUTAnno(), applyLoadMemoryAnno(), applyOutputDirAnno(), circt::firrtl::applyWiring(), circt::firrtl::applyWithoutTargetImpl(), ResolveTracesPass::buildTarget(), findFieldID(), getAnnotations(), circt::firrtl::OpAnnoTarget::getAnnotations(), circt::firrtl::PortAnnoTarget::getAnnotations(), getModule(), circt::firrtl::OpAnnoTarget::getNLAReference(), circt::firrtl::PortAnnoTarget::getNLAReference(), circt::firrtl::OpAnnoTarget::getType(), circt::firrtl::PortAnnoTarget::getType(), lowerInternalPathAnno(), circt::firrtl::operator<<(), circt::firrtl::resolveEntities(), circt::firrtl::OpAnnoTarget::setAnnotations(), circt::firrtl::PortAnnoTarget::setAnnotations(), and updateExpandedPort().

getType()

FIRRTLType AnnoTarget::getType

(

)

const

Get the type of the target.

Definition at line 494 of file FIRRTLAnnotations.cpp.

Referenced by ResolveTracesPass::buildTarget(), findFieldID(), circt::firrtl::operator<<(), and circt::firrtl::resolveEntities().

operator bool()

circt::firrtl::AnnoTarget::operator bool ( ) const

inline

Definition at line 386 of file FIRRTLAnnotations.h.

References impl.

operator!=()

bool circt::firrtl::AnnoTarget::operator!= ( const AnnoTarget &  other ) const

inline

Definition at line 388 of file FIRRTLAnnotations.h.

operator==()

bool circt::firrtl::AnnoTarget::operator== ( const AnnoTarget &  other ) const

inline

Definition at line 387 of file FIRRTLAnnotations.h.

References impl.

setAnnotations()

void AnnoTarget::setAnnotations

(

AnnotationSet

annotations

)

const

Set the annotations associated with the target.

Definition at line 481 of file FIRRTLAnnotations.cpp.

Referenced by Deduper::mergeAnnotations().

setOp()

void circt::firrtl::AnnoTarget::setOp ( Operation *  op )

inline

Definition at line 391 of file FIRRTLAnnotations.h.

References getImpl(), and circt::firrtl::detail::AnnoTargetImpl::setOp().

Member Data Documentation

impl

detail::AnnoTargetImpl circt::firrtl::AnnoTarget::impl

protected

Definition at line 411 of file FIRRTLAnnotations.h.

Referenced by getImpl(), operator bool(), and operator==().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/FIRRTL/FIRRTLAnnotations.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/FIRRTL/FIRRTLAnnotations.cpp