Public Member Functions | Public Attributes | List of all members
roslint.cpplint._ClassInfo Class Reference
Inheritance diagram for roslint.cpplint._ClassInfo:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, name, class_or_struct, clean_lines, linenum)
 
def CheckBegin (self, filename, clean_lines, linenum, error)
 
def CheckEnd (self, filename, clean_lines, linenum, error)
 
- Public Member Functions inherited from roslint.cpplint._BlockInfo
def __init__ (self, linenum, seen_open_brace)
 
def IsBlockInfo (self)
 

Public Attributes

 access
 
 check_namespace_indentation
 
 class_indent
 
 is_derived
 
 is_struct
 
 last_line
 
 name
 
- Public Attributes inherited from roslint.cpplint._BlockInfo
 check_namespace_indentation
 
 inline_asm
 
 open_parentheses
 
 seen_open_brace
 
 starting_linenum
 

Detailed Description

Stores information about a class.

Definition at line 2265 of file cpplint.py.

Constructor & Destructor Documentation

◆ __init__()

def roslint.cpplint._ClassInfo.__init__ (   self,
  name,
  class_or_struct,
  clean_lines,
  linenum 
)

Definition at line 2268 of file cpplint.py.

Member Function Documentation

◆ CheckBegin()

def roslint.cpplint._ClassInfo.CheckBegin (   self,
  filename,
  clean_lines,
  linenum,
  error 
)
Run checks that applies to text up to the opening brace.

This is mostly for checking the text after the class identifier
and the "{", usually where the base class is specified.  For other
blocks, there isn't much to check, so we always pass.

Args:
  filename: The name of the current file.
  clean_lines: A CleansedLines instance containing the file.
  linenum: The number of the line to check.
  error: The function to call with any errors found.

Reimplemented from roslint.cpplint._BlockInfo.

Definition at line 2298 of file cpplint.py.

◆ CheckEnd()

def roslint.cpplint._ClassInfo.CheckEnd (   self,
  filename,
  clean_lines,
  linenum,
  error 
)
Run checks that applies to text after the closing brace.

This is mostly used for checking end of namespace comments.

Args:
  filename: The name of the current file.
  clean_lines: A CleansedLines instance containing the file.
  linenum: The number of the line to check.
  error: The function to call with any errors found.

Reimplemented from roslint.cpplint._BlockInfo.

Definition at line 2303 of file cpplint.py.

Member Data Documentation

◆ access

roslint.cpplint._ClassInfo.access

Definition at line 2274 of file cpplint.py.

◆ check_namespace_indentation

roslint.cpplint._ClassInfo.check_namespace_indentation

Definition at line 2272 of file cpplint.py.

◆ class_indent

roslint.cpplint._ClassInfo.class_indent

Definition at line 2282 of file cpplint.py.

◆ is_derived

roslint.cpplint._ClassInfo.is_derived

Definition at line 2271 of file cpplint.py.

◆ is_struct

roslint.cpplint._ClassInfo.is_struct

Definition at line 2275 of file cpplint.py.

◆ last_line

roslint.cpplint._ClassInfo.last_line

Definition at line 2289 of file cpplint.py.

◆ name

roslint.cpplint._ClassInfo.name

Definition at line 2270 of file cpplint.py.


The documentation for this class was generated from the following file:


roslint
Author(s): Mike Purvis, Jack O'Quin
autogenerated on Tue Mar 7 2023 03:27:03