Class SBCClassCallableMember

ClassList > SBCClassCallableMember

Inherited by the following classes: SBCClassConstructor, SBCClassFunction

Public Functions

Type	Name
const SBCClassCallableMemberDoc *	getDoc () noexcept const Returns a pointer to its doc object; may be nullptr.
virtual unsigned int	getNumberOfParameters () noexcept const = 0 Returns the number of parameters of the callable member.
virtual SBValue	getParameterType (int i) const = 0 Returns the parameter type of the callable member parameter i .
virtual std::string	getParameterTypeName (int i) const = 0 Returns the parameter type name of the callable member parameter i .
virtual std::string	signature (bool addArgumentNames=false) const = 0 Returns the signature of the callable member; if addArgumentNames istrue then also adds names of arguments.

Protected Attributes

Type	Name
std::unique_ptr< SBCClassCallableMemberDoc >	doc Stores the function docs.

Protected Functions

Type	Name
	SBCClassCallableMember () noexcept Constructs a class callable member.
	SBCClassCallableMember (const SBCClassCallableMemberDoc::Spec & spec) Constructs a class callable member with the given doc.specs.
void	applyDocs (const SBCClassCallableMemberDoc::Spec & spec) Applies documentation specifications to the callable member.
virtual	~SBCClassCallableMember () Destructs the callable member.

Public Functions Documentation

function getDoc

Returns a pointer to its doc object; may be nullptr.

const SBCClassCallableMemberDoc * SBCClassCallableMember::getDoc () noexcept const

Returns a pointer to the documentation object for the callable member.

Returns:

Pointer to SBCClassCallableMemberDoc; may be nullptr.

---

function getNumberOfParameters

Returns the number of parameters of the callable member.

virtual unsigned int SBCClassCallableMember::getNumberOfParameters () noexcept const = 0

---

function getParameterType

Returns the parameter type of the callable member parameter i .

virtual SBValue SBCClassCallableMember::getParameterType (
    int i
) const = 0

---

function getParameterTypeName

Returns the parameter type name of the callable member parameter i .

virtual std::string SBCClassCallableMember::getParameterTypeName (
    int i
) const = 0

---

function signature

Returns the signature of the callable member; if addArgumentNames istrue then also adds names of arguments.

virtual std::string SBCClassCallableMember::signature (
    bool addArgumentNames=false
) const = 0

---

Protected Attributes Documentation

variable doc

Stores the function docs.

std::unique_ptr<SBCClassCallableMemberDoc> SBCClassCallableMember::doc;

---

Protected Functions Documentation

function SBCClassCallableMember [1/2]

Constructs a class callable member.

SBCClassCallableMember::SBCClassCallableMember () noexcept

Default constructs a callable member.

---

function SBCClassCallableMember [2/2]

Constructs a class callable member with the given doc.specs.

SBCClassCallableMember::SBCClassCallableMember (
    const SBCClassCallableMemberDoc::Spec & spec
) 

Constructs a callable member with the given documentation specifications.

Parameters:

• spec Documentation specifications to apply to the member.

---

function applyDocs

Applies documentation specifications to the callable member.

void SBCClassCallableMember::applyDocs (
    const SBCClassCallableMemberDoc::Spec & spec
) 

Updates the member's documentation according to the supplied specification, creating a documentation object if none exists.

Parameters:

• spec Documentation specifications to apply.

---

function ~SBCClassCallableMember

Destructs the callable member.

virtual SBCClassCallableMember::~SBCClassCallableMember () 

Destroys the callable member.

---