FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add function BASE:IsInstanceOf( className )

Browse Source 
This method checks if a Moose object is an instance of a given className.
This commit is contained in:
132nd-etcher 2017-07-12 14:55:25 +02:00
parent 82fd08521f
commit 9fe51587a1
No known key found for this signature in database
GPG Key ID: 9EEA375B639C20FE
2 changed files with 113 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
Moose Development/Moose/Core/Base.lua
View File

@ -287,6 +287,63 @@ function BASE:GetParent( Child )
return Parent
end
--- This is the worker method to check if an object is an (sub)instance of a class.
--
-- ### Examples:
--
-- * ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
-- * ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
-- * ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
-- * ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
--
-- * ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
--
-- @param ClassName is the name of the class or the class itself to run the check against
-- @return #boolean
function BASE:IsInstanceOf( className )
-- Is className NOT a string ?
if type( className ) ~= 'string' then
-- Is className a Moose class ?
if type( className ) == 'table' and className.ClassName ~= nil then
-- Get the name of the Moose class as a string
className = className.ClassName
-- className is neither a string nor a Moose class, throw an error
else
-- I'm not sure if this should take advantage of MOOSE logging function, or throw an error for pcall
local err_str = 'className parameter should be a string; parameter received: '..type( className )
self:E( err_str )
-- error( err_str )
return false
end
end
className = string.upper( className )
if string.upper( self.ClassName ) == className then
return true
end
local Parent = self:GetParent(self)
while Parent do
if string.upper( Parent.ClassName ) == className then
return true
end
Parent = Parent:GetParent(Parent)
end
return false
end
--- Get the ClassName + ClassID of the class instance.
-- The ClassName + ClassID is formatted as '%s#%09d'.
-- @param #BASE self

56
docs/Documentation/Base.html
View File

@ -257,6 +257,12 @@
<td class="name" nowrap="nowrap"><a href="##(BASE).Inherit">BASE:Inherit(Child, Parent)</a></td>
<td class="summary">
<p>This is the worker method to inherit from a parent class.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(BASE).IsInstanceOf">BASE.IsInstanceOf(ClassName, self, className)</a></td>
<td class="summary">
<p>This is the worker method to check if an object is an (sub)instance of a class.</p>
</td>
</tr>
<tr>
@ -1220,6 +1226,56 @@ is the Parent class that the Child inherits from.</p>
<p><em><a href="##(BASE)">#BASE</a>:</em>
Child</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(BASE).IsInstanceOf" >
<strong>BASE.IsInstanceOf(ClassName, self, className)</strong>
</a>
</dt>
<dd>
<p>This is the worker method to check if an object is an (sub)instance of a class.</p>
<h3>Examples:</h3>
<ul>
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true</p></li>
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true</p></li>
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true</p></li>
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true</p></li>
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false</p></li>
</ul>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> ClassName </em></code>:
is the name of the class or the class itself to run the check against</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> className </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">