TwiceAsNice  2019-02-18
Public Member Functions | Public Attributes | Private Member Functions | List of all members
indiclient._indinameconventions Class Reference
Inheritance diagram for indiclient._indinameconventions:
Inheritance graph
Collaboration diagram for indiclient._indinameconventions:
Collaboration graph

Public Member Functions

def __init__ (self)
 

Public Attributes

 basenames
 

Private Member Functions

def _get_defelementtag (self, basename)
 
def _get_defvectortag (self, basename)
 
def _get_setelementtag (self, basename)
 
def _get_setvectortag (self, basename)
 
def _get_newelementtag (self, basename)
 
def _get_newvectortag (self, basename)
 
def _get_message_tag (self)
 
def _get_vector_repr (self, basename)
 
def _get_element_repr (self, basename)
 

Detailed Description

The INDI naming scheme.
@ivar basenames : The possible "Basenames" of an L{indiobject} ["Text","Switch","Number","BLOB","Light"]
@type basenames : list of StringType

Constructor & Destructor Documentation

◆ __init__()

def indiclient._indinameconventions.__init__ (   self)

Member Function Documentation

◆ _get_defelementtag()

def indiclient._indinameconventions._get_defelementtag (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  xml tag of an element that is send by the server when an C{IDDef*} function is called
on vector which contains the element (like C{defText}).
@rtype: StringType

◆ _get_defvectortag()

def indiclient._indinameconventions._get_defvectortag (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  xml tag of a vector that is send by the server when an C{IDDef*} function is called(like C{defTextVector}).
@rtype: StringType

◆ _get_element_repr()

def indiclient._indinameconventions._get_element_repr (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  printable representation of the type of the element .
@rtype: StringType 

◆ _get_message_tag()

def indiclient._indinameconventions._get_message_tag (   self)
private
@return:  xml tag of an INDI message.
@rtype: StringType

◆ _get_newelementtag()

def indiclient._indinameconventions._get_newelementtag (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  xml tag of an element that is send by the client (like C{oneText}).
@rtype: StringType

◆ _get_newvectortag()

def indiclient._indinameconventions._get_newvectortag (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  xml tag of a vector that is send by the client (like C{newTextVector}).
@rtype: StringType

◆ _get_setelementtag()

def indiclient._indinameconventions._get_setelementtag (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:        xml tag of an element that is send by the server when an C{IDSet*} function is called
on vector which contains the element (like C{oneText}).
@rtype: StringType

◆ _get_setvectortag()

def indiclient._indinameconventions._get_setvectortag (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  xml tag of a vector that is send by the server when am C{IDSet*} function is called (like C{setTextVector}).
@rtype: StringType

◆ _get_vector_repr()

def indiclient._indinameconventions._get_vector_repr (   self,
  basename 
)
private
@param basename : The basename of the tag see (L{basenames})
@type basename : StringType
@return:  printable representation of the type of the vector .
@rtype: StringType 

Member Data Documentation

◆ basenames

indiclient._indinameconventions.basenames

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