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:

Collaboration diagram for circt::firrtl::PortAnnoTarget:

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.
void	setAnnotations (AnnotationSet annotations) const
	Set the annotations associated with the target.
FModuleLike	getModule () const
	Get the parent module of the target.
Attribute	getNLAReference (hw::InnerSymbolNamespace &moduleNamespace) const
	Get a reference to this target suitable for use in an NLA.
FIRRTLType	getType () const
	Get the type of the target.
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 420 of file FIRRTLAnnotations.h.

Constructor & Destructor Documentation

PortAnnoTarget() [1/2]

PortAnnoTarget::PortAnnoTarget	(	FModuleLike	op,
		unsigned	portNo
	)

Definition at line 516 of file FIRRTLAnnotations.cpp.

PortAnnoTarget() [2/2]

PortAnnoTarget::PortAnnoTarget	(	MemOp	op,
		unsigned	portNo
	)

Definition at line 519 of file FIRRTLAnnotations.cpp.

Member Function Documentation

AnnoTarget()

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

inline

Definition at line 372 of file FIRRTLAnnotations.h.

classof()

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

inlinestatic

Definition at line 434 of file FIRRTLAnnotations.h.

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

getAnnotations()

AnnotationSet PortAnnoTarget::getAnnotations

(

)

const

Definition at line 522 of file FIRRTLAnnotations.cpp.

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

getNLAReference()

Attribute PortAnnoTarget::getNLAReference

(

hw::InnerSymbolNamespace &

moduleNamespace

)

const

Definition at line 540 of file FIRRTLAnnotations.cpp.

getPortNo()

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

inline

Definition at line 426 of file FIRRTLAnnotations.h.

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

Referenced by getAnnotations(), getType(), circt::firrtl::operator<<(), and setAnnotations().

getType()

FIRRTLType PortAnnoTarget::getType

(

)

const

Definition at line 551 of file FIRRTLAnnotations.cpp.

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

Referenced by getType().

setAnnotations()

void PortAnnoTarget::setAnnotations

(

AnnotationSet

annotations

)

const

Definition at line 531 of file FIRRTLAnnotations.cpp.

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

setPortNo()

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

inline

Definition at line 427 of file FIRRTLAnnotations.h.

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

---

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