Alma/ACSLogTS
element LogDefinition

Documentation

This element contains all the information for the code generation of the type safe logs, plus information for documentation purposes. Each LogDefinition will become a new class, with a standardized interface in all three languages supported by ACS(C++, Java and Python).

CPP API:
	SampleLog mylog(__FILE__, __LINE__, "routine")
	mylog.setSomeMember("value") //sets member SomeMember="value" 
	mylog.log()

Java API:
	SampleLog mylog = new SampleLog(mylogger);
	mylog.setSomeMember("value"); //sets member SomeMember="value" 
	mylog.log();

Python API:
	mylog = SampleLog() #filename, line number and function can be extracted at runtime
	mylog.setSomeMember("value") #sets member SomeMember="value" 
	mylog.log()

						

Properties

This component is not nillable.

Model

<LogDefinition
  audience = common:nonEmptyString
  description = common:nonEmptyString
  logName = common:nameType
  priority = loggingts:priorityType
  shortDescription = common:shortDescriptionString
  URL = xs:string>
Member*
</LogDefinition>

audience

Type:

common:nonEmptyString

Use:

required

Form:

unqualified

description

Type:

common:nonEmptyString

Use:

required

Form:

unqualified

logName

Type:

common:nameType

Use:

required

Form:

unqualified

priority

Type:

loggingts:priorityType

Use:

required

Form:

unqualified

shortDescription

Type:

common:shortDescriptionString

Use:

required

Form:

unqualified

URL

Type:

xs:string

Use:

optional

Form:

unqualified

Source

<xs:element maxOccurs="unbounded" name="LogDefinition">
  <xs:complexType>
    <xs:choice maxOccurs="unbounded" minOccurs="0">
      <xs:element name="Member" type="common:Member_"/>
    </xs:choice>
    <xs:attribute name="logName" type="common:nameType" use="required"/>
    <xs:attribute name="shortDescription" type="common:shortDescriptionString" use="required"/>
    <xs:attribute name="description" type="common:nonEmptyString" use="required"/>
    <xs:attribute name="URL" type="xs:string" use="optional"/>
    <xs:attribute name="priority" type="loggingts:priorityType" use="required"/>
    <xs:attribute name="audience" type="common:nonEmptyString" use="required"/>
  </xs:complexType>
</xs:element>